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 <literal>none</literal>,
  87         <literal>external</literal>, and <literal>journal</literal>. When
  88         <literal>none</literal>, the core dumps will be logged (included the traceback if
  89         possible), but not stored permanently. When <literal>external</literal> (the
  90         default), cores will be stored in <filename>/var/lib/systemd/coredump/</filename>.
  91         When <literal>journal</literal>, cores will be stored in the journal and rotated
  92         following normal journal rotation patterns.</para>
  93
  94         <para>When cores are stored in the journal, they might be
  95         compressed following journal compression settings, see
  96         <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
  97         When cores are stored externally, they will be compressed
  98         by default, see below.</para></listitem>
  99       </varlistentry>
 100
 101       <varlistentry>
 102         <term><varname>Compress=</varname></term>
 103
 104         <listitem><para>Controls compression for external
 105         storage. Takes a boolean argument, which defaults to
 106         <literal>yes</literal>.</para>
 107         </listitem>
 108       </varlistentry>
 109
 110       <varlistentry>
 111         <term><varname>ProcessSizeMax=</varname></term>
 112
 113         <listitem><para>The maximum size in bytes of a core
 114         which will be processed. Core dumps exceeding this size
 115         will be logged, but the backtrace will not be generated
 116         and the core will not be stored.</para></listitem>
 117       </varlistentry>
 118
 119       <varlistentry>
 120         <term><varname>ExternalSizeMax=</varname></term>
 121         <term><varname>JournalSizeMax=</varname></term>
 122
 123         <listitem><para>The maximum (uncompressed) size in bytes of a
 124         core to be saved.</para></listitem>
 125       </varlistentry>
 126
 127       <varlistentry>
 128         <term><varname>MaxUse=</varname></term>
 129         <term><varname>KeepFree=</varname></term>
 130
 131         <listitem><para>Enforce limits on the disk space taken up by
 132         externally stored core dumps. <option>MaxUse=</option> makes
 133         sure that old core dumps are removed as soon as the total disk
 134         space taken up by core dumps grows beyond this limit (defaults
 135         to 10% of the total disk size). <option>KeepFree=</option>
 136         controls how much disk space to keep free at least (defaults
 137         to 15% of the total disk size). Note that the disk space used
 138         by core dumps might temporarily exceed these limits while
 139         core dumps are processed. Note that old core dumps are also
 140         removed based on time via
 141         <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>. Set
 142         either value to 0 to turn off size-based
 143         clean-up.</para></listitem>
 144       </varlistentry>
 145     </variablelist>
 146
 147   </refsect1>
 148
 149   <refsect1>
 150     <title>See Also</title>
 151     <para>
 152       <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 153       <citerefentry><refentrytitle>coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 154       <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 155     </para>
 156   </refsect1>
 157
 158 </refentry>