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