~ubuntu-branches/ubuntu/trusty/systemd/trusty

« back to all changes in this revision

Viewing changes to man/journald.conf.5

Tags: upstream-202
ImportĀ upstreamĀ versionĀ 202

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
'\" t
2
 
.\"     Title: journald.conf
3
 
.\"    Author: Lennart Poettering <lennart@poettering.net>
4
 
.\" Generator: DocBook XSL Stylesheets v1.77.1 <http://docbook.sf.net/>
5
 
.\"      Date: 03/07/2013
6
 
.\"    Manual: journald.conf
7
 
.\"    Source: systemd
8
 
.\"  Language: English
9
 
.\"
10
 
.TH "JOURNALD\&.CONF" "5" "" "systemd" "journald.conf"
11
 
.\" -----------------------------------------------------------------
12
 
.\" * Define some portability stuff
13
 
.\" -----------------------------------------------------------------
14
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15
 
.\" http://bugs.debian.org/507673
16
 
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17
 
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18
 
.ie \n(.g .ds Aq \(aq
19
 
.el       .ds Aq '
20
 
.\" -----------------------------------------------------------------
21
 
.\" * set default formatting
22
 
.\" -----------------------------------------------------------------
23
 
.\" disable hyphenation
24
 
.nh
25
 
.\" disable justification (adjust text to left margin only)
26
 
.ad l
27
 
.\" -----------------------------------------------------------------
28
 
.\" * MAIN CONTENT STARTS HERE *
29
 
.\" -----------------------------------------------------------------
30
 
.SH "NAME"
31
 
journald.conf \- Journal service configuration file
32
 
.SH "SYNOPSIS"
33
 
.PP
34
 
/etc/systemd/journald\&.conf
35
 
.SH "DESCRIPTION"
36
 
.PP
37
 
This files configures various parameters of the systemd journal service
38
 
\fBsystemd-journald.service\fR(8)\&.
39
 
.SH "OPTIONS"
40
 
.PP
41
 
All options are configured in the
42
 
[Journal]
43
 
section:
44
 
.PP
45
 
\fIStorage=\fR
46
 
.RS 4
47
 
Controls where to store journal data\&. One of
48
 
volatile,
49
 
persistent,
50
 
auto
51
 
and
52
 
none\&. If
53
 
volatile
54
 
journal log data will be stored only in memory, i\&.e\&. below the
55
 
/run/log/journal
56
 
hierarchy (which is created if needed)\&. If
57
 
persistent
58
 
data will be stored preferably on disk, i\&.e\&. below the
59
 
/var/log/journal
60
 
hierarchy (which is created if needed), with a fallback to
61
 
/run/log/journal
62
 
(which is created if needed), during early boot and if the disk is not writable\&.
63
 
auto
64
 
is similar to
65
 
persistent
66
 
but the directory
67
 
/var/log/journal
68
 
is not created if needed, so that its existence controls where log data goes\&.
69
 
none
70
 
turns off all storage, all log data received will be dropped\&. Forwarding to other targets, such as the console, the kernel log buffer or a syslog daemon will still work however\&. Defaults to
71
 
auto\&.
72
 
.RE
73
 
.PP
74
 
\fICompress=\fR
75
 
.RS 4
76
 
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\&.
77
 
.RE
78
 
.PP
79
 
\fISeal=\fR
80
 
.RS 4
81
 
Takes a boolean value\&. If enabled (the default) and a sealing key is available (as created by
82
 
\fBjournalctl\fR(1)\*(Aqs
83
 
\fB\-\-setup\-keys\fR
84
 
command), forward secure sealing (FSS) for all persistent journal files is enabled\&.
85
 
.RE
86
 
.PP
87
 
\fISplitMode=\fR
88
 
.RS 4
89
 
Controls whether to split up journal files per user\&. One of
90
 
login,
91
 
uid
92
 
and
93
 
none\&. If
94
 
login
95
 
each logged in user will get his own journal files, but systemd user IDs will log into the system journal\&. If
96
 
uid
97
 
any user ID will get his own journal files regardless whether it belongs to a system service or refers to a real logged in user\&. If
98
 
none
99
 
journal files are not split up per\-user and all messages are stored in the single system journal\&. Note that splitting up journal files per\-user is only available of journals are stored persistently\&. If journals are stored on volatile storage (see above) only a single journal file for all user IDs is kept\&. Defaults to
100
 
login\&.
101
 
.RE
102
 
.PP
103
 
\fIRateLimitInterval=\fR, \fIRateLimitBurst=\fR
104
 
.RS 4
105
 
Configures the rate limiting that is applied to all messages generated on the system\&. If in the time interval defined by
106
 
\fIRateLimitInterval=\fR
107
 
more messages than specified in
108
 
\fIRateLimitBurst=\fR
109
 
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 others\*(Aq limits\&. Defaults to 200 messages in 10s\&. The time specification for
110
 
\fIRateLimitInterval=\fR
111
 
may be specified in the following units:
112
 
s,
113
 
min,
114
 
h,
115
 
ms,
116
 
us\&. To turn off any kind of rate limiting, set either value to 0\&.
117
 
.RE
118
 
.PP
119
 
\fISystemMaxUse=\fR, \fISystemKeepFree=\fR, \fISystemMaxFileSize=\fR, \fIRuntimeMaxUse=\fR, \fIRuntimeKeepFree=\fR, \fIRuntimeMaxFileSize=\fR
120
 
.RS 4
121
 
Enforce size limits on the journal files stored\&. The options prefixed with
122
 
System
123
 
apply to the journal files when stored on a persistent file system, more specifically
124
 
/var/log/journal\&. The options prefixed with
125
 
Runtime
126
 
apply to the journal files when stored on a volatile in\-memory file system, more specifically
127
 
/run/log/journal\&. The former is used only when
128
 
/var
129
 
is mounted, writable and the directory
130
 
/var/log/journal
131
 
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\&.
132
 
\fISystemMaxUse=\fR
133
 
and
134
 
\fIRuntimeMaxUse=\fR
135
 
control how much disk space the journal may use up at maximum\&. Defaults to 10% of the size of the respective file system\&.
136
 
\fISystemKeepFree=\fR
137
 
and
138
 
\fIRuntimeKeepFree=\fR
139
 
control how much disk space the journal shall always leave free for other uses if less than the disk space configured in
140
 
\fISystemMaxUse=\fR
141
 
and
142
 
\fIRuntimeMaxUse=\fR
143
 
is available\&. Defaults to 5% of the size of the respective file system\&.
144
 
\fISystemMaxFileSize=\fR
145
 
and
146
 
\fIRuntimeMaxFileSize=\fR
147
 
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 eighth of the values configured with
148
 
\fISystemMaxUse=\fR
149
 
and
150
 
\fIRuntimeMaxUse=\fR, so that usually seven rotated journal files are kept as history\&. 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\&.
151
 
.RE
152
 
.PP
153
 
\fIMaxFileSec=\fR
154
 
.RS 4
155
 
The maximum time to store entries in a single journal file, before rotating to the next one\&. Normally time\-based rotation should not be required as size\-based rotation with options such as
156
 
\fISystemMaxFileSize=\fR
157
 
should be sufficient to ensure that journal files don\*(Aqt grow without bounds\&. However, to ensure that not too much data is lost at once when old journal files are deleted it might make sense to change this value from the default of one month\&. Set to 0 to turn off this feature\&. This setting takes time values which may be suffixed with the units year, month, week, day, h, m to override the default time unit of seconds\&.
158
 
.RE
159
 
.PP
160
 
\fIMaxRetentionSec=\fR
161
 
.RS 4
162
 
The maximum time to store journal entries\&. This controls whether journal files containing entries older then the specified time span are deleted\&. Normally time\-based deletion of old journal files should not be required as size\-based deletion with options such as
163
 
\fISystemMaxUse=\fR
164
 
should be sufficient to ensure that journal files don\*(Aqt grow without bounds\&. However, to enforce data retention policies it might make sense to change this value from the default of 0 (which turns off this feature)\&. This setting also takes time values which may be suffixed with the units year, month, week, day, h, m to override the default time unit of seconds\&.
165
 
.RE
166
 
.PP
167
 
\fIForwardToSyslog=\fR, \fIForwardToKMsg=\fR, \fIForwardToConsole=\fR
168
 
.RS 4
169
 
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
170
 
systemd\&.journald\&.forward_to_syslog=,
171
 
systemd\&.journald\&.forward_to_kmsg=
172
 
and
173
 
systemd\&.journald\&.forward_to_console=\&.
174
 
.RE
175
 
.PP
176
 
\fIMaxLevelStore=\fR, \fIMaxLevelSyslog=\fR, \fIMaxLevelKMsg=\fR, \fIMaxLevelConsole=\fR
177
 
.RS 4
178
 
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
179
 
emerg,
180
 
alert,
181
 
crit,
182
 
err,
183
 
warning,
184
 
notice,
185
 
info,
186
 
debug
187
 
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
188
 
debug
189
 
for
190
 
\fIMaxLevelStore=\fR
191
 
and
192
 
\fIMaxLevelSyslog=\fR, to ensure that the all messages are written to disk and forwarded to syslog\&. Defaults to
193
 
notice
194
 
for
195
 
\fIMaxLevelKMsg=\fR
196
 
and
197
 
info
198
 
for
199
 
\fIMaxLevelConsole=\fR\&.
200
 
.RE
201
 
.PP
202
 
\fITTYPath=\fR
203
 
.RS 4
204
 
Change the console TTY to use if
205
 
\fIForwardToConsole=yes\fR
206
 
is used\&. Defaults to
207
 
/dev/console\&.
208
 
.RE
209
 
.SH "SEE ALSO"
210
 
.PP
211
 
 
212
 
\fBsystemd\fR(1),
213
 
\fBsystemd-journald.service\fR(8),
214
 
\fBjournalctl\fR(1),
215
 
\fBsystemd.journal-fields\fR(7),
216
 
\fBsystemd-system.conf\fR(5)