summaryrefslogtreecommitdiff
path: root/man/coredump.conf.html
blob: a784606e80d3a0b546208f97230f480fbf367f0d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>coredump.conf</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><style>
    a.headerlink {
      color: #c60f0f;
      font-size: 0.8em;
      padding: 0 4px 0 4px;
      text-decoration: none;
      visibility: hidden;
    }

    a.headerlink:hover {
      background-color: #c60f0f;
      color: white;
    }

    h1:hover > a.headerlink, h2:hover > a.headerlink, h3:hover > a.headerlink, dt:hover > a.headerlink {
      visibility: visible;
    }
  </style><a href="index.html">Index </a>·
  <a href="systemd.directives.html">Directives </a>·
  <a href="../python-systemd/index.html">Python </a>·

  <span style="float:right">systemd 221</span><hr><div class="refentry"><a name="coredump.conf"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>coredump.conf, coredump.conf.d — Coredump storage configuration files</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><p><code class="filename">/etc/systemd/coredump.conf</code></p><p><code class="filename">/etc/systemd/coredump.conf.d/*.conf</code></p><p><code class="filename">/run/systemd/coredump.conf.d/*.conf</code></p><p><code class="filename">/usr/lib/systemd/coredump.conf.d/*.conf</code></p></div><div class="refsect1"><a name="idm47534147076016"></a><h2 id="Description">Description<a class="headerlink" title="Permalink to this headline" href="#Description">¶</a></h2><p>These files configure the behaviour of
    <a href="systemd-coredump.html"><span class="citerefentry"><span class="refentrytitle">systemd-coredump</span>(8)</span></a>,
    a handler for core dumps invoked by the kernel.</p></div><div class="refsection"><a name="main-conf"></a><h2>Configuration Directories and Precedence</h2><p>Default configuration is defined during compilation, so a
    configuration file is only needed when it is necessary to deviate
    from those defaults. By default the configuration file in
    <code class="filename">/etc/systemd/</code> contains commented out entries
    showing the defaults as a guide to the administrator. This file
    can be edited to create local overrides.
    </p><p>When packages need to customize the configuration, they can
    install configuration snippets in
    <code class="filename">/usr/lib/systemd/*.conf.d/</code>. Files in
    <code class="filename">/etc/</code> are reserved for the local
    administrator, who may use this logic to override the
    configuration files installed by vendor packages. The main
    configuration file is read before any of the configuration
    directories, and has the lowest precedence; entries in a file in
    any configuration directory override entries in the single
    configuration file. Files in the
    <code class="filename">*.conf.d/</code> configuration subdirectories
    are sorted by their filename in lexicographic order, regardless of
    which of the subdirectories they reside in. If multiple files
    specify the same option, the entry in the file with the
    lexicographically latest name takes precedence.  It is recommended
    to prefix all filenames in those subdirectories with a two-digit
    number and a dash, to simplify the ordering of the files.</p><p>To disable a configuration file supplied by the vendor, the
    recommended way is to place a symlink to
    <code class="filename">/dev/null</code> in the configuration directory in
    <code class="filename">/etc/</code>, with the same filename as the vendor
    configuration file.</p></div><div class="refsect1"><a name="idm47534142119872"></a><h2 id="Options">Options<a class="headerlink" title="Permalink to this headline" href="#Options">¶</a></h2><p>All options are configured in the
    "<code class="literal">[Coredump]</code>" section:</p><div class="variablelist"><dl class="variablelist"><dt id="Storage="><span class="term"><code class="varname">Storage=</code></span><a class="headerlink" title="Permalink to this term" href="#Storage=">¶</a></dt><dd><p>Controls where to store cores. One of
        "<code class="literal">none</code>", "<code class="literal">external</code>",
        "<code class="literal">journal</code>", and "<code class="literal">both</code>". When
        "<code class="literal">none</code>", the coredumps will be logged but not
        stored permanently. When "<code class="literal">external</code>" (the
        default), cores will be stored in <code class="filename">/var/lib/systemd/coredump</code>.
        When "<code class="literal">journal</code>", cores will be stored in
        the journal and rotated following normal journal
        rotation patterns. When "<code class="literal">both</code>", cores
        will be stored in both locations.</p><p>When cores are stored in the journal, they might be
        compressed following journal compression settings, see
        <a href="journald.conf.html"><span class="citerefentry"><span class="refentrytitle">journald.conf</span>(5)</span></a>.
        When cores are stored externally, they will be compressed
        by default, see below.</p></dd><dt id="Compress="><span class="term"><code class="varname">Compress=</code></span><a class="headerlink" title="Permalink to this term" href="#Compress=">¶</a></dt><dd><p>Controls compression for external
        storage. Takes a boolean argument, defaults to
        "<code class="literal">yes</code>".</p></dd><dt id="ProcessSizeMax="><span class="term"><code class="varname">ProcessSizeMax=</code></span><a class="headerlink" title="Permalink to this term" href="#ProcessSizeMax=">¶</a></dt><dd><p>The maximum size in bytes of a core
        which will be processed. Coredumps exceeding this size
        will be logged, but the backtrace will not be generated
        and the core will not be stored.</p></dd><dt id="ExternalSizeMax="><span class="term"><code class="varname">ExternalSizeMax=</code>, </span><span class="term"><code class="varname">JournalSizeMax=</code></span><a class="headerlink" title="Permalink to this term" href="#ExternalSizeMax=">¶</a></dt><dd><p>The maximum (uncompressed) size in bytes of a
        core to be saved.</p></dd><dt id="MaxUse="><span class="term"><code class="varname">MaxUse=</code>, </span><span class="term"><code class="varname">KeepFree=</code></span><a class="headerlink" title="Permalink to this term" href="#MaxUse=">¶</a></dt><dd><p>Enforce limits on the disk space taken up by
        externally stored coredumps. <code class="option">MaxUse=</code> makes
        sure that old coredumps are removed as soon as the total disk
        space taken up by coredumps grows beyond this limit (defaults
        to 10% of the total disk size). <code class="option">KeepFree=</code>
        controls how much disk space to keep free at least (defaults
        to 15% of the total disk size). Note that the disk space used
        by coredumps might temporarily exceed these limits while
        coredumps are processed. Note that old coredumps are also
        removed based on time via
        <a href="systemd-tmpfiles.html"><span class="citerefentry"><span class="refentrytitle">systemd-tmpfiles</span>(8)</span></a>. Set
        either value to 0 to turn off size based
        clean-up.</p></dd></dl></div></div><div class="refsect1"><a name="idm47534142099136"></a><h2 id="See Also">See Also<a class="headerlink" title="Permalink to this headline" href="#See%20Also">¶</a></h2><p>
      <a href="systemd-journald.service.html"><span class="citerefentry"><span class="refentrytitle">systemd-journald.service</span>(8)</span></a>,
      <a href="coredumpctl.html"><span class="citerefentry"><span class="refentrytitle">coredumpctl</span>(1)</span></a>,
      <a href="systemd-tmpfiles.html"><span class="citerefentry"><span class="refentrytitle">systemd-tmpfiles</span>(8)</span></a>
    </p></div></div></body></html>