coredump.conf.xml revision 5470c03b37d8421a903564c2c8028c8b8d67d403
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering<!--
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering This file is part of systemd.
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering Copyright 2014 Zbigniew Jędrzejewski-Szmek
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering systemd is free software; you can redistribute it and/or modify it
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering under the terms of the GNU Lesser General Public License as published by
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering the Free Software Foundation; either version 2.1 of the License, or
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering (at your option) any later version.
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering systemd is distributed in the hope that it will be useful, but
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering WITHOUT ANY WARRANTY; without even the implied warranty of
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering Lesser General Public License for more details.
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering You should have received a copy of the GNU Lesser General Public License
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering along with systemd; If not, see <http://www.gnu.org/licenses/>.
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering-->
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering<refentry id="coredump.conf" conditional="ENABLE_COREDUMP"
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering xmlns:xi="http://www.w3.org/2001/XInclude">
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <refentryinfo>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <title>coredump.conf</title>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <productname>systemd</productname>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <authorgroup>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <author>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <contrib>Developer</contrib>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <firstname>Lennart</firstname>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <surname>Poettering</surname>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <email>lennart@poettering.net</email>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering </author>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering </authorgroup>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering </refentryinfo>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <refmeta>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <refentrytitle>coredump.conf</refentrytitle>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <manvolnum>5</manvolnum>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering </refmeta>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <refnamediv>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <refname>coredump.conf</refname>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <refname>coredump.conf.d</refname>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <refpurpose>Coredump storage configuration files</refpurpose>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering </refnamediv>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <refsynopsisdiv>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <para><filename>/etc/systemd/coredump.conf</filename></para>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <para><filename>/etc/systemd/coredump.conf.d/*.conf</filename></para>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <para><filename>/run/systemd/coredump.conf.d/*.conf</filename></para>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <para><filename>/usr/lib/systemd/coredump.conf.d/*.conf</filename></para>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering </refsynopsisdiv>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <refsect1>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <title>Description</title>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <para>These files configure the behaviour of
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering a handler for core dumps invoked by the kernel.</para>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering </refsect1>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <xi:include href="standard-conf.xml" xpointer="main-conf" />
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <refsect1>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <title>Options</title>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <para>All options are configured in the
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <literal>[Coredump]</literal> section:</para>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <variablelist>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <varlistentry>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <term><varname>Storage=</varname></term>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <listitem><para>Controls where to store cores. One of
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <literal>none</literal>, <literal>external</literal>,
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <literal>journal</literal>, and <literal>both</literal>. When
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <literal>none</literal>, the coredumps will be logged but not
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering stored permanently. When <literal>external</literal> (the
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering default), cores will be stored in <filename>/var/lib/systemd/coredump</filename>.
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering When <literal>journal</literal>, cores will be stored in
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering the journal and rotated following normal journal
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering rotation patterns. When <literal>both</literal>, cores
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering will be stored in both locations.</para>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <para>When cores are stored in the journal, they might be
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering compressed following journal compression settings, see
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering When cores are stored externally, they will be compressed
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering by default, see below.</para></listitem>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering </varlistentry>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <varlistentry>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <term><varname>Compress=</varname></term>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <listitem><para>Controls compression for external
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering storage. Takes a boolean argument, defaults to
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering <literal>yes</literal>.</para>
151b190e79e64824552e01849352ca8f6ac7dedbLennart Poettering </listitem>
</varlistentry>
<varlistentry>
<term><varname>ProcessSizeMax=</varname></term>
<listitem><para>The maximum size in bytes of a core
which will be processed. Coredumps exceeding this size
will be logged, but the backtrace will not be generated
and the core will not be stored.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>ExternalSizeMax=</varname></term>
<term><varname>JournalSizeMax=</varname></term>
<listitem><para>The maximum (uncompressed) size in bytes of a
core to be saved.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>MaxUse=</varname></term>
<term><varname>KeepFree=</varname></term>
<listitem><para>Enforce limits on the disk space taken up by
externally stored coredumps. <option>MaxUse=</option> makes
sure that old coredumps are removed as soon as the total disk
space taken up by coredumps grows beyond this limit (defaults
to 10% of the total disk size). <option>KeepFree=</option>
controls how much disk space to keep free at least (defaults
to 15% of the total disk size). Note that the disk space used
by coredumps might temporarily exceed these limits while
coredumps are processed. Note that old coredumps are also
removed based on time via
<citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>. Set
either value to 0 to turn off size based
clean-up.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>