coredump.conf(5) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | CONFIGURATION DIRECTORIES AND PRECEDENCE | OPTIONS | SEE ALSO | COLOPHON

COREDUMP.CONF(5)              coredump.conf             COREDUMP.CONF(5)

NAME         top

       coredump.conf, coredump.conf.d - Core dump storage configuration
       files

SYNOPSIS         top

       /etc/systemd/coredump.conf

       /etc/systemd/coredump.conf.d/*.conf

       /run/systemd/coredump.conf.d/*.conf

       /usr/lib/systemd/coredump.conf.d/*.conf

DESCRIPTION         top

       These files configure the behavior of systemd-coredump(8), a
       handler for core dumps invoked by the kernel. Whether
       systemd-coredump is used is determined by the kernel's
       kernel.core_pattern sysctl(8) setting. See systemd-coredump(8)
       and core(5) pages for the details.

CONFIGURATION DIRECTORIES AND PRECEDENCE         top

       The 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
       /etc/systemd/ contains commented out entries showing the defaults
       as a guide to the administrator. This file can be edited to
       create local overrides.

       When packages need to customize the configuration, they can
       install configuration snippets in /usr/lib/systemd/*.conf.d/ or
       /usr/local/lib/systemd/*.conf.d/. 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 *.conf.d/ configuration subdirectories are sorted by
       their filename in lexicographic order, regardless of in which of
       the subdirectories they reside. When multiple files specify the
       same option, for options which accept just a single value, the
       entry in the file with the lexicographically latest name takes
       precedence. For options which accept a list of values, entries
       are collected as they occur in files sorted lexicographically.

       Files in /etc/ are reserved for the local administrator, who may
       use this logic to override the configuration files installed by
       vendor packages. 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.

       To disable a configuration file supplied by the vendor, the
       recommended way is to place a symlink to /dev/null in the
       configuration directory in /etc/, with the same filename as the
       vendor configuration file.

OPTIONS         top

       All options are configured in the [Coredump] section:

       Storage=
           Controls where to store cores. One of "none", "external", and
           "journal". When "none", the core dumps may be logged
           (including the backtrace if possible), but not stored
           permanently. When "external" (the default), cores will be
           stored in /var/lib/systemd/coredump/. When "journal", cores
           will be stored in the journal and rotated following normal
           journal rotation patterns.

           When cores are stored in the journal, they might be
           compressed following journal compression settings, see
           journald.conf(5). When cores are stored externally, they will
           be compressed by default, see below.

       Compress=
           Controls compression for external storage. Takes a boolean
           argument, which defaults to "yes".

       ProcessSizeMax=
           The maximum size in bytes of a core which will be processed.
           Core dumps exceeding this size may be stored, but the
           backtrace will not be generated.

           Setting Storage=none and ProcessSizeMax=0 disables all
           coredump handling except for a log entry.

       ExternalSizeMax=, JournalSizeMax=
           The maximum (uncompressed) size in bytes of a core to be
           saved.

       MaxUse=, KeepFree=
           Enforce limits on the disk space taken up by externally
           stored core dumps.  MaxUse= makes sure that old core dumps
           are removed as soon as the total disk space taken up by core
           dumps grows beyond this limit (defaults to 10% of the total
           disk size).  KeepFree= 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 core dumps might temporarily
           exceed these limits while core dumps are processed. Note that
           old core dumps are also removed based on time via
           systemd-tmpfiles(8). Set either value to 0 to turn off
           size-based clean-up.

       The defaults for all values are listed as comments in the
       template /etc/systemd/coredump.conf file that is installed by
       default.

SEE ALSO         top

       systemd-journald.service(8), coredumpctl(1), systemd-tmpfiles(8)

COLOPHON         top

       This page is part of the systemd (systemd system and service
       manager) project.  Information about the project can be found at
       ⟨http://www.freedesktop.org/wiki/Software/systemd⟩.  If you have
       a bug report for this manual page, see
       ⟨http://www.freedesktop.org/wiki/Software/systemd/#bugreports⟩.
       This page was obtained from the project's upstream Git repository
       ⟨https://github.com/systemd/systemd.git⟩ on 2020-12-18.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2020-12-18.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

systemd 247                                             COREDUMP.CONF(5)

Pages that refer to this page: coredumpctl(1)systemd.directives(7)systemd.index(7)systemd-coredump(8)