[thirdparty/systemd.git] / man / journald.conf.xml

<?xml version='1.0'?> <!--*-nxml-*-->
<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
  This file is part of systemd.

  Copyright 2010 Lennart Poettering

  systemd is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->

<refentry id="journald.conf">
        <refentryinfo>
                <title>journald.conf</title>
                <productname>systemd</productname>

                <authorgroup>
                        <author>
                                <contrib>Developer</contrib>
                                <firstname>Lennart</firstname>
                                <surname>Poettering</surname>
                                <email>lennart@poettering.net</email>
                        </author>
                </authorgroup>
        </refentryinfo>

        <refmeta>
                <refentrytitle>journald.conf</refentrytitle>
                <manvolnum>5</manvolnum>
        </refmeta>

        <refnamediv>
                <refname>journald.conf</refname>
                <refpurpose>Journal service configuration file</refpurpose>
        </refnamediv>

        <refsynopsisdiv>
                <para><filename>/etc/systemd/journald.conf</filename></para>
        </refsynopsisdiv>

        <refsect1>
                <title>Description</title>

                <para>This files configures various parameters of the
                systemd journal service
                <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>

        </refsect1>

        <refsect1>
                <title>Options</title>

                <para>All options are configured in the
                <literal>[Journal]</literal> section:</para>

                <variablelist>

                        <varlistentry>
                                <term><varname>Compress=</varname></term>

                                <listitem><para>Takes a boolean
                                value. If enabled (the default) data
                                objects that shall be stored in the
                                journal and are larger than a certain
                                threshold are compressed with the XZ
                                compression algorithm before they are
                                written to the file
                                system.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>RateLimitInterval=</varname></term>
                                <term><varname>RateLimitBurst=</varname></term>

                                <listitem><para>Configures the rate
                                limiting that is applied to all
                                messages generated on the system. If
                                in the time interval defined by
                                <varname>RateLimitInterval=</varname>
                                more messages than specified in
                                <varname>RateLimitBurst=</varname> are
                                logged by a service all further
                                messages within the interval are
                                dropped, until the interval is over. A
                                message about the number of dropped
                                messages is generated. This rate
                                limiting is applied per-service, so
                                that two services which log do not
                                interfere with each other's
                                limit. Defaults to 100 messages in
                                10s. The time specification for
                                <varname>RateLimitInterval=</varname>
                                may be specified in the following
                                units: <literal>s</literal>,
                                <literal>min</literal>,
                                <literal>h</literal>,
                                <literal>ms</literal>,
                                <literal>us</literal>. To turn off any
                                kind of rate limiting, set either
                                value to 0.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>SystemMaxUse=</varname></term>
                                <term><varname>SystemKeepFree=</varname></term>
                                <term><varname>SystemMaxFileSize=</varname></term>
                                <term><varname>SystemMinFileSize=</varname></term>
                                <term><varname>RuntimeMaxUse=</varname></term>
                                <term><varname>RuntimeKeepFree=</varname></term>
                                <term><varname>RuntimeMaxFileSize=</varname></term>
                                <term><varname>RuntimeMinFileSize=</varname></term>

                                <listitem><para>Enforce size limits on
                                the journal files stored. The options
                                prefixed with
                                <literal>System</literal> apply to the
                                journal files when stored on a
                                persistent file system, more
                                specifically
                                <filename>/var/log/journal</filename>. The
                                options prefixed with
                                <literal>Runtime</literal> apply to
                                the journal files when stored on a
                                volatile in-memory file system, more
                                specifically
                                <filename>/run/log/journal</filename>. The
                                former is used only when
                                <filename>/var</filename> is mounted,
                                writable and the directory
                                <filename>/var/log/journal</filename>
                                exists. Otherwise only the latter
                                applies. Note that this means that
                                during early boot and if the
                                administrator disabled persistent
                                logging only the latter options apply,
                                while the former apply if persistent
                                logging is enabled and the system is
                                fully booted
                                up. <varname>SystemMaxUse=</varname>
                                and <varname>RuntimeMaxUse=</varname>
                                control how much disk space the
                                journal may use up at
                                maximum. Defaults to 10% of the size
                                of the respective file
                                system. <varname>SystemKeepFree=</varname>
                                and
                                <varname>RuntimeKeepFree=</varname>
                                control how much disk space the
                                journal shall always leave free for
                                other uses if less than the disk space
                                configured in
                                <varname>SystemMaxUse=</varname> and
                                <varname>RuntimeMaxUse=</varname> is
                                available. Defaults to 5% of the size
                                of the respective file
                                system. <varname>SystemMaxFileSize=</varname>
                                and
                                <varname>RuntimeMaxFileSize=</varname>
                                control how large individual journal
                                files may grow at maximum. This
                                influences the granularity in which
                                disk space is made available through
                                rotation, i.e. deletion of historic
                                data. Defaults to one eigth of the
                                values configured with
                                <varname>SystemMaxUse=</varname> and
                                <varname>RuntimeMaxUse=</varname>, so
                                that usually seven rotated journal
                                files are kept as
                                history. <varname>SystemMinFileSize=</varname>
                                and
                                <varname>RuntimeMinFileSize=</varname>
                                control how large individual journal
                                files grow at minimum. Defaults to
                                64K. Specify values in bytes or use
                                K, M, G, T, P, E as units for the
                                specified sizes. Note that size limits
                                are enforced synchronously to journal
                                files as they are extended, and need
                                no explicit rotation step triggered by
                                time.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>ForwardToSyslog=</varname></term>
                                <term><varname>ForwardToKMsg=</varname></term>
                                <term><varname>ForwardToConsole=</varname></term>

                                <listitem><para>Control whether log
                                messages received by the journal
                                daemon shall be forwarded to a
                                traditional syslog daemon, to the
                                kernel log buffer (kmsg), or to the
                                system console. These options take
                                boolean arguments. If forwarding to
                                syslog is enabled but no syslog daemon
                                is running the respective option has
                                no effect. By default only forwarding
                                to syslog is enabled. These settings
                                may be overridden at boot time with the
                                kernel command line options
                                <literal>systemd.journald.forward_to_syslog=</literal>,
                                <literal>systemd.journald.forward_to_kmsg=</literal>
                                and
                                <literal>systemd.journald.forward_to_console=</literal>. If
                                forwarding to the kernel log buffer and
                                <varname>ImportKernel=</varname> is
                                enabled at the same time care is taken
                                to avoid logging loops. It is safe to
                                use these options in combination.
                                </para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>MaxLevelStore=</varname></term>
                                <term><varname>MaxLevelSyslog=</varname></term>
                                <term><varname>MaxLevelKMsg=</varname></term>
                                <term><varname>MaxLevelConsole=</varname></term>

                                <listitem><para>Controls the maximum
                                log level of messages that are stored
                                on disk, forwarded to syslog, kmsg or
                                the console (if that is enabled, see
                                above). As argument, takes one of
                                <literal>emerg</literal>,
                                <literal>alert</literal>,
                                <literal>crit</literal>,
                                <literal>err</literal>,
                                <literal>warning</literal>,
                                <literal>notice</literal>,
                                <literal>info</literal>,
                                <literal>debug</literal> or integer
                                values in the range of 0..7 (corresponding
                                to the same levels). Messages equal or below
                                the log level specified are
                                stored/forwarded, messages above are
                                dropped. Defaults to
                                <literal>debug</literal> for
                                <varname>MaxLevelStore=</varname> and
                                <varname>MaxLevelSyslog=</varname>, to
                                ensure that the all messages are
                                written to disk and forwarded to
                                syslog. Defaults to
                                <literal>notice</literal> for
                                <varname>MaxLevelKMsg=</varname> and
                                <literal>info</literal> for
                                <varname>MaxLevelConsole=</varname>.</para></listitem>
                        </varlistentry>

                        <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>
