]>
Commit | Line | Data |
---|---|---|
3802a3d3 | 1 | <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> |
3cc765d2 | 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
12b42c76 | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
3cc765d2 ZJS |
4 | |
5 | <!-- | |
572eb058 ZJS |
6 | SPDX-License-Identifier: LGPL-2.1+ |
7 | ||
3cc765d2 ZJS |
8 | This file is part of systemd. |
9 | ||
10 | Copyright 2014 Zbigniew Jędrzejewski-Szmek | |
3cc765d2 ZJS |
11 | --> |
12 | ||
301af7e4 JT |
13 | <refentry id="coredump.conf" conditional="ENABLE_COREDUMP" |
14 | xmlns:xi="http://www.w3.org/2001/XInclude"> | |
3cc765d2 ZJS |
15 | <refentryinfo> |
16 | <title>coredump.conf</title> | |
17 | <productname>systemd</productname> | |
18 | ||
19 | <authorgroup> | |
20 | <author> | |
21 | <contrib>Developer</contrib> | |
22 | <firstname>Lennart</firstname> | |
23 | <surname>Poettering</surname> | |
24 | <email>lennart@poettering.net</email> | |
25 | </author> | |
26 | </authorgroup> | |
27 | </refentryinfo> | |
28 | ||
29 | <refmeta> | |
30 | <refentrytitle>coredump.conf</refentrytitle> | |
31 | <manvolnum>5</manvolnum> | |
32 | </refmeta> | |
33 | ||
34 | <refnamediv> | |
35 | <refname>coredump.conf</refname> | |
301af7e4 | 36 | <refname>coredump.conf.d</refname> |
246ba4aa | 37 | <refpurpose>Core dump storage configuration files</refpurpose> |
3cc765d2 ZJS |
38 | </refnamediv> |
39 | ||
40 | <refsynopsisdiv> | |
12b42c76 TG |
41 | <para><filename>/etc/systemd/coredump.conf</filename></para> |
42 | <para><filename>/etc/systemd/coredump.conf.d/*.conf</filename></para> | |
301af7e4 | 43 | <para><filename>/run/systemd/coredump.conf.d/*.conf</filename></para> |
12b42c76 | 44 | <para><filename>/usr/lib/systemd/coredump.conf.d/*.conf</filename></para> |
3cc765d2 ZJS |
45 | </refsynopsisdiv> |
46 | ||
47 | <refsect1> | |
48 | <title>Description</title> | |
49 | ||
dd2b607b | 50 | <para>These files configure the behavior of |
18ead1b0 | 51 | <citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry>, |
f3962329 ZJS |
52 | a handler for core dumps invoked by the kernel. Whether <command>systemd-coredump</command> is used |
53 | is determined by the kernel's | |
54 | <varname>kernel.core_pattern</varname> <citerefentry project='man-pages'><refentrytitle>sysctl</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
55 | setting. See | |
56 | <citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
57 | and | |
58 | <citerefentry project='man-pages'><refentrytitle>core</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
59 | pages for the details.</para> | |
3cc765d2 ZJS |
60 | </refsect1> |
61 | ||
e93549ef | 62 | <xi:include href="standard-conf.xml" xpointer="main-conf" /> |
301af7e4 | 63 | |
3cc765d2 ZJS |
64 | <refsect1> |
65 | <title>Options</title> | |
66 | ||
67 | <para>All options are configured in the | |
68 | <literal>[Coredump]</literal> section:</para> | |
69 | ||
70 | <variablelist> | |
71 | ||
72 | <varlistentry> | |
73 | <term><varname>Storage=</varname></term> | |
74 | ||
fc6cec86 ZJS |
75 | <listitem><para>Controls where to store cores. One of <literal>none</literal>, |
76 | <literal>external</literal>, and <literal>journal</literal>. When | |
c8e053fb | 77 | <literal>none</literal>, the core dumps may be logged (including the backtrace if |
fc6cec86 ZJS |
78 | possible), but not stored permanently. When <literal>external</literal> (the |
79 | default), cores will be stored in <filename>/var/lib/systemd/coredump/</filename>. | |
80 | When <literal>journal</literal>, cores will be stored in the journal and rotated | |
81 | following normal journal rotation patterns.</para> | |
3cc765d2 ZJS |
82 | |
83 | <para>When cores are stored in the journal, they might be | |
84 | compressed following journal compression settings, see | |
85 | <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
86 | When cores are stored externally, they will be compressed | |
87 | by default, see below.</para></listitem> | |
88 | </varlistentry> | |
89 | ||
90 | <varlistentry> | |
8c9571d0 | 91 | <term><varname>Compress=</varname></term> |
3cc765d2 | 92 | |
442f7f15 | 93 | <listitem><para>Controls compression for external |
a8eaaee7 | 94 | storage. Takes a boolean argument, which defaults to |
8c9571d0 | 95 | <literal>yes</literal>.</para> |
3cc765d2 ZJS |
96 | </listitem> |
97 | </varlistentry> | |
98 | ||
3cc765d2 ZJS |
99 | <varlistentry> |
100 | <term><varname>ProcessSizeMax=</varname></term> | |
101 | ||
102 | <listitem><para>The maximum size in bytes of a core | |
246ba4aa | 103 | which will be processed. Core dumps exceeding this size |
c8e053fb ZJS |
104 | may be stored, but the backtrace will not be generated. |
105 | </para> | |
106 | ||
107 | <para>Setting <varname>Storage=none</varname> and <varname>ProcessSizeMax=0</varname> | |
108 | disables all coredump handling except for a log entry.</para> | |
109 | </listitem> | |
3cc765d2 ZJS |
110 | </varlistentry> |
111 | ||
112 | <varlistentry> | |
113 | <term><varname>ExternalSizeMax=</varname></term> | |
114 | <term><varname>JournalSizeMax=</varname></term> | |
115 | ||
116 | <listitem><para>The maximum (uncompressed) size in bytes of a | |
117 | core to be saved.</para></listitem> | |
118 | </varlistentry> | |
0dc5d23c LP |
119 | |
120 | <varlistentry> | |
121 | <term><varname>MaxUse=</varname></term> | |
122 | <term><varname>KeepFree=</varname></term> | |
123 | ||
124 | <listitem><para>Enforce limits on the disk space taken up by | |
246ba4aa PM |
125 | externally stored core dumps. <option>MaxUse=</option> makes |
126 | sure that old core dumps are removed as soon as the total disk | |
127 | space taken up by core dumps grows beyond this limit (defaults | |
0dc5d23c LP |
128 | to 10% of the total disk size). <option>KeepFree=</option> |
129 | controls how much disk space to keep free at least (defaults | |
130 | to 15% of the total disk size). Note that the disk space used | |
246ba4aa PM |
131 | by core dumps might temporarily exceed these limits while |
132 | core dumps are processed. Note that old core dumps are also | |
cbfaff65 | 133 | removed based on time via |
5470c03b | 134 | <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>. Set |
b938cb90 | 135 | either value to 0 to turn off size-based |
5470c03b | 136 | clean-up.</para></listitem> |
0dc5d23c | 137 | </varlistentry> |
3cc765d2 ZJS |
138 | </variablelist> |
139 | ||
8eeaf79c ZJS |
140 | <para>The defaults for all values are listed as comments in the |
141 | template <filename>/etc/systemd/coredump.conf</filename> file that | |
142 | is installed by default.</para> | |
3cc765d2 ZJS |
143 | </refsect1> |
144 | ||
145 | <refsect1> | |
146 | <title>See Also</title> | |
147 | <para> | |
148 | <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
0dc5d23c LP |
149 | <citerefentry><refentrytitle>coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, |
150 | <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
3cc765d2 ZJS |
151 | </para> |
152 | </refsect1> | |
153 | ||
154 | </refentry> |