man/coredump.conf.xml

   1 <?xml version='1.0'?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
   5
   6 <refentry id="coredump.conf" conditional="ENABLE_COREDUMP"
   7           xmlns:xi="http://www.w3.org/2001/XInclude">
   8   <refentryinfo>
   9     <title>coredump.conf</title>
  10     <productname>systemd</productname>
  11   </refentryinfo>
  12
  13   <refmeta>
  14     <refentrytitle>coredump.conf</refentrytitle>
  15     <manvolnum>5</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>coredump.conf</refname>
  20     <refname>coredump.conf.d</refname>
  21     <refpurpose>Core dump storage configuration files</refpurpose>
  22   </refnamediv>
  23
  24   <refsynopsisdiv>
  25     <para><simplelist>
  26       <member><filename>/etc/systemd/coredump.conf</filename></member>
  27       <member><filename>/etc/systemd/coredump.conf.d/*.conf</filename></member>
  28       <member><filename>/run/systemd/coredump.conf.d/*.conf</filename></member>
  29       <member><filename>/usr/lib/systemd/coredump.conf.d/*.conf</filename></member>
  30     </simplelist></para>
  31   </refsynopsisdiv>
  32
  33   <refsect1>
  34     <title>Description</title>
  35
  36     <para>These files configure the behavior of
  37     <citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  38     a handler for core dumps invoked by the kernel. Whether <command>systemd-coredump</command> is used
  39     is determined by the kernel's
  40     <varname>kernel.core_pattern</varname> <citerefentry project='man-pages'><refentrytitle>sysctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  41     setting. See
  42     <citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  43     and
  44     <citerefentry project='man-pages'><refentrytitle>core</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  45     pages for the details.</para>
  46   </refsect1>
  47
  48   <xi:include href="standard-conf.xml" xpointer="main-conf" />
  49
  50   <refsect1>
  51     <title>Options</title>
  52
  53     <para>All options are configured in the
  54     [Coredump] section:</para>
  55
  56     <variablelist class='config-directives'>
  57
  58       <varlistentry>
  59         <term><varname>Storage=</varname></term>
  60
  61         <listitem><para>Controls where to store cores. One of <literal>none</literal>,
  62         <literal>external</literal>, and <literal>journal</literal>. When <literal>none</literal>, the core
  63         dumps may be logged (including the backtrace if possible), but not stored permanently. When
  64         <literal>external</literal> (the default), cores will be stored in
  65         <filename>/var/lib/systemd/coredump/</filename>.  When <literal>journal</literal>, cores will be
  66         stored in the journal and rotated following normal journal rotation patterns.</para>
  67
  68         <para>When cores are stored in the journal, they might be compressed following journal compression
  69         settings, see
  70         <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
  71         When cores are stored externally, they will be compressed by default, see below.</para>
  72
  73         <para>Note that in order to process a coredump (i.e. extract a stack trace) the core must be written
  74         to disk first. Thus, unless <varname>ProcessSizeMax=</varname> is set to 0 (see below), the core will
  75         be written to <filename>/var/lib/systemd/coredump/</filename> either way (under a temporary filename,
  76         or even in an unlinked file), <varname>Storage=</varname> thus only controls whether to leave it
  77         there even after it was processed.</para>
  78
  79         <xi:include href="version-info.xml" xpointer="v215"/></listitem>
  80       </varlistentry>
  81
  82       <varlistentry>
  83         <term><varname>Compress=</varname></term>
  84
  85         <listitem><para>Controls compression for external
  86         storage. Takes a boolean argument, which defaults to
  87         <literal>yes</literal>.</para>
  88
  89         <xi:include href="version-info.xml" xpointer="v215"/>
  90         </listitem>
  91       </varlistentry>
  92
  93       <varlistentry>
  94         <term><varname>ProcessSizeMax=</varname></term>
  95
  96         <listitem><para>The maximum size in bytes of a core which will be processed. Core dumps exceeding
  97         this size may be stored, but the stack trace will not be generated.  Like other sizes in this same
  98         config file, the usual suffixes to the base of 1024 are allowed (B, K, M, G, T, P, and E). Defaults
  99         to 1G on 32-bit systems, 32G on 64-bit systems.</para>
 100
 101         <para>Setting <varname>Storage=none</varname> and <varname>ProcessSizeMax=0</varname>
 102         disables all coredump handling except for a log entry.</para>
 103
 104         <xi:include href="version-info.xml" xpointer="v215"/>
 105         </listitem>
 106       </varlistentry>
 107
 108       <varlistentry>
 109         <term><varname>ExternalSizeMax=</varname></term>
 110         <term><varname>JournalSizeMax=</varname></term>
 111
 112         <listitem><para>The maximum (compressed or uncompressed) size in bytes of a coredump to be saved in
 113         separate files on disk (default: 1G on 32-bit systems, 32G on 64-bit systems) or in the journal
 114         (default: 767M). Note that the journal service enforces a hard limit on journal log records of 767M,
 115         and will ignore larger submitted log records. Hence, <varname>JournalSizeMax=</varname> may be
 116         lowered relative to the default, but not increased. Unit suffixes are allowed just as in
 117         <option>ProcessSizeMax=</option>.</para>
 118
 119         <para><varname>ExternalSizeMax=infinity</varname> sets the core size to unlimited.</para>
 120
 121         <xi:include href="version-info.xml" xpointer="v215"/></listitem>
 122       </varlistentry>
 123
 124       <varlistentry>
 125         <term><varname>MaxUse=</varname></term>
 126         <term><varname>KeepFree=</varname></term>
 127
 128         <listitem><para>Enforce limits on the disk space, specified
 129         in bytes, taken up by externally stored core dumps.
 130         Unit suffixes are allowed just as in <option>ProcessSizeMax=</option>.
 131         <option>MaxUse=</option> makes
 132         sure that old core dumps are removed as soon as the total disk
 133         space taken up by core dumps grows beyond this limit (defaults
 134         to 10% of the total disk size). <option>KeepFree=</option>
 135         controls how much disk space to keep free at least (defaults
 136         to 15% of the total disk size). Note that the disk space used
 137         by core dumps might temporarily exceed these limits while
 138         core dumps are processed. Note that old core dumps are also
 139         removed based on time via
 140         <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
 141         Set either value to 0 to turn off size-based cleanup.</para>
 142
 143         <xi:include href="version-info.xml" xpointer="v215"/></listitem>
 144       </varlistentry>
 145     </variablelist>
 146
 147     <para>The defaults for all values are listed as comments in the
 148     template <filename>/etc/systemd/coredump.conf</filename> file that
 149     is installed by default.</para>
 150   </refsect1>
 151
 152   <refsect1>
 153     <title>See Also</title>
 154     <para><simplelist type="inline">
 155       <member><citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
 156       <member><citerefentry><refentrytitle>coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
 157       <member><citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
 158     </simplelist></para>
 159   </refsect1>
 160
 161 </refentry>