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