man/coredump.conf.xml

   1 <?xml version='1.0'?>
   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
   9 <refentry id="coredump.conf" conditional="ENABLE_COREDUMP"
  10           xmlns:xi="http://www.w3.org/2001/XInclude">
  11   <refentryinfo>
  12     <title>coredump.conf</title>
  13     <productname>systemd</productname>
  14   </refentryinfo>
  15
  16   <refmeta>
  17     <refentrytitle>coredump.conf</refentrytitle>
  18     <manvolnum>5</manvolnum>
  19   </refmeta>
  20
  21   <refnamediv>
  22     <refname>coredump.conf</refname>
  23     <refname>coredump.conf.d</refname>
  24     <refpurpose>Core dump storage configuration files</refpurpose>
  25   </refnamediv>
  26
  27   <refsynopsisdiv>
  28     <para><filename>/etc/systemd/coredump.conf</filename></para>
  29     <para><filename>/etc/systemd/coredump.conf.d/*.conf</filename></para>
  30     <para><filename>/run/systemd/coredump.conf.d/*.conf</filename></para>
  31     <para><filename>/usr/lib/systemd/coredump.conf.d/*.conf</filename></para>
  32   </refsynopsisdiv>
  33
  34   <refsect1>
  35     <title>Description</title>
  36
  37     <para>These files configure the behavior of
  38     <citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  39     a handler for core dumps invoked by the kernel. Whether <command>systemd-coredump</command> is used
  40     is determined by the kernel's
  41     <varname>kernel.core_pattern</varname> <citerefentry project='man-pages'><refentrytitle>sysctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  42     setting. See
  43     <citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  44     and
  45     <citerefentry project='man-pages'><refentrytitle>core</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  46     pages for the details.</para>
  47   </refsect1>
  48
  49   <xi:include href="standard-conf.xml" xpointer="main-conf" />
  50
  51   <refsect1>
  52     <title>Options</title>
  53
  54     <para>All options are configured in the
  55     <literal>[Coredump]</literal> section:</para>
  56
  57     <variablelist class='config-directives'>
  58
  59       <varlistentry>
  60         <term><varname>Storage=</varname></term>
  61
  62         <listitem><para>Controls where to store cores. One of <literal>none</literal>,
  63         <literal>external</literal>, and <literal>journal</literal>. When
  64         <literal>none</literal>, the core dumps may be logged (including the backtrace if
  65         possible), but not stored permanently. When <literal>external</literal> (the
  66         default), cores will be stored in <filename>/var/lib/systemd/coredump/</filename>.
  67         When <literal>journal</literal>, cores will be stored in the journal and rotated
  68         following normal journal rotation patterns.</para>
  69
  70         <para>When cores are stored in the journal, they might be
  71         compressed following journal compression settings, see
  72         <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
  73         When cores are stored externally, they will be compressed
  74         by default, see below.</para></listitem>
  75       </varlistentry>
  76
  77       <varlistentry>
  78         <term><varname>Compress=</varname></term>
  79
  80         <listitem><para>Controls compression for external
  81         storage. Takes a boolean argument, which defaults to
  82         <literal>yes</literal>.</para>
  83         </listitem>
  84       </varlistentry>
  85
  86       <varlistentry>
  87         <term><varname>ProcessSizeMax=</varname></term>
  88
  89         <listitem><para>The maximum size in bytes of a core
  90         which will be processed. Core dumps exceeding this size
  91         may be stored, but the backtrace will not be generated.
  92         </para>
  93
  94         <para>Setting <varname>Storage=none</varname> and <varname>ProcessSizeMax=0</varname>
  95         disables all coredump handling except for a log entry.</para>
  96         </listitem>
  97       </varlistentry>
  98
  99       <varlistentry>
 100         <term><varname>ExternalSizeMax=</varname></term>
 101         <term><varname>JournalSizeMax=</varname></term>
 102
 103         <listitem><para>The maximum (uncompressed) size in bytes of a
 104         core to be saved.</para></listitem>
 105       </varlistentry>
 106
 107       <varlistentry>
 108         <term><varname>MaxUse=</varname></term>
 109         <term><varname>KeepFree=</varname></term>
 110
 111         <listitem><para>Enforce limits on the disk space taken up by
 112         externally stored core dumps. <option>MaxUse=</option> makes
 113         sure that old core dumps are removed as soon as the total disk
 114         space taken up by core dumps grows beyond this limit (defaults
 115         to 10% of the total disk size). <option>KeepFree=</option>
 116         controls how much disk space to keep free at least (defaults
 117         to 15% of the total disk size). Note that the disk space used
 118         by core dumps might temporarily exceed these limits while
 119         core dumps are processed. Note that old core dumps are also
 120         removed based on time via
 121         <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>. Set
 122         either value to 0 to turn off size-based
 123         clean-up.</para></listitem>
 124       </varlistentry>
 125     </variablelist>
 126
 127     <para>The defaults for all values are listed as comments in the
 128     template <filename>/etc/systemd/coredump.conf</filename> file that
 129     is installed by default.</para>
 130   </refsect1>
 131
 132   <refsect1>
 133     <title>See Also</title>
 134     <para>
 135       <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 136       <citerefentry><refentrytitle>coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 137       <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 138     </para>
 139   </refsect1>
 140
 141 </refentry>