journald.conf.xml revision c66e7bc7a19c068ca1c414f2f8bd5dc13c20907f
5065N/A<?xml version='1.0'?> <!--*-nxml-*-->
5065N/A<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
5065N/A<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
5065N/A "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
5065N/A
5065N/A<!--
5065N/A This file is part of systemd.
5065N/A
5065N/A Copyright 2010 Lennart Poettering
5065N/A
6982N/A systemd is free software; you can redistribute it and/or modify it
6982N/A under the terms of the GNU Lesser General Public License as published by
5065N/A the Free Software Foundation; either version 2.1 of the License, or
5065N/A (at your option) any later version.
5065N/A
5065N/A systemd is distributed in the hope that it will be useful, but
6982N/A WITHOUT ANY WARRANTY; without even the implied warranty of
6982N/A MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
6982N/A Lesser General Public License for more details.
6982N/A
5065N/A You should have received a copy of the GNU Lesser General Public License
5065N/A along with systemd; If not, see <http://www.gnu.org/licenses/>.
5065N/A-->
5065N/A
5065N/A<refentry id="journald.conf">
5065N/A <refentryinfo>
5065N/A <title>journald.conf</title>
5065N/A <productname>systemd</productname>
5065N/A
5065N/A <authorgroup>
5065N/A <author>
5065N/A <contrib>Developer</contrib>
5065N/A <firstname>Lennart</firstname>
5065N/A <surname>Poettering</surname>
5065N/A <email>lennart@poettering.net</email>
5065N/A </author>
5065N/A </authorgroup>
5065N/A </refentryinfo>
5065N/A
5065N/A <refmeta>
5065N/A <refentrytitle>journald.conf</refentrytitle>
5065N/A <manvolnum>5</manvolnum>
5065N/A </refmeta>
5065N/A
5065N/A <refnamediv>
5065N/A <refname>journald.conf</refname>
5065N/A <refpurpose>Journal service configuration file</refpurpose>
5065N/A </refnamediv>
5065N/A
5065N/A <refsynopsisdiv>
5065N/A <para><filename>/etc/systemd/journald.conf</filename></para>
5065N/A </refsynopsisdiv>
5065N/A
5065N/A <refsect1>
5065N/A <title>Description</title>
5065N/A
5065N/A <para>This files configures various parameters of the
5065N/A systemd journal service
5065N/A <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
5065N/A
5065N/A </refsect1>
5065N/A
5065N/A <refsect1>
5065N/A <title>Options</title>
5065N/A
5065N/A <para>All options are configured in the
5065N/A <literal>[Journal]</literal> section:</para>
5065N/A
5065N/A <variablelist>
5065N/A
5065N/A <varlistentry>
5065N/A <term><varname>Compress=</varname></term>
5065N/A
5065N/A <listitem><para>Takes a boolean
5065N/A value. If enabled (the default) data
5065N/A objects that shall be stored in the
5065N/A journal and are larger than a certain
5065N/A threshold are compressed with the XZ
5065N/A compression algorithm before they are
5065N/A written to the file
5065N/A system.</para></listitem>
5065N/A </varlistentry>
5065N/A
5065N/A <varlistentry>
5065N/A <term><varname>RateLimitInterval=</varname></term>
5065N/A <term><varname>RateLimitBurst=</varname></term>
5065N/A
5065N/A <listitem><para>Configures the rate
5065N/A limiting that is applied to all
5065N/A messages generated on the system. If
5065N/A in the time interval defined by
5065N/A <varname>RateLimitInterval=</varname>
5065N/A more messages than specified in
5065N/A <varname>RateLimitBurst=</varname> are
5065N/A logged by a service all further
5065N/A messages within the interval are
5065N/A dropped, until the interval is over. A
5065N/A message about the number of dropped
5065N/A messages is generated. This rate
5065N/A limiting is applied per-service, so
5065N/A that two services which log do not
5065N/A interfere with each other's
5065N/A limit. Defaults to 100 messages in
5065N/A 10s. The time specification for
5065N/A <varname>RateLimitInterval=</varname>
5065N/A may be specified in the following
5065N/A units: <literal>s</literal>,
5065N/A <literal>min</literal>,
5065N/A <literal>h</literal>,
5065N/A <literal>ms</literal>,
5065N/A <literal>us</literal>. To turn off any
5065N/A kind of rate limiting, set either
5065N/A value to 0.</para></listitem>
5065N/A </varlistentry>
5065N/A
5065N/A <varlistentry>
5065N/A <term><varname>SystemMaxUse=</varname></term>
5065N/A <term><varname>SystemKeepFree=</varname></term>
5065N/A <term><varname>SystemMaxFileSize=</varname></term>
5065N/A <term><varname>SystemMinFileSize=</varname></term>
5065N/A <term><varname>RuntimeMaxUse=</varname></term>
5065N/A <term><varname>RuntimeKeepFree=</varname></term>
5065N/A <term><varname>RuntimeMaxFileSize=</varname></term>
5065N/A <term><varname>RuntimeMinFileSize=</varname></term>
5065N/A
5065N/A <listitem><para>Enforce size limits on
5065N/A the journal files stored. The options
5065N/A prefixed with
5065N/A <literal>System</literal> apply to the
5065N/A journal files when stored on a
5065N/A persistent file system, more
5065N/A specifically
5065N/A <filename>/var/log/journal</filename>. The
5065N/A options prefixed with
5065N/A <literal>Runtime</literal> apply to
5065N/A the journal files when stored on a
5065N/A volatile in-memory file system, more
5065N/A specifically
5065N/A <filename>/run/log/journal</filename>. The
5065N/A former is used only when
5065N/A <filename>/var</filename> is mounted,
5065N/A writable and the directory
5065N/A <filename>/var/log/journal</filename>
5065N/A exists. Otherwise only the latter
5065N/A applies. Note that this means that
5065N/A during early boot and if the
5065N/A administrator disabled persistent
5065N/A logging only the latter options apply,
5065N/A while the former apply if persistent
5065N/A logging is enabled and the system is
5065N/A fully booted
5065N/A up. <varname>SystemMaxUse=</varname>
5065N/A and <varname>RuntimeMaxUse=</varname>
5065N/A control how much disk space the
5065N/A journal may use up at
5065N/A maximum. Defaults to 10% of the size
5065N/A of the respective file
5065N/A system. <varname>SystemKeepFree=</varname>
5065N/A and
5065N/A <varname>RuntimeKeepFree=</varname>
5065N/A control how much disk space the
5065N/A journal shall always leave free for
5065N/A other uses if less than the disk space
5065N/A configured in
5065N/A <varname>SystemMaxUse=</varname> and
5065N/A <varname>RuntimeMaxUse=</varname> is
5065N/A available. Defaults to 5% of the size
5065N/A of the respective file
5065N/A system. <varname>SystemMaxFileSize=</varname>
5065N/A and
5065N/A <varname>RuntimeMaxFileSize=</varname>
5065N/A control how large individual journal
5065N/A files may grow at maximum. This
5065N/A influences the granularity in which
5065N/A disk space is made available through
5065N/A rotation, i.e. deletion of historic
5065N/A data. Defaults to one eigth of the
5065N/A values configured with
5065N/A <varname>SystemMaxUse=</varname> and
5065N/A <varname>RuntimeMaxUse=</varname>, so
5065N/A that usually seven rotated journal
5065N/A files are kept as
5065N/A history. <varname>SystemMinFileSize=</varname>
5065N/A and
5065N/A <varname>RuntimeMinFileSize=</varname>
5065N/A control how large individual journal
5065N/A files grow at minimum. Defaults to
5065N/A 64K. Specify values in bytes or use
5065N/A K, M, G, T, P, E as units for the
5065N/A specified sizes. Note that size limits
5065N/A are enforced synchronously to journal
5065N/A files as they are extended, and need
5065N/A no explicit rotation step triggered by
5065N/A time.</para></listitem>
5065N/A </varlistentry>
5065N/A
5065N/A <varlistentry>
5065N/A <term><varname>ForwardToSyslog=</varname></term>
5065N/A <term><varname>ForwardToKMsg=</varname></term>
5065N/A <term><varname>ForwardToConsole=</varname></term>
5065N/A
5065N/A <listitem><para>Control whether log
5065N/A messages received by the journal
5065N/A daemon shall be forwarded to a
5065N/A traditional syslog daemon, to the
5065N/A kernel log buffer (kmsg), or to the
5065N/A system console. These options take
5065N/A boolean arguments. If forwarding to
5065N/A syslog is enabled but no syslog daemon
5065N/A is running the respective option has
5065N/A no effect. By default only forwarding
5065N/A to syslog is enabled. These settings
5065N/A may be overridden at boot time with the
5065N/A kernel command line options
5065N/A <literal>systemd.journald.forward_to_syslog=</literal>,
5065N/A <literal>systemd.journald.forward_to_kmsg=</literal>
5065N/A and
5065N/A <literal>systemd.journald.forward_to_console=</literal>. If
5065N/A forwarding to the kernel log buffer and
5065N/A <varname>ImportKernel=</varname> is
5065N/A enabled at the same time care is taken
5065N/A to avoid logging loops. It is safe to
5065N/A use these options in combination.
5065N/A </para></listitem>
5065N/A </varlistentry>
5065N/A
5065N/A <varlistentry>
5065N/A <term><varname>MaxLevelStore=</varname></term>
5065N/A <term><varname>MaxLevelSyslog=</varname></term>
5065N/A <term><varname>MaxLevelKMsg=</varname></term>
5065N/A <term><varname>MaxLevelConsole=</varname></term>
5065N/A
5065N/A <listitem><para>Controls the maximum
5065N/A log level of messages that are stored
5065N/A on disk, forwarded to syslog, kmsg or
5065N/A the console (if that is enabled, see
5065N/A above). As argument, takes one of
5065N/A <literal>emerg</literal>,
5065N/A <literal>alert</literal>,
5065N/A <literal>crit</literal>,
5065N/A <literal>err</literal>,
5065N/A <literal>warning</literal>,
5065N/A <literal>notice</literal>,
5065N/A <literal>info</literal>,
5065N/A <literal>debug</literal> or integer
5065N/A values in the range of 0..7 (corresponding
5065N/A to the same levels). Messages equal or below
5065N/A the log level specified are
5065N/A stored/forwarded, messages above are
5065N/A dropped. Defaults to
5065N/A <literal>debug</literal> for
5065N/A <varname>MaxLevelStore=</varname> and
5065N/A <varname>MaxLevelSyslog=</varname>, to
5065N/A ensure that the all messages are
5065N/A written to disk and forwarded to
5065N/A syslog. Defaults to
5065N/A <literal>notice</literal> for
5065N/A <varname>MaxLevelKMsg=</varname> and
5065N/A <literal>info</literal> for
5065N/A <varname>MaxLevelConsole=</varname>.</para></listitem>
5065N/A </varlistentry>
5065N/A
5065N/A <varlistentry>
<term><varname>TTYPath=</varname></term>
<listitem><para>Change the console TTY
to use if
<varname>ForwardToConsole=yes</varname>
is used. Defaults to
<filename>/dev/console</filename>.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>ImportKernel=</varname></term>
<listitem><para>Controls whether
kernel log messages shall be stored in
the journal. Takes a boolean argument
and defaults to enabled. Note that
currently only one userspace service
can read kernel messages at a time,
which means that kernel log message
reading might get corrupted if it
is enabled in more than one service,
for example in both the journal and a
traditional syslog service.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>