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 file 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)
134 for all persistent journal files is
135 enabled. FSS is based on <ulink
136 url="http://eprint.iacr.org/2013/397">Seekable
137 Sequential Key Generators</ulink> by
138 G. A. Marson and B. Poettering and
139 may be used to protect journal files
141 alteration.</para></listitem>
145 <term><varname>SplitMode=</varname></term>
147 <listitem><para>Controls whether to
148 split up journal files per user. One
149 of <literal>login</literal>,
150 <literal>uid</literal> and
151 <literal>none</literal>. If
152 <literal>login</literal>, each logged-in
153 user will get his own journal
154 files, but systemd user IDs will log
155 into the system journal. If
156 <literal>uid</literal>, any user ID
157 will get his own journal files
158 regardless whether it belongs to a
159 system service or refers to a real
161 <literal>none</literal>, journal files
162 are not split up by user and all
163 messages are instead stored in the single
164 system journal. Note that splitting
165 up journal files by user is only
166 available for journals stored
167 persistently. If journals are stored
168 on volatile storage (see above), only a
169 single journal file for all user IDs
171 <literal>login</literal>.</para></listitem>
175 <term><varname>RateLimitInterval=</varname></term>
176 <term><varname>RateLimitBurst=</varname></term>
178 <listitem><para>Configures the rate
179 limiting that is applied to all
180 messages generated on the system. If,
181 in the time interval defined by
182 <varname>RateLimitInterval=</varname>,
183 more messages than specified in
184 <varname>RateLimitBurst=</varname> are
185 logged by a service, all further
186 messages within the interval are
187 dropped until the interval is over. A
188 message about the number of dropped
189 messages is generated. This rate
190 limiting is applied per-service, so
191 that two services which log do not
192 interfere with each other's
193 limits. Defaults to 200 messages in
194 10s. The time specification for
195 <varname>RateLimitInterval=</varname>
196 may be specified in the following
197 units: <literal>s</literal>,
198 <literal>min</literal>,
199 <literal>h</literal>,
200 <literal>ms</literal>,
201 <literal>us</literal>. To turn off any
202 kind of rate limiting, set either
203 value to 0.</para></listitem>
207 <term><varname>SystemMaxUse=</varname></term>
208 <term><varname>SystemKeepFree=</varname></term>
209 <term><varname>SystemMaxFileSize=</varname></term>
210 <term><varname>RuntimeMaxUse=</varname></term>
211 <term><varname>RuntimeKeepFree=</varname></term>
212 <term><varname>RuntimeMaxFileSize=</varname></term>
214 <listitem><para>Enforce size limits on
215 the journal files stored. The options
217 <literal>System</literal> apply to the
218 journal files when stored on a
219 persistent file system, more
221 <filename>/var/log/journal</filename>. The
222 options prefixed with
223 <literal>Runtime</literal> apply to
224 the journal files when stored on a
225 volatile in-memory file system, more
227 <filename>/run/log/journal</filename>. The
228 former is used only when
229 <filename>/var</filename> is mounted,
230 writable, and the directory
231 <filename>/var/log/journal</filename>
232 exists. Otherwise, only the latter
233 applies. Note that this means that
234 during early boot and if the
235 administrator disabled persistent
236 logging, only the latter options apply,
237 while the former apply if persistent
238 logging is enabled and the system is
240 up. <command>journalctl</command> and
241 <command>systemd-journald</command>
242 ignore all files with names not ending
243 with <literal>.journal</literal> or
244 <literal>.journal~</literal>, so only
245 such files, located in the appropriate
246 directories, are taken into account
247 when calculating current disk usage.
250 <para><varname>SystemMaxUse=</varname>
251 and <varname>RuntimeMaxUse=</varname>
252 control how much disk space the
253 journal may use up at
254 maximum. Defaults to 10% of the size
255 of the respective file
256 system. <varname>SystemKeepFree=</varname>
258 <varname>RuntimeKeepFree=</varname>
259 control how much disk space the
260 journal shall always leave free for
261 other uses if less than the disk space
263 <varname>SystemMaxUse=</varname> and
264 <varname>RuntimeMaxUse=</varname> is
265 available. Defaults to 15% of the size
266 of the respective file
267 system. <varname>SystemMaxFileSize=</varname>
269 <varname>RuntimeMaxFileSize=</varname>
270 control how large individual journal
271 files may grow at maximum. This
272 influences the granularity in which
273 disk space is made available through
274 rotation, i.e. deletion of historic
275 data. Defaults to one eighth of the
276 values configured with
277 <varname>SystemMaxUse=</varname> and
278 <varname>RuntimeMaxUse=</varname>, so
279 that usually seven rotated journal
280 files are kept as history. Specify
281 values in bytes or use K, M, G, T, P,
282 E as units for the specified sizes
283 (equal to 1024, 1024²,... bytes).
284 Note that size limits are enforced
285 synchronously when journal files
286 are extended, and no explicit
287 rotation step triggered by
288 time is needed.</para></listitem>
292 <term><varname>MaxFileSec=</varname></term>
294 <listitem><para>The maximum time to
295 store entries in a single journal
296 file before rotating to the next
297 one. Normally, time-based rotation
298 should not be required as size-based
299 rotation with options such as
300 <varname>SystemMaxFileSize=</varname>
301 should be sufficient to ensure that
302 journal files do not grow without
303 bounds. However, to ensure that not
304 too much data is lost at once when old
305 journal files are deleted, it might
306 make sense to change this value from
307 the default of one month. Set to 0 to
308 turn off this feature. This setting
309 takes time values which may be
310 suffixed with the units
311 <literal>year</literal>,
312 <literal>month</literal>,
313 <literal>week</literal>, <literal>day</literal>,
314 <literal>h</literal> or <literal>m</literal>
315 to override the default time unit of
316 seconds.</para></listitem>
320 <term><varname>MaxRetentionSec=</varname></term>
322 <listitem><para>The maximum time to
323 store journal entries. This
324 controls whether journal files
325 containing entries older then the
326 specified time span are
327 deleted. Normally, time-based deletion
328 of old journal files should not be
329 required as size-based deletion with
331 <varname>SystemMaxUse=</varname>
332 should be sufficient to ensure that
333 journal files do not grow without
334 bounds. However, to enforce data
335 retention policies, it might make sense
336 to change this value from the
337 default of 0 (which turns off this
338 feature). This setting also takes
339 time values which may be suffixed with
340 the units <literal>year</literal>,
341 <literal>month</literal>,
342 <literal>week</literal>, <literal>day</literal>,
343 <literal>h</literal> or <literal> m</literal>
344 to override the default time unit of
345 seconds.</para></listitem>
350 <term><varname>SyncIntervalSec=</varname></term>
352 <listitem><para>The timeout before synchronizing journal
353 data to disk. After syncing, journal files have
354 the OFFLINE state. Default timeout is 5 minutes.
359 <term><varname>ForwardToSyslog=</varname></term>
360 <term><varname>ForwardToKMsg=</varname></term>
361 <term><varname>ForwardToConsole=</varname></term>
363 <listitem><para>Control whether log
364 messages received by the journal
365 daemon shall be forwarded to a
366 traditional syslog daemon, to the
367 kernel log buffer (kmsg), or to the
368 system console. These options take
369 boolean arguments. If forwarding to
370 syslog is enabled but no syslog daemon
371 is running, the respective option has
372 no effect. By default, only forwarding
373 to syslog is enabled. These settings
374 may be overridden at boot time with
375 the kernel command line options
376 <literal>systemd.journald.forward_to_syslog=</literal>,
377 <literal>systemd.journald.forward_to_kmsg=</literal>
379 <literal>systemd.journald.forward_to_console=</literal>.
384 <term><varname>MaxLevelStore=</varname></term>
385 <term><varname>MaxLevelSyslog=</varname></term>
386 <term><varname>MaxLevelKMsg=</varname></term>
387 <term><varname>MaxLevelConsole=</varname></term>
389 <listitem><para>Controls the maximum
390 log level of messages that are stored
391 on disk, forwarded to syslog, kmsg or
392 the console (if that is enabled, see
393 above). As argument, takes one of
394 <literal>emerg</literal>,
395 <literal>alert</literal>,
396 <literal>crit</literal>,
397 <literal>err</literal>,
398 <literal>warning</literal>,
399 <literal>notice</literal>,
400 <literal>info</literal>,
401 <literal>debug</literal> or integer
402 values in the range of 0..7 (corresponding
403 to the same levels). Messages equal or below
404 the log level specified are
405 stored/forwarded, messages above are
407 <literal>debug</literal> for
408 <varname>MaxLevelStore=</varname> and
409 <varname>MaxLevelSyslog=</varname>, to
410 ensure that the all messages are
411 written to disk and forwarded to
413 <literal>notice</literal> for
414 <varname>MaxLevelKMsg=</varname> and
415 <literal>info</literal> for
416 <varname>MaxLevelConsole=</varname>.</para></listitem>
420 <term><varname>TTYPath=</varname></term>
422 <listitem><para>Change the console TTY
424 <varname>ForwardToConsole=yes</varname>
426 <filename>/dev/console</filename>.</para></listitem>
434 <title>See Also</title>
436 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
437 <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
438 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
439 <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
440 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>