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