Commit	Line	Data
b47ffcfd LP	1	<?xml version='1.0'?> <!---nxml--->
	2	<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
	3	<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
	4	"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
	5
	6	<!--
	7	This file is part of systemd.
	8
	9	Copyright 2010 Lennart Poettering
	10
	11	systemd is free software; you can redistribute it and/or modify it
5430f7f2 LP	12	under the terms of the GNU Lesser General Public License as published by
5430f7f2 LP	13	the Free Software Foundation; either version 2.1 of the License, or
b47ffcfd LP	14	(at your option) any later version.
	15
	16	systemd is distributed in the hope that it will be useful, but
	17	WITHOUT ANY WARRANTY; without even the implied warranty of
	18	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5430f7f2	19	Lesser General Public License for more details.
b47ffcfd	20
5430f7f2	21	You should have received a copy of the GNU Lesser General Public License
b47ffcfd LP	22	along with systemd; If not, see <http://www.gnu.org/licenses/>.
	23	-->
	24
18b754d3	25	<refentry id="journald.conf">
b47ffcfd	26	<refentryinfo>
18b754d3	27	<title>journald.conf</title>
b47ffcfd LP	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>
18b754d3	41	<refentrytitle>journald.conf</refentrytitle>
b47ffcfd LP	42	<manvolnum>5</manvolnum>
	43	</refmeta>
	44
	45	<refnamediv>
18b754d3	46	<refname>journald.conf</refname>
b47ffcfd LP	47	<refpurpose>Journal service configuration file</refpurpose>
	48	</refnamediv>
	49
	50	<refsynopsisdiv>
