]>
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 |
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> | |
18b754d3 | 51 | <para><filename>journald.conf</filename></para> |
b47ffcfd LP |
52 | </refsynopsisdiv> |
53 | ||
54 | <refsect1> | |
55 | <title>Description</title> | |
56 | ||
57 | <para>This files configures various parameters of the systemd journal service.</para> | |
58 | ||
59 | </refsect1> | |
60 | ||
61 | <refsect1> | |
62 | <title>Options</title> | |
63 | ||
64 | <para>All options are configured in the | |
65 | <literal>[Journal]</literal> section:</para> | |
66 | ||
67 | <variablelist> | |
68 | ||
69 | <varlistentry> | |
70 | <term><varname>Compress=</varname></term> | |
71 | ||
72 | <listitem><para>Takes a boolean | |
73 | value. If enabled (the default) data | |
74 | objects that shall be stored in the | |
75 | journal and are larger than a certain | |
76 | threshold are compressed with the XZ | |
77 | compression algorithm before they are | |
78 | written to the file | |
79 | system.</para></listitem> | |
80 | </varlistentry> | |
81 | ||
82 | <varlistentry> | |
83 | <term><varname>RateLimitInterval=</varname></term> | |
84 | <term><varname>RateLimitBurst=</varname></term> | |
85 | ||
86 | <listitem><para>Configures the rate | |
87 | limiting that is applied to all | |
88 | messages generated on the system. If | |
89 | in the time interval defined by | |
90 | <varname>RateLimitInterval=</varname> | |
91 | more messages than specified in | |
92 | <varname>RateLimitBurst=</varname> are | |
93 | logged by a service all further | |
94 | messages within the interval are | |
95 | dropped, until the interval is over. A | |
96 | message about the number of dropped | |
97 | messages is generated. This rate | |
98 | limiting is applied per-service, so | |
99 | that two services which log do not | |
100 | interfere with each other's | |
101 | limit. Defaults to 100 messages in | |
102 | 10s. The time specification for | |
103 | <varname>RateLimitInterval=</varname> | |
104 | may be specified in the following | |
105 | units: <literal>s</literal>, | |
106 | <literal>min</literal>, | |
107 | <literal>h</literal>, | |
108 | <literal>ms</literal>, | |
109 | <literal>us</literal>. To turn off any | |
110 | kind of rate limiting, set either | |
111 | value to 0.</para></listitem> | |
112 | </varlistentry> | |
113 | ||
114 | <varlistentry> | |
115 | <term><varname>SystemMaxUse=</varname></term> | |
116 | <term><varname>SystemKeepFree=</varname></term> | |
117 | <term><varname>SystemMaxFileSize=</varname></term> | |
118 | <term><varname>SystemMinFileSize=</varname></term> | |
119 | <term><varname>RuntimeMaxUse=</varname></term> | |
120 | <term><varname>RuntimeKeepFree=</varname></term> | |
121 | <term><varname>RuntimeMaxFileSize=</varname></term> | |
122 | <term><varname>RuntimeMinFileSize=</varname></term> | |
123 | ||
124 | <listitem><para>Enforce size limits on | |
125 | the journal files stored. The options | |
126 | prefixed with | |
127 | <literal>System</literal> apply to the | |
128 | journal files when stored on a | |
129 | persistant file system, more | |
130 | specifically | |
131 | <filename>/var/log/journal</filename>. The | |
132 | options prefixed with | |
133 | <literal>Runtime</literal> apply to | |
134 | the journal files when stored on a | |
135 | volatile in-memory file system, more | |
136 | specifically | |
137 | <filename>/run/log/journal</filename>. The | |
138 | former is used only when | |
139 | <filename>/var</filename> is mounted, | |
140 | writable and the directory | |
141 | <filename>/var/log/journal</filename> | |
142 | exists. Otherwise only the latter | |
143 | applies. Note that this means that | |
144 | during early boot and if the | |
145 | administrator disabled persistant | |
146 | logging only the latter options apply, | |
147 | while the former apply if persistant | |
148 | logging is enabled and the system is | |
149 | fully booted | |
150 | up. <varname>SystemMaxUse=</varname> | |
151 | and <varname>RuntimeMaxUse=</varname> | |
152 | control how much disk space the | |
153 | journal may use up at | |
154 | maximum. Defaults to 10% of the size | |
155 | of the respective file | |
156 | system. <varname>SystemKeepFree=</varname> | |
157 | and | |
158 | <varname>RuntimeKeepFree=</varname> | |
159 | control how much disk space the | |
160 | journal shall always leave free for | |
161 | other uses if less than the disk space | |
162 | configured in | |
163 | <varname>SystemMaxUse=</varname> and | |
164 | <varname>RuntimeMaxUse=</varname> is | |
165 | available. Defaults to 5% of the size | |
166 | of the respective file | |
167 | system. <varname>SystemMaxFileSize=</varname> | |
168 | and | |
169 | <varname>RuntimeMaxFileSize=</varname> | |
170 | control how large individual journal | |
171 | files may grow at maximum. This | |
172 | influences the granularity in which | |
173 | disk space is made available through | |
174 | rotation, i.e. deletion of historic | |
175 | data. Defaults to one eigth of the | |
176 | values configured with | |
177 | <varname>SystemMaxUse=</varname> and | |
178 | <varname>RuntimeMaxUse=</varname>, so | |
179 | that usually seven rotated journal | |
180 | files are kept as | |
181 | history. <varname>SystemMinFileSize=</varname> | |
182 | and | |
183 | <varname>RuntimeMinFileSize=</varname> | |
184 | control how large individual journal | |
185 | files grow at minimum. Defaults to | |
186 | 64K. Specify values in bytes or use | |
187 | K, M, G, T, P, E as units for the | |
188 | specified sizes. Note that size limits | |
189 | are enforced synchronously to journal | |
190 | files as they are extended, and need | |
191 | no explicit rotation step triggered by | |
192 | time.</para></listitem> | |
193 | </varlistentry> | |
194 | ||
195 | <varlistentry> | |
196 | <term><varname>ForwardToSyslog=</varname></term> | |
197 | <term><varname>ForwardToKMsg=</varname></term> | |
198 | <term><varname>ForwardToConsole=</varname></term> | |
199 | ||
200 | <listitem><para>Control whether log | |
201 | messages received by the journal | |
202 | daemon shall be forwarded to a | |
203 | traditional syslog daemon, to the | |
204 | kernel log buffer (kmsg), or to the | |
205 | system console. These options take | |
206 | boolean arguments. If forwarding to | |
207 | syslog is enabled but no syslog daemon | |
208 | is running the respective option has | |
209 | no effect. By default only forwarding | |
210 | to syslog is enabled. These settings | |
211 | may be overriden at boot time with the | |
212 | kernel command line options | |
213 | <literal>systemd_journald.forward_to_syslog=</literal>, | |
214 | <literal>systemd_journald.forward_to_kmsg=</literal> | |
215 | and | |
216 | <literal>systemd_journald.forward_to_console=</literal>. If | |
217 | forwarding to the kernel log buffer and | |
218 | <varname>ImportKernel=</varname> is | |
219 | enabled at the same time care is taken | |
220 | to avoid logging loops. It is safe to | |
221 | use these options in combination. | |
222 | </para></listitem> | |
223 | </varlistentry> | |
224 | ||
225 | <varlistentry> | |
226 | <term><varname>ImportKernel=</varname></term> | |
227 | ||
228 | <listitem><para>Controls whether | |
229 | kernel log messages shall be stored in | |
230 | the journal. Takes a boolean argument | |
231 | and defaults to enabled. Note that | |
232 | currently only one userspace service | |
233 | can read kernel messages at a time, | |
234 | which means that kernel log message | |
235 | reading might get corrupted if it | |
236 | is enabled in more than one service, | |
237 | for example in both the journal and a | |
238 | traditional syslog service. | |
239 | </para></listitem> | |
240 | </varlistentry> | |
241 | </variablelist> | |
242 | ||
243 | </refsect1> | |
244 | ||
245 | <refsect1> | |
246 | <title>See Also</title> | |
247 | <para> | |
248 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
169c4f65 | 249 | <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, |
ffa16db0 | 250 | <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>, |
b47ffcfd LP |
251 | <citerefentry><refentrytitle>systemd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> |
252 | </para> | |
253 | </refsect1> | |
254 | ||
255 | </refentry> |