man/coredump.conf.xml

   1 <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <!--
   6   SPDX-License-Identifier: LGPL-2.1+
   7
   8   This file is part of systemd.
   9
  10   Copyright 2014 Zbigniew Jędrzejewski-Szmek
  11
  12   systemd is free software; you can redistribute it and/or modify it
  13   under the terms of the GNU Lesser General Public License as published by
  14   the Free Software Foundation; either version 2.1 of the License, or
  15   (at your option) any later version.
  16
  17   systemd is distributed in the hope that it will be useful, but
  18   WITHOUT ANY WARRANTY; without even the implied warranty of
  19   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  20   Lesser General Public License for more details.
  21
  22   You should have received a copy of the GNU Lesser General Public License
  23   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  24 -->
  25
  26 <refentry id="coredump.conf" conditional="ENABLE_COREDUMP"
  27           xmlns:xi="http://www.w3.org/2001/XInclude">
  28   <refentryinfo>
  29     <title>coredump.conf</title>
  30     <productname>systemd</productname>
  31
  32     <authorgroup>
  33       <author>
  34         <contrib>Developer</contrib>
  35         <firstname>Lennart</firstname>
  36         <surname>Poettering</surname>
  37         <email>lennart@poettering.net</email>
  38       </author>
  39     </authorgroup>
  40   </refentryinfo>
  41
  42   <refmeta>
  43     <refentrytitle>coredump.conf</refentrytitle>
  44     <manvolnum>5</manvolnum>
  45   </refmeta>
  46
  47   <refnamediv>
  48     <refname>coredump.conf</refname>
  49     <refname>coredump.conf.d</refname>
  50     <refpurpose>Core dump storage configuration files</refpurpose>
  51   </refnamediv>
  52
  53   <refsynopsisdiv>
  54     <para><filename>/etc/systemd/coredump.conf</filename></para>
  55     <para><filename>/etc/systemd/coredump.conf.d/*.conf</filename></para>
  56     <para><filename>/run/systemd/coredump.conf.d/*.conf</filename></para>
  57     <para><filename>/usr/lib/systemd/coredump.conf.d/*.conf</filename></para>
  58   </refsynopsisdiv>
  59
  60   <refsect1>
  61     <title>Description</title>
  62
  63     <para>These files configure the behavior of
  64     <citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  65     a handler for core dumps invoked by the kernel. Whether <command>systemd-coredump</command> is used
  66     is determined by the kernel's
  67     <varname>kernel.core_pattern</varname> <citerefentry project='man-pages'><refentrytitle>sysctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  68     setting. See
  69     <citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  70     and
  71     <citerefentry project='man-pages'><refentrytitle>core</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  72     pages for the details.</para>
  73   </refsect1>
  74
  75   <xi:include href="standard-conf.xml" xpointer="main-conf" />
  76
  77   <refsect1>
  78     <title>Options</title>
  79
  80     <para>All options are configured in the
  81     <literal>[Coredump]</literal> section:</para>
  82
  83     <variablelist>
  84
  85       <varlistentry>
  86         <term><varname>Storage=</varname></term>
  87
  88         <listitem><para>Controls where to store cores. One of <literal>none</literal>,
  89         <literal>external</literal>, and <literal>journal</literal>. When
  90         <literal>none</literal>, the core dumps will be logged (including the backtrace if
  91         possible), but not stored permanently. When <literal>external</literal> (the
  92         default), cores will be stored in <filename>/var/lib/systemd/coredump/</filename>.
  93         When <literal>journal</literal>, cores will be stored in the journal and rotated
  94         following normal journal rotation patterns.</para>
  95
  96         <para>When cores are stored in the journal, they might be
  97         compressed following journal compression settings, see
  98         <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
  99         When cores are stored externally, they will be compressed
 100         by default, see below.</para></listitem>
 101       </varlistentry>
 102
 103       <varlistentry>
 104         <term><varname>Compress=</varname></term>
 105
 106         <listitem><para>Controls compression for external
 107         storage. Takes a boolean argument, which defaults to
 108         <literal>yes</literal>.</para>
 109         </listitem>
 110       </varlistentry>
 111
 112       <varlistentry>
 113         <term><varname>ProcessSizeMax=</varname></term>
 114
 115         <listitem><para>The maximum size in bytes of a core
 116         which will be processed. Core dumps exceeding this size
 117         will be logged, but the backtrace will not be generated
 118         and the core will not be stored.</para></listitem>
 119       </varlistentry>
 120
 121       <varlistentry>
 122         <term><varname>ExternalSizeMax=</varname></term>
 123         <term><varname>JournalSizeMax=</varname></term>
 124
 125         <listitem><para>The maximum (uncompressed) size in bytes of a
 126         core to be saved.</para></listitem>
 127       </varlistentry>
 128
 129       <varlistentry>
 130         <term><varname>MaxUse=</varname></term>
 131         <term><varname>KeepFree=</varname></term>
 132
 133         <listitem><para>Enforce limits on the disk space taken up by
 134         externally stored core dumps. <option>MaxUse=</option> makes
 135         sure that old core dumps are removed as soon as the total disk
 136         space taken up by core dumps grows beyond this limit (defaults
 137         to 10% of the total disk size). <option>KeepFree=</option>
 138         controls how much disk space to keep free at least (defaults
 139         to 15% of the total disk size). Note that the disk space used
 140         by core dumps might temporarily exceed these limits while
 141         core dumps are processed. Note that old core dumps are also
 142         removed based on time via
 143         <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>. Set
 144         either value to 0 to turn off size-based
 145         clean-up.</para></listitem>
 146       </varlistentry>
 147     </variablelist>
 148
 149     <para>The defaults for all values are listed as comments in the
 150     template <filename>/etc/systemd/coredump.conf</filename> file that
 151     is installed by default.</para>
 152   </refsect1>
 153
 154   <refsect1>
 155     <title>See Also</title>
 156     <para>
 157       <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 158       <citerefentry><refentrytitle>coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 159       <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 160     </para>
 161   </refsect1>
 162
 163 </refentry>