01cf0ca8	51	<para><filename>/etc/systemd/journald.conf</filename></para>
b47ffcfd LP	52	</refsynopsisdiv>
	53
	54	<refsect1>
	55	<title>Description</title>
	56
01cf0ca8 LP	57	<para>This files configures various parameters of the
	58	systemd journal service
	59	<citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
b47ffcfd LP	60
	61	</refsect1>
	62
	63	<refsect1>
	64	<title>Options</title>
	65
	66	<para>All options are configured in the
	67	<literal>[Journal]</literal> section:</para>
	68
	69	<variablelist>
	70
	71	<varlistentry>
	72	<term><varname>Compress=</varname></term>
	73
	74	<listitem><para>Takes a boolean
	75	value. If enabled (the default) data
	76	objects that shall be stored in the
	77	journal and are larger than a certain
	78	threshold are compressed with the XZ
	79	compression algorithm before they are
	80	written to the file
	81	system.</para></listitem>
	82	</varlistentry>
	83
	84	<varlistentry>
	85	<term><varname>RateLimitInterval=</varname></term>
	86	<term><varname>RateLimitBurst=</varname></term>
	87
	88	<listitem><para>Configures the rate
	89	limiting that is applied to all
	90	messages generated on the system. If
	91	in the time interval defined by
	92	<varname>RateLimitInterval=</varname>
	93	more messages than specified in
	94	<varname>RateLimitBurst=</varname> are
	95	logged by a service all further
	96	messages within the interval are
	97	dropped, until the interval is over. A
	98	message about the number of dropped
	99	messages is generated. This rate
	100	limiting is applied per-service, so
	101	that two services which log do not
	102	interfere with each other's
	103	limit. Defaults to 100 messages in
	104	10s. The time specification for
	105	<varname>RateLimitInterval=</varname>
	106	may be specified in the following
	107	units: <literal>s</literal>,
	108	<literal>min</literal>,
	109	<literal>h</literal>,
	110	<literal>ms</literal>,
	111	<literal>us</literal>. To turn off any
	112	kind of rate limiting, set either
	113	value to 0.</para></listitem>
	114	</varlistentry>
	115
	116	<varlistentry>
	117	<term><varname>SystemMaxUse=</varname></term>
	118	<term><varname>SystemKeepFree=</varname></term>
	119	<term><varname>SystemMaxFileSize=</varname></term>
	120	<term><varname>SystemMinFileSize=</varname></term>
	121	<term><varname>RuntimeMaxUse=</varname></term>
	122	<term><varname>RuntimeKeepFree=</varname></term>
	123	<term><varname>RuntimeMaxFileSize=</varname></term>
124	<term><varname>RuntimeMinFileSize=</varname></term>
125
126	<listitem><para>Enforce size limits on
127	the journal files stored. The options
128	prefixed with
129	<literal>System</literal> apply to the
130	journal files when stored on a
3ab1e259	131	persistent file system, more
b47ffcfd LP	132	specifically
	133	<filename>/var/log/journal</filename>. The
	134	options prefixed with
	135	<literal>Runtime</literal> apply to
	136	the journal files when stored on a
	137	volatile in-memory file system, more
	138	specifically
	139	<filename>/run/log/journal</filename>. The
	140	former is used only when
	141	<filename>/var</filename> is mounted,
	142	writable and the directory
	143	<filename>/var/log/journal</filename>
	144	exists. Otherwise only the latter
	145	applies. Note that this means that
	146	during early boot and if the
3ab1e259	147	administrator disabled persistent
b47ffcfd	148	logging only the latter options apply,
3ab1e259	149	while the former apply if persistent
b47ffcfd LP	150	logging is enabled and the system is
	151	fully booted
	152	up. <varname>SystemMaxUse=</varname>
	153	and <varname>RuntimeMaxUse=</varname>
	154	control how much disk space the
	155	journal may use up at
	156	maximum. Defaults to 10% of the size
	157	of the respective file
	158	system. <varname>SystemKeepFree=</varname>
	159	and
	160	<varname>RuntimeKeepFree=</varname>
	161	control how much disk space the
	162	journal shall always leave free for
	163	other uses if less than the disk space
	164	configured in
	165	<varname>SystemMaxUse=</varname> and
	166	<varname>RuntimeMaxUse=</varname> is
	167	available. Defaults to 5% of the size
	168	of the respective file
	169	system. <varname>SystemMaxFileSize=</varname>
	170	and
	171	<varname>RuntimeMaxFileSize=</varname>
	172	control how large individual journal
	173	files may grow at maximum. This
	174	influences the granularity in which
	175	disk space is made available through
	176	rotation, i.e. deletion of historic
	177	data. Defaults to one eigth of the
	178	values configured with
	179	<varname>SystemMaxUse=</varname> and
	180	<varname>RuntimeMaxUse=</varname>, so
	181	that usually seven rotated journal
	182	files are kept as
	183	history. <varname>SystemMinFileSize=</varname>
	184	and
	185	<varname>RuntimeMinFileSize=</varname>
	186	control how large individual journal
	187	files grow at minimum. Defaults to
	188	64K. Specify values in bytes or use
	189	K, M, G, T, P, E as units for the
	190	specified sizes. Note that size limits
	191	are enforced synchronously to journal
	192	files as they are extended, and need
	193	no explicit rotation step triggered by
	194	time.</para></listitem>
	195	</varlistentry>
	196
	197	<varlistentry>
	198	<term><varname>ForwardToSyslog=</varname></term>
	199	<term><varname>ForwardToKMsg=</varname></term>
	200	<term><varname>ForwardToConsole=</varname></term>
	201
	202	<listitem><para>Control whether log
	203	messages received by the journal
	204	daemon shall be forwarded to a
	205	traditional syslog daemon, to the
	206	kernel log buffer (kmsg), or to the
	207	system console. These options take
	208	boolean arguments. If forwarding to
	209	syslog is enabled but no syslog daemon
	210	is running the respective option has
	211	no effect. By default only forwarding
	212	to syslog is enabled. These settings
