2018-07-02 21:15:39 +00:00
|
|
|
<?xml version='1.0'?>
|
2019-03-14 13:40:58 +00:00
|
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
2023-12-25 14:48:33 +00:00
|
|
|
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
|
2020-11-09 04:23:58 +00:00
|
|
|
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
|
2014-06-26 05:02:48 +00:00
|
|
|
|
2014-11-29 09:06:48 +00:00
|
|
|
<refentry id="coredump.conf" conditional="ENABLE_COREDUMP"
|
|
|
|
xmlns:xi="http://www.w3.org/2001/XInclude">
|
2014-06-26 05:02:48 +00:00
|
|
|
<refentryinfo>
|
|
|
|
<title>coredump.conf</title>
|
|
|
|
<productname>systemd</productname>
|
|
|
|
</refentryinfo>
|
|
|
|
|
|
|
|
<refmeta>
|
|
|
|
<refentrytitle>coredump.conf</refentrytitle>
|
|
|
|
<manvolnum>5</manvolnum>
|
|
|
|
</refmeta>
|
|
|
|
|
|
|
|
<refnamediv>
|
|
|
|
<refname>coredump.conf</refname>
|
2014-11-29 09:06:48 +00:00
|
|
|
<refname>coredump.conf.d</refname>
|
2016-05-16 09:56:04 +00:00
|
|
|
<refpurpose>Core dump storage configuration files</refpurpose>
|
2014-06-26 05:02:48 +00:00
|
|
|
</refnamediv>
|
|
|
|
|
|
|
|
<refsynopsisdiv>
|
2023-12-14 11:52:03 +00:00
|
|
|
<para><simplelist>
|
|
|
|
<member><filename>/etc/systemd/coredump.conf</filename></member>
|
|
|
|
<member><filename>/etc/systemd/coredump.conf.d/*.conf</filename></member>
|
|
|
|
<member><filename>/run/systemd/coredump.conf.d/*.conf</filename></member>
|
|
|
|
<member><filename>/usr/lib/systemd/coredump.conf.d/*.conf</filename></member>
|
|
|
|
</simplelist></para>
|
2014-06-26 05:02:48 +00:00
|
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Description</title>
|
|
|
|
|
2015-07-25 21:15:05 +00:00
|
|
|
<para>These files configure the behavior of
|
2014-11-30 14:45:29 +00:00
|
|
|
<citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
|
2016-04-02 14:40:09 +00:00
|
|
|
a handler for core dumps invoked by the kernel. Whether <command>systemd-coredump</command> is used
|
|
|
|
is determined by the kernel's
|
2021-03-25 14:40:39 +00:00
|
|
|
<varname>kernel.core_pattern</varname> <citerefentry project='man-pages'><refentrytitle>sysctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>
|
2016-04-02 14:40:09 +00:00
|
|
|
setting. See
|
|
|
|
<citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry>
|
|
|
|
and
|
|
|
|
<citerefentry project='man-pages'><refentrytitle>core</refentrytitle><manvolnum>5</manvolnum></citerefentry>
|
|
|
|
pages for the details.</para>
|
2014-06-26 05:02:48 +00:00
|
|
|
</refsect1>
|
|
|
|
|
2015-03-04 00:10:21 +00:00
|
|
|
<xi:include href="standard-conf.xml" xpointer="main-conf" />
|
2014-11-29 09:06:48 +00:00
|
|
|
|
2014-06-26 05:02:48 +00:00
|
|
|
<refsect1>
|
|
|
|
<title>Options</title>
|
|
|
|
|
|
|
|
<para>All options are configured in the
|
2020-07-06 09:00:06 +00:00
|
|
|
[Coredump] section:</para>
|
2014-06-26 05:02:48 +00:00
|
|
|
|
2019-02-13 09:49:47 +00:00
|
|
|
<variablelist class='config-directives'>
|
2014-06-26 05:02:48 +00:00
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><varname>Storage=</varname></term>
|
|
|
|
|
coredump: remove Storage=both option
Back when external storage was initially added in 34c10968cb, this mode of
storage was added. This could have made some sense back when XZ compression was
used, and an uncompressed core on disk could be used as short-lived cache file
which does require costly decompression. But now fast LZ4 compression is used
(by default) both internally and externally, so we have duplicated storage,
using the same compression and same default maximum core size in both cases,
but with different expiration lifetimes. Even the uncompressed-external,
compressed-internal mode is not very useful: for small files, decompression
with LZ4 is fast enough not to matter, and for large files, decompression is
still relatively fast, but the disk-usage penalty is very big.
An additional problem with the two modes of storage is that it complicates
the code and makes it much harder to return a useful error message to the user
if we cannot find the core file, since if we cannot find the file we have to
check the internal storage first.
This patch drops "both" storage mode. Effectively this means that if somebody
configured coredump this way, they will get a warning about an unsupported
value for Storage, and the default of "external" will be used.
I'm pretty sure that this mode is very rarely used anyway.
2016-09-26 21:40:20 +00:00
|
|
|
<listitem><para>Controls where to store cores. One of <literal>none</literal>,
|
2023-08-10 10:09:15 +00:00
|
|
|
<literal>external</literal>, and <literal>journal</literal>. When <literal>none</literal>, the core
|
|
|
|
dumps may be logged (including the backtrace if possible), but not stored permanently. When
|
|
|
|
<literal>external</literal> (the default), cores will be stored in
|
|
|
|
<filename>/var/lib/systemd/coredump/</filename>. When <literal>journal</literal>, cores will be
|
|
|
|
stored in the journal and rotated following normal journal rotation patterns.</para>
|
|
|
|
|
|
|
|
<para>When cores are stored in the journal, they might be compressed following journal compression
|
|
|
|
settings, see
|
2014-06-26 05:02:48 +00:00
|
|
|
<citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
|
2023-08-10 10:09:15 +00:00
|
|
|
When cores are stored externally, they will be compressed by default, see below.</para>
|
|
|
|
|
|
|
|
<para>Note that in order to process a coredump (i.e. extract a stack trace) the core must be written
|
|
|
|
to disk first. Thus, unless <varname>ProcessSizeMax=</varname> is set to 0 (see below), the core will
|
|
|
|
be written to <filename>/var/lib/systemd/coredump/</filename> either way (under a temporary filename,
|
|
|
|
or even in an unlinked file), <varname>Storage=</varname> thus only controls whether to leave it
|
2023-08-22 16:52:36 +00:00
|
|
|
there even after it was processed.</para>
|
|
|
|
|
|
|
|
<xi:include href="version-info.xml" xpointer="v215"/></listitem>
|
2014-06-26 05:02:48 +00:00
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2014-06-27 17:09:22 +00:00
|
|
|
<term><varname>Compress=</varname></term>
|
2014-06-26 05:02:48 +00:00
|
|
|
|
2014-12-01 03:13:06 +00:00
|
|
|
<listitem><para>Controls compression for external
|
2014-08-03 05:11:37 +00:00
|
|
|
storage. Takes a boolean argument, which defaults to
|
2014-06-27 17:09:22 +00:00
|
|
|
<literal>yes</literal>.</para>
|
2023-08-22 16:52:36 +00:00
|
|
|
|
|
|
|
<xi:include href="version-info.xml" xpointer="v215"/>
|
2014-06-26 05:02:48 +00:00
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><varname>ProcessSizeMax=</varname></term>
|
|
|
|
|
2021-07-27 07:37:29 +00:00
|
|
|
<listitem><para>The maximum size in bytes of a core which will be processed. Core dumps exceeding
|
2023-08-10 10:09:15 +00:00
|
|
|
this size may be stored, but the stack trace will not be generated. Like other sizes in this same
|
2022-02-08 10:54:37 +00:00
|
|
|
config file, the usual suffixes to the base of 1024 are allowed (B, K, M, G, T, P, and E). Defaults
|
2023-07-01 21:33:20 +00:00
|
|
|
to 1G on 32-bit systems, 32G on 64-bit systems.</para>
|
2018-05-17 15:08:31 +00:00
|
|
|
|
|
|
|
<para>Setting <varname>Storage=none</varname> and <varname>ProcessSizeMax=0</varname>
|
|
|
|
disables all coredump handling except for a log entry.</para>
|
2023-08-22 16:52:36 +00:00
|
|
|
|
|
|
|
<xi:include href="version-info.xml" xpointer="v215"/>
|
2018-05-17 15:08:31 +00:00
|
|
|
</listitem>
|
2014-06-26 05:02:48 +00:00
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><varname>ExternalSizeMax=</varname></term>
|
|
|
|
<term><varname>JournalSizeMax=</varname></term>
|
|
|
|
|
2023-06-22 15:10:14 +00:00
|
|
|
<listitem><para>The maximum (compressed or uncompressed) size in bytes of a coredump to be saved in
|
|
|
|
separate files on disk (default: 1G on 32-bit systems, 32G on 64-bit systems) or in the journal
|
|
|
|
(default: 767M). Note that the journal service enforces a hard limit on journal log records of 767M,
|
|
|
|
and will ignore larger submitted log records. Hence, <varname>JournalSizeMax=</varname> may be
|
|
|
|
lowered relative to the default, but not increased. Unit suffixes are allowed just as in
|
|
|
|
<option>ProcessSizeMax=</option>.</para>
|
|
|
|
|
2023-08-22 16:52:36 +00:00
|
|
|
<para><varname>ExternalSizeMax=infinity</varname> sets the core size to unlimited.</para>
|
|
|
|
|
|
|
|
<xi:include href="version-info.xml" xpointer="v215"/></listitem>
|
2014-06-26 05:02:48 +00:00
|
|
|
</varlistentry>
|
2014-06-27 16:57:24 +00:00
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><varname>MaxUse=</varname></term>
|
|
|
|
<term><varname>KeepFree=</varname></term>
|
|
|
|
|
2021-03-25 14:40:39 +00:00
|
|
|
<listitem><para>Enforce limits on the disk space, specified
|
|
|
|
in bytes, taken up by externally stored core dumps.
|
|
|
|
Unit suffixes are allowed just as in <option>ProcessSizeMax=</option>.
|
|
|
|
<option>MaxUse=</option> makes
|
2016-05-16 09:56:04 +00:00
|
|
|
sure that old core dumps are removed as soon as the total disk
|
|
|
|
space taken up by core dumps grows beyond this limit (defaults
|
2014-06-27 16:57:24 +00:00
|
|
|
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
|
2016-05-16 09:56:04 +00:00
|
|
|
by core dumps might temporarily exceed these limits while
|
|
|
|
core dumps are processed. Note that old core dumps are also
|
2014-07-23 10:40:07 +00:00
|
|
|
removed based on time via
|
2021-07-27 07:37:29 +00:00
|
|
|
<citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
|
2023-08-22 16:52:36 +00:00
|
|
|
Set either value to 0 to turn off size-based cleanup.</para>
|
|
|
|
|
|
|
|
<xi:include href="version-info.xml" xpointer="v215"/></listitem>
|
2014-06-27 16:57:24 +00:00
|
|
|
</varlistentry>
|
2014-06-26 05:02:48 +00:00
|
|
|
</variablelist>
|
|
|
|
|
2018-01-19 23:27:46 +00:00
|
|
|
<para>The defaults for all values are listed as comments in the
|
|
|
|
template <filename>/etc/systemd/coredump.conf</filename> file that
|
|
|
|
is installed by default.</para>
|
2014-06-26 05:02:48 +00:00
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>See Also</title>
|
2023-12-22 18:09:32 +00:00
|
|
|
<para><simplelist type="inline">
|
|
|
|
<member><citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
|
|
|
|
<member><citerefentry><refentrytitle>coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
|
|
|
|
<member><citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
|
|
|
|
</simplelist></para>
|
2014-06-26 05:02:48 +00:00
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
</refentry>
|