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   This file is part of systemd.
   7
   8   Copyright 2014 Zbigniew Jędrzejewski-Szmek
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 -->
  23
  24 <refentry id="coredump.conf" conditional="ENABLE_COREDUMP"
  25           xmlns:xi="http://www.w3.org/2001/XInclude">
  26   <refentryinfo>
  27     <title>coredump.conf</title>
  28     <productname>systemd</productname>
  29
  30     <authorgroup>
  31       <author>
  32         <contrib>Developer</contrib>
  33         <firstname>Lennart</firstname>
  34         <surname>Poettering</surname>
  35         <email>lennart@poettering.net</email>
  36       </author>
  37     </authorgroup>
  38   </refentryinfo>
  39
  40   <refmeta>
  41     <refentrytitle>coredump.conf</refentrytitle>
  42     <manvolnum>5</manvolnum>
  43   </refmeta>
  44
  45   <refnamediv>
  46     <refname>coredump.conf</refname>
  47     <refname>coredump.conf.d</refname>
  48     <refpurpose>Core dump storage configuration files</refpurpose>
  49   </refnamediv>
  50
  51   <refsynopsisdiv>
  52     <para><filename>/etc/systemd/coredump.conf</filename></para>
  53     <para><filename>/etc/systemd/coredump.conf.d/*.conf</filename></para>
  54     <para><filename>/run/systemd/coredump.conf.d/*.conf</filename></para>
  55     <para><filename>/usr/lib/systemd/coredump.conf.d/*.conf</filename></para>
  56   </refsynopsisdiv>
  57
  58   <refsect1>
  59     <title>Description</title>
  60
  61     <para>These files configure the behavior of
  62     <citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  63     a handler for core dumps invoked by the kernel. Whether <command>systemd-coredump</command> is used
  64     is determined by the kernel's
  65     <varname>kernel.core_pattern</varname> <citerefentry project='man-pages'><refentrytitle>sysctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  66     setting. See
  67     <citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  68     and
  69     <citerefentry project='man-pages'><refentrytitle>core</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  70     pages for the details.</para>
  71   </refsect1>
  72
  73   <xi:include href="standard-conf.xml" xpointer="main-conf" />
  74
  75   <refsect1>
  76     <title>Options</title>
  77
  78     <para>All options are configured in the
  79     <literal>[Coredump]</literal> section:</para>
  80
  81     <variablelist>
  82
  83       <varlistentry>
  84         <term><varname>Storage=</varname></term>
  85
  86         <listitem><para>Controls where to store cores. One of
  87         <literal>none</literal>, <literal>external</literal>,
  88         <literal>journal</literal>, and <literal>both</literal>. When
  89         <literal>none</literal>, the core dumps will be logged but not
  90         stored permanently. When <literal>external</literal> (the
  91         default), cores will be stored in <filename>/var/lib/systemd/coredump</filename>.
  92         When <literal>journal</literal>, cores will be stored in
  93         the journal and rotated following normal journal
  94         rotation patterns. When <literal>both</literal>, cores
  95         will be stored in both locations.</para>
  96
  97         <para>When cores are stored in the journal, they might be
  98         compressed following journal compression settings, see
  99         <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 100         When cores are stored externally, they will be compressed
 101         by default, see below.</para></listitem>
 102       </varlistentry>
 103
 104       <varlistentry>
 105         <term><varname>Compress=</varname></term>
 106
 107         <listitem><para>Controls compression for external
 108         storage. Takes a boolean argument, which defaults to
 109         <literal>yes</literal>.</para>
 110         </listitem>
 111       </varlistentry>
 112
 113       <varlistentry>
 114         <term><varname>ProcessSizeMax=</varname></term>
 115
 116         <listitem><para>The maximum size in bytes of a core
 117         which will be processed. Core dumps exceeding this size
 118         will be logged, but the backtrace will not be generated
 119         and the core will not be stored.</para></listitem>
 120       </varlistentry>
 121
 122       <varlistentry>
 123         <term><varname>ExternalSizeMax=</varname></term>
 124         <term><varname>JournalSizeMax=</varname></term>
 125
 126         <listitem><para>The maximum (uncompressed) size in bytes of a
 127         core to be saved.</para></listitem>
 128       </varlistentry>
 129
 130       <varlistentry>
 131         <term><varname>MaxUse=</varname></term>
 132         <term><varname>KeepFree=</varname></term>
 133
 134         <listitem><para>Enforce limits on the disk space taken up by
 135         externally stored core dumps. <option>MaxUse=</option> makes
 136         sure that old core dumps are removed as soon as the total disk
 137         space taken up by core dumps grows beyond this limit (defaults
 138         to 10% of the total disk size). <option>KeepFree=</option>
 139         controls how much disk space to keep free at least (defaults
 140         to 15% of the total disk size). Note that the disk space used
 141         by core dumps might temporarily exceed these limits while
 142         core dumps are processed. Note that old core dumps are also
 143         removed based on time via
 144         <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>. Set
 145         either value to 0 to turn off size-based
 146         clean-up.</para></listitem>
 147       </varlistentry>
 148     </variablelist>
 149
 150   </refsect1>
 151
 152   <refsect1>
 153     <title>See Also</title>
 154     <para>
 155       <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 156       <citerefentry><refentrytitle>coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 157       <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 158     </para>
 159   </refsect1>
 160
 161 </refentry>