386da858	213	may be overridden at boot time with the
b47ffcfd	214	kernel command line options
c66e7bc7 LP	215	<literal>systemd.journald.forward_to_syslog=</literal>,
c66e7bc7 LP	216	<literal>systemd.journald.forward_to_kmsg=</literal>
b47ffcfd	217	and
c66e7bc7	218	<literal>systemd.journald.forward_to_console=</literal>. If
b47ffcfd LP	219	forwarding to the kernel log buffer and
	220	<varname>ImportKernel=</varname> is
	221	enabled at the same time care is taken
	222	to avoid logging loops. It is safe to
	223	use these options in combination.
	224	</para></listitem>
	225	</varlistentry>
	226
213ba152 LP	227	<varlistentry>
	228	<term><varname>MaxLevelStore=</varname></term>
	229	<term><varname>MaxLevelSyslog=</varname></term>
	230	<term><varname>MaxLevelKMsg=</varname></term>
	231	<term><varname>MaxLevelConsole=</varname></term>
	232
	233	<listitem><para>Controls the maximum
	234	log level of messages that are stored
	235	on disk, forwarded to syslog, kmsg or
	236	the console (if that is enabled, see
	237	above). As argument, takes one of
	238	<literal>emerg</literal>,
	239	<literal>alert</literal>,
	240	<literal>crit</literal>,
	241	<literal>err</literal>,
	242	<literal>warning</literal>,
	243	<literal>notice</literal>,
	244	<literal>info</literal>,
	245	<literal>debug</literal> or integer
	246	values in the range of 0..7 (corresponding
	247	to the same levels). Messages equal or below
	248	the log level specified are
	249	stored/forwarded, messages above are
	250	dropped. Defaults to
	251	<literal>debug</literal> for
	252	<varname>MaxLevelStore=</varname> and
	253	<varname>MaxLevelSyslog=</varname>, to
	254	ensure that the all messages are
	255	written to disk and forwarded to
	256	syslog. Defaults to
	257	<literal>notice</literal> for
	258	<varname>MaxLevelKMsg=</varname> and
	259	<literal>info</literal> for
	260	<varname>MaxLevelConsole=</varname>.</para></listitem>
	261	</varlistentry>
	262
0d9243f0 LP	263	<varlistentry>
	264	<term><varname>TTYPath=</varname></term>
	265
	266	<listitem><para>Change the console TTY
	267	to use if
	268	<varname>ForwardToConsole=yes</varname>
	269	is used. Defaults to
	270	<filename>/dev/console</filename>.</para></listitem>
	271	</varlistentry>
	272
b47ffcfd LP	273	<varlistentry>
	274	<term><varname>ImportKernel=</varname></term>
	275
	276	<listitem><para>Controls whether
	277	kernel log messages shall be stored in
	278	the journal. Takes a boolean argument
	279	and defaults to enabled. Note that
	280	currently only one userspace service
	281	can read kernel messages at a time,
	282	which means that kernel log message
	283	reading might get corrupted if it
	284	is enabled in more than one service,
	285	for example in both the journal and a
	286	traditional syslog service.
	287	</para></listitem>
	288	</varlistentry>
	289	</variablelist>
	290
	291	</refsect1>
	292
	293	<refsect1>
	294	<title>See Also</title>
	295	<para>
	296	<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
01cf0ca8	297	<citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
169c4f65	298	<citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
ffa16db0	299	<citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
b47ffcfd LP	300	<citerefentry><refentrytitle>systemd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
	301	</para>
	302	</refsect1>
	303
	304	</refentry>