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">
7 This file is part of systemd.
9 Copyright 2010 Lennart Poettering
11 systemd is free software; you can redistribute it and/or modify it
12 under the terms of the GNU Lesser General Public License as published by
13 the Free Software Foundation; either version 2.1 of the License, or
14 (at your option) any later version.
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
19 Lesser General Public License for more details.
21 You should have received a copy of the GNU Lesser General Public License
22 along with systemd; If not, see <http://www.gnu.org/licenses/>.
25 <refentry id="journald.conf">
27 <title>journald.conf</title>
28 <productname>systemd</productname>
32 <contrib>Developer</contrib>
33 <firstname>Lennart</firstname>
34 <surname>Poettering</surname>
35 <email>lennart@poettering.net</email>
41 <refentrytitle>journald.conf</refentrytitle>
42 <manvolnum>5</manvolnum>
46 <refname>journald.conf</refname>
47 <refpurpose>Journal service configuration file</refpurpose>
51 <para><filename>/etc/systemd/journald.conf</filename></para>
55 <title>Description</title>
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>
64 <title>Options</title>
66 <para>All options are configured in the
67 <literal>[Journal]</literal> section:</para>
72 <term><varname>Storage=</varname></term>
74 <listitem><para>Controls where to
75 store journal data. One of
76 <literal>volatile</literal>,
77 <literal>persistent</literal>,
78 <literal>auto</literal> and
79 <literal>none</literal>. If
80 <literal>volatile</literal> journal
81 log data will be stored only in
82 memory, i.e. below the
83 <filename>/run/log/journal</filename>
84 hierarchy (which is created if
86 <literal>persistent</literal> data will
87 be stored preferably on disk,
89 <filename>/var/log/journal</filename>
90 hierarchy (which is created if
91 needed), with a fallback to
92 <filename>/run/log/journal</filename>
93 (which is created if needed), during
94 early boot and if the disk is not
95 writable. <literal>auto</literal> is
97 <literal>persistent</literal> but the
99 <filename>/var/log/journal</filename>
100 is not created if needed, so that its
101 existence controls where log data
102 goes. <literal>none</literal> turns
103 off all storage, all log data received
104 will be dropped. Forwarding to other
105 targets, such as the console, the
106 kernel log buffer or a syslog daemon
107 will still work however. Defaults to
108 <literal>auto</literal>.</para></listitem>
112 <term><varname>Compress=</varname></term>
114 <listitem><para>Takes a boolean
115 value. If enabled (the default) data
116 objects that shall be stored in the
117 journal and are larger than a certain
118 threshold are compressed with the XZ
119 compression algorithm before they are
121 system.</para></listitem>
125 <term><varname>Seal=</varname></term>
127 <listitem><para>Takes a boolean
128 value. If enabled (the default) and a
129 sealing key is available (as created
131 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
132 <option>--setup-keys</option>
133 command), forward secure sealing (FSS) for
134 all persistent journal files is
135 enabled.</para></listitem>
139 <term><varname>RateLimitInterval=</varname></term>
140 <term><varname>RateLimitBurst=</varname></term>
142 <listitem><para>Configures the rate
143 limiting that is applied to all
144 messages generated on the system. If
145 in the time interval defined by
146 <varname>RateLimitInterval=</varname>
147 more messages than specified in
148 <varname>RateLimitBurst=</varname> are
149 logged by a service all further
150 messages within the interval are
151 dropped, until the interval is over. A
152 message about the number of dropped
153 messages is generated. This rate
154 limiting is applied per-service, so
155 that two services which log do not
156 interfere with each other's
157 limit. Defaults to 100 messages in
158 10s. The time specification for
159 <varname>RateLimitInterval=</varname>
160 may be specified in the following
161 units: <literal>s</literal>,
162 <literal>min</literal>,
163 <literal>h</literal>,
164 <literal>ms</literal>,
165 <literal>us</literal>. To turn off any
166 kind of rate limiting, set either
167 value to 0.</para></listitem>
171 <term><varname>SystemMaxUse=</varname></term>
172 <term><varname>SystemKeepFree=</varname></term>
173 <term><varname>SystemMaxFileSize=</varname></term>
174 <term><varname>SystemMinFileSize=</varname></term>
175 <term><varname>RuntimeMaxUse=</varname></term>
176 <term><varname>RuntimeKeepFree=</varname></term>
177 <term><varname>RuntimeMaxFileSize=</varname></term>
178 <term><varname>RuntimeMinFileSize=</varname></term>
180 <listitem><para>Enforce size limits on
181 the journal files stored. The options
183 <literal>System</literal> apply to the
184 journal files when stored on a
185 persistent file system, more
187 <filename>/var/log/journal</filename>. The
188 options prefixed with
189 <literal>Runtime</literal> apply to
190 the journal files when stored on a
191 volatile in-memory file system, more
193 <filename>/run/log/journal</filename>. The
194 former is used only when
195 <filename>/var</filename> is mounted,
196 writable and the directory
197 <filename>/var/log/journal</filename>
198 exists. Otherwise only the latter
199 applies. Note that this means that
200 during early boot and if the
201 administrator disabled persistent
202 logging only the latter options apply,
203 while the former apply if persistent
204 logging is enabled and the system is
206 up. <varname>SystemMaxUse=</varname>
207 and <varname>RuntimeMaxUse=</varname>
208 control how much disk space the
209 journal may use up at
210 maximum. Defaults to 10% of the size
211 of the respective file
212 system. <varname>SystemKeepFree=</varname>
214 <varname>RuntimeKeepFree=</varname>
215 control how much disk space the
216 journal shall always leave free for
217 other uses if less than the disk space
219 <varname>SystemMaxUse=</varname> and
220 <varname>RuntimeMaxUse=</varname> is
221 available. Defaults to 5% of the size
222 of the respective file
223 system. <varname>SystemMaxFileSize=</varname>
225 <varname>RuntimeMaxFileSize=</varname>
226 control how large individual journal
227 files may grow at maximum. This
228 influences the granularity in which
229 disk space is made available through
230 rotation, i.e. deletion of historic
231 data. Defaults to one eighth of the
232 values configured with
233 <varname>SystemMaxUse=</varname> and
234 <varname>RuntimeMaxUse=</varname>, so
235 that usually seven rotated journal
237 history. <varname>SystemMinFileSize=</varname>
239 <varname>RuntimeMinFileSize=</varname>
240 control how large individual journal
241 files grow at minimum. Defaults to
242 64K. Specify values in bytes or use
243 K, M, G, T, P, E as units for the
244 specified sizes. Note that size limits
245 are enforced synchronously to journal
246 files as they are extended, and need
247 no explicit rotation step triggered by
248 time.</para></listitem>
252 <term><varname>ForwardToSyslog=</varname></term>
253 <term><varname>ForwardToKMsg=</varname></term>
254 <term><varname>ForwardToConsole=</varname></term>
256 <listitem><para>Control whether log
257 messages received by the journal
258 daemon shall be forwarded to a
259 traditional syslog daemon, to the
260 kernel log buffer (kmsg), or to the
261 system console. These options take
262 boolean arguments. If forwarding to
263 syslog is enabled but no syslog daemon
264 is running the respective option has
265 no effect. By default only forwarding
266 to syslog is enabled. These settings
267 may be overridden at boot time with
268 the kernel command line options
269 <literal>systemd.journald.forward_to_syslog=</literal>,
270 <literal>systemd.journald.forward_to_kmsg=</literal>
272 <literal>systemd.journald.forward_to_console=</literal>.
277 <term><varname>MaxLevelStore=</varname></term>
278 <term><varname>MaxLevelSyslog=</varname></term>
279 <term><varname>MaxLevelKMsg=</varname></term>
280 <term><varname>MaxLevelConsole=</varname></term>
282 <listitem><para>Controls the maximum
283 log level of messages that are stored
284 on disk, forwarded to syslog, kmsg or
285 the console (if that is enabled, see
286 above). As argument, takes one of
287 <literal>emerg</literal>,
288 <literal>alert</literal>,
289 <literal>crit</literal>,
290 <literal>err</literal>,
291 <literal>warning</literal>,
292 <literal>notice</literal>,
293 <literal>info</literal>,
294 <literal>debug</literal> or integer
295 values in the range of 0..7 (corresponding
296 to the same levels). Messages equal or below
297 the log level specified are
298 stored/forwarded, messages above are
300 <literal>debug</literal> for
301 <varname>MaxLevelStore=</varname> and
302 <varname>MaxLevelSyslog=</varname>, to
303 ensure that the all messages are
304 written to disk and forwarded to
306 <literal>notice</literal> for
307 <varname>MaxLevelKMsg=</varname> and
308 <literal>info</literal> for
309 <varname>MaxLevelConsole=</varname>.</para></listitem>
313 <term><varname>TTYPath=</varname></term>
315 <listitem><para>Change the console TTY
317 <varname>ForwardToConsole=yes</varname>
319 <filename>/dev/console</filename>.</para></listitem>
327 <title>See Also</title>
329 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
330 <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
331 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
332 <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
333 <citerefentry><refentrytitle>systemd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>