From b47ffcfdfd46de119e0fe8d1c48105bd7c21ddd4 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Thu, 15 Mar 2012 23:25:14 +0100 Subject: [PATCH] man: document systemd-journald.conf(5) --- Makefile.am | 3 +- man/systemd-journald.conf.xml | 254 ++++++++++++++++++++++++++++++++++ man/systemd-logind.conf.xml | 4 +- src/journal/journal-file.c | 2 +- 4 files changed, 259 insertions(+), 4 deletions(-) create mode 100644 man/systemd-journald.conf.xml diff --git a/Makefile.am b/Makefile.am index f3ad60ea9..0b2660ae5 100644 --- a/Makefile.am +++ b/Makefile.am @@ -693,7 +693,8 @@ MANPAGES = \ man/sysctl.d.5 \ man/systemd-ask-password.1 \ man/systemd-cat.1 \ - man/systemd-machine-id-setup.1 + man/systemd-machine-id-setup.1 \ + man/systemd-journald.conf.5 MANPAGES_ALIAS = \ man/reboot.8 \ diff --git a/man/systemd-journald.conf.xml b/man/systemd-journald.conf.xml new file mode 100644 index 000000000..f3cd4db26 --- /dev/null +++ b/man/systemd-journald.conf.xml @@ -0,0 +1,254 @@ + + + + + + + + + systemd-journald.conf + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + systemd-journald.conf + 5 + + + + systemd-journald.conf + Journal service configuration file + + + + systemd-journald.conf + + + + Description + + This files configures various parameters of the systemd journal service. + + + + + Options + + All options are configured in the + [Journal] section: + + + + + Compress= + + 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. + + + + RateLimitInterval= + RateLimitBurst= + + Configures the rate + limiting that is applied to all + messages generated on the system. If + in the time interval defined by + RateLimitInterval= + more messages than specified in + RateLimitBurst= 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 + RateLimitInterval= + may be specified in the following + units: s, + min, + h, + ms, + us. To turn off any + kind of rate limiting, set either + value to 0. + + + + SystemMaxUse= + SystemKeepFree= + SystemMaxFileSize= + SystemMinFileSize= + RuntimeMaxUse= + RuntimeKeepFree= + RuntimeMaxFileSize= + RuntimeMinFileSize= + + Enforce size limits on + the journal files stored. The options + prefixed with + System apply to the + journal files when stored on a + persistant file system, more + specifically + /var/log/journal. The + options prefixed with + Runtime apply to + the journal files when stored on a + volatile in-memory file system, more + specifically + /run/log/journal. The + former is used only when + /var is mounted, + writable and the directory + /var/log/journal + exists. Otherwise only the latter + applies. Note that this means that + during early boot and if the + administrator disabled persistant + logging only the latter options apply, + while the former apply if persistant + logging is enabled and the system is + fully booted + up. SystemMaxUse= + and RuntimeMaxUse= + control how much disk space the + journal may use up at + maximum. Defaults to 10% of the size + of the respective file + system. SystemKeepFree= + and + RuntimeKeepFree= + control how much disk space the + journal shall always leave free for + other uses if less than the disk space + configured in + SystemMaxUse= and + RuntimeMaxUse= is + available. Defaults to 5% of the size + of the respective file + system. SystemMaxFileSize= + and + RuntimeMaxFileSize= + 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 + SystemMaxUse= and + RuntimeMaxUse=, so + that usually seven rotated journal + files are kept as + history. SystemMinFileSize= + and + RuntimeMinFileSize= + 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. + + + + ForwardToSyslog= + ForwardToKMsg= + ForwardToConsole= + + 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 overriden at boot time with the + kernel command line options + systemd_journald.forward_to_syslog=, + systemd_journald.forward_to_kmsg= + and + systemd_journald.forward_to_console=. If + forwarding to the kernel log buffer and + ImportKernel= is + enabled at the same time care is taken + to avoid logging loops. It is safe to + use these options in combination. + + + + + ImportKernel= + + 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. + + + + + + + + See Also + + systemd1, + systemd-journalctl1, + systemd.conf5 + + + + diff --git a/man/systemd-logind.conf.xml b/man/systemd-logind.conf.xml index c7e277f25..4b0281503 100644 --- a/man/systemd-logind.conf.xml +++ b/man/systemd-logind.conf.xml @@ -44,11 +44,11 @@ systemd-logind.conf - login manager configuration file + Login manager configuration file - systemd-login.conf + systemd-logind.conf diff --git a/src/journal/journal-file.c b/src/journal/journal-file.c index 6460d70c4..474dd5ca7 100644 --- a/src/journal/journal-file.c +++ b/src/journal/journal-file.c @@ -40,7 +40,7 @@ #define COMPRESSION_SIZE_THRESHOLD (512ULL) /* This is the minimum journal file size */ -#define JOURNAL_FILE_SIZE_MIN (64ULL*1024ULL) +#define JOURNAL_FILE_SIZE_MIN (64ULL*1024ULL) /* 64 KiB */ /* These are the lower and upper bounds if we deduce the max_use value * from the file system size */ -- 2.30.2