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