]>
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 | <!-- | |
6 | This file is part of systemd. | |
7 | ||
8 | Copyright 2014 Zbigniew Jędrzejewski-Szmek | |
9 | ||
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. | |
14 | ||
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. | |
19 | ||
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/>. | |
22 | --> | |
23 | ||
301af7e4 JT |
24 | <refentry id="coredump.conf" conditional="ENABLE_COREDUMP" |
25 | xmlns:xi="http://www.w3.org/2001/XInclude"> | |
3cc765d2 ZJS |
26 | <refentryinfo> |
27 | <title>coredump.conf</title> | |
28 | <productname>systemd</productname> | |
29 | ||
30 | <authorgroup> | |
31 | <author> | |
32 | <contrib>Developer</contrib> | |
33 | <firstname>Lennart</firstname> | |
34 | <surname>Poettering</surname> | |
35 | <email>lennart@poettering.net</email> | |
36 | </author> | |
37 | </authorgroup> | |
38 | </refentryinfo> | |
39 | ||
40 | <refmeta> | |
41 | <refentrytitle>coredump.conf</refentrytitle> | |
42 | <manvolnum>5</manvolnum> | |
43 | </refmeta> | |
44 | ||
45 | <refnamediv> | |
46 | <refname>coredump.conf</refname> | |
301af7e4 JT |
47 | <refname>coredump.conf.d</refname> |
48 | <refpurpose>Coredump storage configuration files</refpurpose> | |
3cc765d2 ZJS |
49 | </refnamediv> |
50 | ||
51 | <refsynopsisdiv> | |
12b42c76 TG |
52 | <para><filename>/etc/systemd/coredump.conf</filename></para> |
53 | <para><filename>/etc/systemd/coredump.conf.d/*.conf</filename></para> | |
301af7e4 | 54 | <para><filename>/run/systemd/coredump.conf.d/*.conf</filename></para> |
12b42c76 | 55 | <para><filename>/usr/lib/systemd/coredump.conf.d/*.conf</filename></para> |
3cc765d2 ZJS |
56 | </refsynopsisdiv> |
57 | ||
58 | <refsect1> | |
59 | <title>Description</title> | |
60 | ||
dd2b607b | 61 | <para>These files configure the behavior of |
18ead1b0 | 62 | <citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry>, |
3cc765d2 ZJS |
63 | a handler for core dumps invoked by the kernel.</para> |
64 | </refsect1> | |
65 | ||
e93549ef | 66 | <xi:include href="standard-conf.xml" xpointer="main-conf" /> |
301af7e4 | 67 | |
3cc765d2 ZJS |
68 | <refsect1> |
69 | <title>Options</title> | |
70 | ||
71 | <para>All options are configured in the | |
72 | <literal>[Coredump]</literal> section:</para> | |
73 | ||
74 | <variablelist> | |
75 | ||
76 | <varlistentry> | |
77 | <term><varname>Storage=</varname></term> | |
78 | ||
79 | <listitem><para>Controls where to store cores. One of | |
80 | <literal>none</literal>, <literal>external</literal>, | |
81 | <literal>journal</literal>, and <literal>both</literal>. When | |
8d0e0ddd | 82 | <literal>none</literal>, the coredumps will be logged but not |
3cc765d2 ZJS |
83 | stored permanently. When <literal>external</literal> (the |
84 | default), cores will be stored in <filename>/var/lib/systemd/coredump</filename>. | |
85 | When <literal>journal</literal>, cores will be stored in | |
86 | the journal and rotated following normal journal | |
87 | rotation patterns. When <literal>both</literal>, cores | |
88 | will be stored in both locations.</para> | |
89 | ||
90 | <para>When cores are stored in the journal, they might be | |
91 | compressed following journal compression settings, see | |
92 | <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
93 | When cores are stored externally, they will be compressed | |
94 | by default, see below.</para></listitem> | |
95 | </varlistentry> | |
96 | ||
97 | <varlistentry> | |
8c9571d0 | 98 | <term><varname>Compress=</varname></term> |
3cc765d2 | 99 | |
442f7f15 | 100 | <listitem><para>Controls compression for external |
8c9571d0 LP |
101 | storage. Takes a boolean argument, defaults to |
102 | <literal>yes</literal>.</para> | |
3cc765d2 ZJS |
103 | </listitem> |
104 | </varlistentry> | |
105 | ||
3cc765d2 ZJS |
106 | <varlistentry> |
107 | <term><varname>ProcessSizeMax=</varname></term> | |
108 | ||
109 | <listitem><para>The maximum size in bytes of a core | |
110 | which will be processed. Coredumps exceeding this size | |
111 | will be logged, but the backtrace will not be generated | |
112 | and the core will not be stored.</para></listitem> | |
113 | </varlistentry> | |
114 | ||
115 | <varlistentry> | |
116 | <term><varname>ExternalSizeMax=</varname></term> | |
117 | <term><varname>JournalSizeMax=</varname></term> | |
118 | ||
119 | <listitem><para>The maximum (uncompressed) size in bytes of a | |
120 | core to be saved.</para></listitem> | |
121 | </varlistentry> | |
0dc5d23c LP |
122 | |
123 | <varlistentry> | |
124 | <term><varname>MaxUse=</varname></term> | |
125 | <term><varname>KeepFree=</varname></term> | |
126 | ||
127 | <listitem><para>Enforce limits on the disk space taken up by | |
128 | externally stored coredumps. <option>MaxUse=</option> makes | |
129 | sure that old coredumps are removed as soon as the total disk | |
130 | space taken up by coredumps grows beyond this limit (defaults | |
131 | to 10% of the total disk size). <option>KeepFree=</option> | |
132 | controls how much disk space to keep free at least (defaults | |
133 | to 15% of the total disk size). Note that the disk space used | |
134 | by coredumps might temporarily exceed these limits while | |
135 | coredumps are processed. Note that old coredumps are also | |
cbfaff65 | 136 | removed based on time via |
5470c03b LP |
137 | <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>. Set |
138 | either value to 0 to turn off size based | |
139 | clean-up.</para></listitem> | |
0dc5d23c | 140 | </varlistentry> |
3cc765d2 ZJS |
141 | </variablelist> |
142 | ||
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> |