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">
6 This file is part of systemd.
8 Copyright 2014 Zbigniew Jędrzejewski-Szmek
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.
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.
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/>.
24 <refentry id="coredump.conf" conditional="ENABLE_COREDUMP"
25 xmlns:xi="http://www.w3.org/2001/XInclude">
27 <title>coredump.conf</title>
28 <productname>systemd</productname>
32 <contrib>Developer</contrib>
33 <firstname>Lennart</firstname>
34 <surname>Poettering</surname>
35 <email>lennart@poettering.net</email>
41 <refentrytitle>coredump.conf</refentrytitle>
42 <manvolnum>5</manvolnum>
46 <refname>coredump.conf</refname>
47 <refname>coredump.conf.d</refname>
48 <refpurpose>Coredump storage configuration files</refpurpose>
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>
59 <title>Description</title>
61 <para>These files configure the behaviour of
62 <citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
63 a handler for core dumps invoked by the kernel.</para>
66 <xi:include href="standard-conf.xml" xpointer="confd" />
67 <xi:include href="standard-conf.xml" xpointer="conf" />
70 <title>Options</title>
72 <para>All options are configured in the
73 <literal>[Coredump]</literal> section:</para>
78 <term><varname>Storage=</varname></term>
80 <listitem><para>Controls where to store cores. One of
81 <literal>none</literal>, <literal>external</literal>,
82 <literal>journal</literal>, and <literal>both</literal>. When
83 <literal>none</literal>, the coredumps will be logged but not
84 stored permanently. When <literal>external</literal> (the
85 default), cores will be stored in <filename>/var/lib/systemd/coredump</filename>.
86 When <literal>journal</literal>, cores will be stored in
87 the journal and rotated following normal journal
88 rotation patterns. When <literal>both</literal>, cores
89 will be stored in both locations.</para>
91 <para>When cores are stored in the journal, they might be
92 compressed following journal compression settings, see
93 <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
94 When cores are stored externally, they will be compressed
95 by default, see below.</para></listitem>
99 <term><varname>Compress=</varname></term>
101 <listitem><para>Controls compression for external
102 storage. Takes a boolean argument, defaults to
103 <literal>yes</literal>.</para>
108 <term><varname>ProcessSizeMax=</varname></term>
110 <listitem><para>The maximum size in bytes of a core
111 which will be processed. Coredumps exceeding this size
112 will be logged, but the backtrace will not be generated
113 and the core will not be stored.</para></listitem>
117 <term><varname>ExternalSizeMax=</varname></term>
118 <term><varname>JournalSizeMax=</varname></term>
120 <listitem><para>The maximum (uncompressed) size in bytes of a
121 core to be saved.</para></listitem>
125 <term><varname>MaxUse=</varname></term>
126 <term><varname>KeepFree=</varname></term>
128 <listitem><para>Enforce limits on the disk space taken up by
129 externally stored coredumps. <option>MaxUse=</option> makes
130 sure that old coredumps are removed as soon as the total disk
131 space taken up by coredumps grows beyond this limit (defaults
132 to 10% of the total disk size). <option>KeepFree=</option>
133 controls how much disk space to keep free at least (defaults
134 to 15% of the total disk size). Note that the disk space used
135 by coredumps might temporarily exceed these limits while
136 coredumps are processed. Note that old coredumps are also
137 removed based on time via
138 <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para></listitem>
145 <title>See Also</title>
147 <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
148 <citerefentry><refentrytitle>coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
149 <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>