mirror of
https://github.com/systemd/systemd.git
synced 2025-09-15 13:44:41 +03:00
man: fix ProcessSizeMax= description, describe how to disable coredumps
What the man page said was different than what the code did. save_external_coredump() will store the core temporarily for backtrace generation, and will delete if afterwards if it is too large. So to disable processing, it's necessary to both set Storage=none/Storage=journal+JournalSizeMax=0/Storage=external+ExternalSizeMax=0 and ProcessSizeMax=0. This updates the man page to reflect the code. The man pages are extended to describe that Storage=none + ProcessSizeMax=0 is the simplest way to disable coredump processing. All the storage and processing options make this quite complicated, so let's add a copy-and-pasteable example of how to disable coredump. Doing it through coredump.conf has the advantage that we still log, and the effect is immediate, unlike masking the sysconf file. Fixes #8788.
This commit is contained in:
@@ -74,7 +74,7 @@
|
|||||||
|
|
||||||
<listitem><para>Controls where to store cores. One of <literal>none</literal>,
|
<listitem><para>Controls where to store cores. One of <literal>none</literal>,
|
||||||
<literal>external</literal>, and <literal>journal</literal>. When
|
<literal>external</literal>, and <literal>journal</literal>. When
|
||||||
<literal>none</literal>, the core dumps will be logged (including the backtrace if
|
<literal>none</literal>, the core dumps may be logged (including the backtrace if
|
||||||
possible), but not stored permanently. When <literal>external</literal> (the
|
possible), but not stored permanently. When <literal>external</literal> (the
|
||||||
default), cores will be stored in <filename>/var/lib/systemd/coredump/</filename>.
|
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
|
When <literal>journal</literal>, cores will be stored in the journal and rotated
|
||||||
@@ -101,8 +101,12 @@
|
|||||||
|
|
||||||
<listitem><para>The maximum size in bytes of a core
|
<listitem><para>The maximum size in bytes of a core
|
||||||
which will be processed. Core dumps exceeding this size
|
which will be processed. Core dumps exceeding this size
|
||||||
will be logged, but the backtrace will not be generated
|
may be stored, but the backtrace will not be generated.
|
||||||
and the core will not be stored.</para></listitem>
|
</para>
|
||||||
|
|
||||||
|
<para>Setting <varname>Storage=none</varname> and <varname>ProcessSizeMax=0</varname>
|
||||||
|
disables all coredump handling except for a log entry.</para>
|
||||||
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
|
@@ -128,6 +128,16 @@
|
|||||||
core dumps and files can be set in files <filename>/etc/systemd/coredump.conf</filename> and snippets mentioned
|
core dumps and files can be set in files <filename>/etc/systemd/coredump.conf</filename> and snippets mentioned
|
||||||
above. In addition the storage time of core dump files is restricted by <command>systemd-tmpfiles</command>,
|
above. In addition the storage time of core dump files is restricted by <command>systemd-tmpfiles</command>,
|
||||||
corresponding settings are by default in <filename>/usr/lib/tmpfiles.d/systemd.conf</filename>.</para>
|
corresponding settings are by default in <filename>/usr/lib/tmpfiles.d/systemd.conf</filename>.</para>
|
||||||
|
|
||||||
|
<refsect2>
|
||||||
|
<title>Disabling coredump processing</title>
|
||||||
|
|
||||||
|
<para>To disable potentially resource-intensive processing by <command>systemd-coredump</command>,
|
||||||
|
set <programlisting>Storage=none
|
||||||
|
ProcessSizeMax=0</programlisting> in
|
||||||
|
<citerefentry><refentrytitle>coredump.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
|
||||||
|
</para>
|
||||||
|
</refsect2>
|
||||||
</refsect1>
|
</refsect1>
|
||||||
|
|
||||||
<refsect1>
|
<refsect1>
|
||||||
|
Reference in New Issue
Block a user