diff options
Diffstat (limited to 'upstream/fedora-rawhide/man5/journald.conf.5')
| -rw-r--r-- | upstream/fedora-rawhide/man5/journald.conf.5 | 109 |
1 files changed, 79 insertions, 30 deletions
diff --git a/upstream/fedora-rawhide/man5/journald.conf.5 b/upstream/fedora-rawhide/man5/journald.conf.5 index 911b6cdf..212b7e97 100644 --- a/upstream/fedora-rawhide/man5/journald.conf.5 +++ b/upstream/fedora-rawhide/man5/journald.conf.5 @@ -1,5 +1,5 @@ '\" t -.TH "JOURNALD\&.CONF" "5" "" "systemd 255" "journald.conf" +.TH "JOURNALD\&.CONF" "5" "" "systemd 256~rc3" "journald.conf" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -23,21 +23,36 @@ journald.conf, journald.conf.d, journald@.conf \- Journal service configuration files .SH "SYNOPSIS" .PP +.RS 4 /etc/systemd/journald\&.conf -.PP +.RE +.RS 4 +/run/systemd/journald\&.conf +.RE +.RS 4 +/usr/lib/systemd/journald\&.conf +.RE +.RS 4 /etc/systemd/journald\&.conf\&.d/*\&.conf -.PP +.RE +.RS 4 /run/systemd/journald\&.conf\&.d/*\&.conf -.PP +.RE +.RS 4 /usr/lib/systemd/journald\&.conf\&.d/*\&.conf -.PP +.RE +.RS 4 /etc/systemd/journald@\fINAMESPACE\fR\&.conf -.PP +.RE +.RS 4 /etc/systemd/journald@\fINAMESPACE\fR\&.conf\&.d/*\&.conf -.PP +.RE +.RS 4 /run/systemd/journald@\fINAMESPACE\fR\&.conf\&.d/*\&.conf -.PP +.RE +.RS 4 /usr/lib/systemd/journald@\fINAMESPACE\fR\&.conf\&.d/*\&.conf +.RE .SH "DESCRIPTION" .PP These files configure various parameters of the systemd journal service, @@ -56,16 +71,16 @@ and associated drop\-ins with the namespace identifier filled in\&. This allows for details about journal namespaces\&. .SH "CONFIGURATION DIRECTORIES AND PRECEDENCE" .PP -The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is either in -/usr/lib/systemd/ -or -/etc/systemd/ -and contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in +The default configuration is set during compilation, so configuration is only needed when it is necessary to deviate from those defaults\&. The main configuration file is loaded from one of the listed directories in order of priority, only the first file found is used: +/etc/systemd/, +/run/systemd/, +/usr/local/lib/systemd/, +/usr/lib/systemd/\&. The vendor version of the file contains commented out entries showing the defaults as a guide to the administrator\&. Local overrides can also be created by creating drop\-ins, as described below\&. The main configuration file can also be edited for this purpose (or a copy in /etc/ -if it\*(Aqs shipped in -/usr/) however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. +if it\*(Aqs shipped under +/usr/), however using drop\-ins for local configuration is recommended over modifications to the main configuration file\&. .PP -In addition to the "main" configuration file, drop\-in configuration snippets are read from +In addition to the main configuration file, drop\-in configuration snippets are read from /usr/lib/systemd/*\&.conf\&.d/, /usr/local/lib/systemd/*\&.conf\&.d/, and /etc/systemd/*\&.conf\&.d/\&. Those drop\-ins have higher precedence and override the main configuration file\&. Files in the @@ -75,7 +90,12 @@ configuration subdirectories are sorted by their filename in lexicographic order When packages need to customize the configuration, they can install drop\-ins under /usr/\&. Files in /etc/ -are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defined a concept of drop\-in priority to allow distributions to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. +are reserved for the local administrator, who may use this logic to override the configuration files installed by vendor packages\&. Drop\-ins have to be used to override package drop\-ins, since the main configuration file has lower precedence\&. It is recommended to prefix all filenames in those subdirectories with a two\-digit number and a dash, to simplify the ordering of the files\&. This also defines a concept of drop\-in priorities to allow OS vendors to ship drop\-ins within a specific range lower than the range used by users\&. This should lower the risk of package drop\-ins overriding accidentally drop\-ins defined by users\&. It is recommended to use the range 10\-40 for drop\-ins in +/usr/ +and the range 60\-90 for drop\-ins in +/etc/ +and +/run/, to make sure that local and transient drop\-ins take priority over drop\-ins shipped by the OS vendor\&. .PP To disable a configuration file supplied by the vendor, the recommended way is to place a symlink to /dev/null @@ -151,6 +171,10 @@ Note that per\-user journal files are not supported unless persistent storage is \fBjournalctl \-\-user\fR unavailable\&. .sp +The storage to use can also be specified via the +"journal\&.storage" +credential\&. Values configured via configuration files take priority over values configured via the credential\&. +.sp Added in version 186\&. .RE .PP @@ -364,9 +388,11 @@ The timeout before synchronizing journal files to disk\&. After syncing, journal Added in version 199\&. .RE .PP -\fIForwardToSyslog=\fR, \fIForwardToKMsg=\fR, \fIForwardToConsole=\fR, \fIForwardToWall=\fR +\fIForwardToSyslog=\fR, \fIForwardToKMsg=\fR, \fIForwardToConsole=\fR, \fIForwardToWall=\fR, \fIForwardToSocket=\fR .RS 4 -Control whether log messages received by the journal daemon shall be forwarded to a traditional syslog daemon, to the kernel log buffer (kmsg), to the system console, or sent as wall messages to all logged\-in users\&. These options take boolean arguments\&. If forwarding to syslog is enabled but nothing reads messages from the socket, forwarding to syslog has no effect\&. By default, only forwarding to wall is enabled\&. These settings may be overridden at boot time with the kernel command line options +Control whether log messages received by the journal daemon shall be forwarded to a traditional syslog daemon, to the kernel log buffer (kmsg), to the system console, sent as wall messages to all logged\-in users or sent over a socket\&. These options take boolean arguments except for +"ForwardToSocket=" +which takes an address instead\&. If forwarding to syslog is enabled but nothing reads messages from the socket, forwarding to syslog has no effect\&. By default, only forwarding to wall is enabled\&. These settings may be overridden at boot time with the kernel command line options "systemd\&.journald\&.forward_to_syslog", "systemd\&.journald\&.forward_to_kmsg", "systemd\&.journald\&.forward_to_console", and @@ -374,6 +400,11 @@ Control whether log messages received by the journal daemon shall be forwarded t "=" and the following argument, true is assumed\&. Otherwise, the argument is parsed as a boolean\&. .sp +The socket forwarding address can be specified with the credential +"journal\&.forward_to_socket"\&. The following socket types are supported: +.sp +\fBAF_INET\fR (e\&.g\&. "192\&.168\&.0\&.11:4444"), \fBAF_INET6\fR (e\&.g\&. "[2001:db8::ff00:42:8329]:4444"), \fBAF_UNIX\fR (e\&.g\&. "/run/host/journal/socket"), \fBAF_VSOCK\fR (e\&.g\&. "vsock:2:1234") +.sp When forwarding to the console, the TTY to log to can be changed with \fITTYPath=\fR, described below\&. .sp @@ -383,15 +414,30 @@ to the kernel command line\&. \fBsystemd\fR will automatically disable kernel\*(Aqs rate\-limiting applied to userspace processes (equivalent to setting "printk\&.devkmsg=on")\&. -.PP +.sp +When forwarding over a socket the +\m[blue]\fBJournal Export Format\fR\m[]\&\s-2\u[3]\d\s+2 +is used when sending over the wire\&. Notably this includes the metadata field +\fI__REALTIME_TIMESTAMP\fR +so that +\fBsystemd\-journal\-remote\fR +(see +\fBsystemd-journal-remote.service\fR(8)) can be used to receive the forwarded journal entries\&. +.sp Note: Forwarding is performed synchronously within journald, and may significantly affect its performance\&. This is particularly relevant when using ForwardToConsole=yes in cloud environments, where the console is often a slow, virtual serial port\&. Since journald is implemented as a conventional single\-process daemon, forwarding to a completely hung console will block journald\&. This can have a cascading effect resulting in any services synchronously logging to the blocked journal also becoming blocked\&. Unless actively debugging/developing something, it\*(Aqs generally preferable to setup a \fBjournalctl \-\-follow\fR style service redirected to the console, instead of ForwardToConsole=yes, for production use\&. +.PP +Note: Using +\fIForwardToSocket=\fR +over IPv4/IPv6 links can be very slow due to the synchronous nature of the sockets\&. Take care to ensure your link is a low\-latency local link if possible\&. Typically IP networking is not available everywhere journald runs, e\&.g\&. in the initrd during boot\&. Consider using +\fBAF_VSOCK\fR/\fBAF_UNIX\fR +sockets for this if possible\&. .RE .PP -\fIMaxLevelStore=\fR, \fIMaxLevelSyslog=\fR, \fIMaxLevelKMsg=\fR, \fIMaxLevelConsole=\fR, \fIMaxLevelWall=\fR +\fIMaxLevelStore=\fR, \fIMaxLevelSyslog=\fR, \fIMaxLevelKMsg=\fR, \fIMaxLevelConsole=\fR, \fIMaxLevelWall=\fR, \fIMaxLevelSocket=\fR .RS 4 -Controls the maximum log level of messages that are stored in the journal, forwarded to syslog, kmsg, the console or wall (if that is enabled, see above)\&. As argument, takes one of +Controls the maximum log level of messages that are stored in the journal, forwarded to syslog, kmsg, the console, the wall, or a socket (if that is enabled, see above)\&. As argument, takes one of "emerg", "alert", "crit", @@ -402,9 +448,10 @@ Controls the maximum log level of messages that are stored in the journal, forwa "debug", or integer values in the range of 0\(en7 (corresponding to the same levels)\&. Messages equal or below the log level specified are stored/forwarded, messages above are dropped\&. Defaults to "debug" for -\fIMaxLevelStore=\fR +\fIMaxLevelStore=\fR, +\fIMaxLevelSyslog=\fR and -\fIMaxLevelSyslog=\fR, to ensure that the all messages are stored in the journal and forwarded to syslog\&. Defaults to +\fIMaxLevelSocket=\fR, to ensure that the all messages are stored in the journal, forwarded to syslog and the socket if one exists\&. Defaults to "notice" for \fIMaxLevelKMsg=\fR, @@ -418,7 +465,8 @@ for "systemd\&.journald\&.max_level_syslog=", "systemd\&.journald\&.max_level_kmsg=", "systemd\&.journald\&.max_level_console=", -"systemd\&.journald\&.max_level_wall="\&. +"systemd\&.journald\&.max_level_wall=", +"systemd\&.journald\&.max_level_socket="\&. .sp Added in version 185\&. .RE @@ -491,11 +539,7 @@ option, and not the option, is relevant for them\&. .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd-journald.service\fR(8), -\fBjournalctl\fR(1), -\fBsystemd.journal-fields\fR(7), -\fBsystemd-system.conf\fR(5) +\fBsystemd\fR(1), \fBsystemd-journald.service\fR(8), \fBjournalctl\fR(1), \fBsystemd.journal-fields\fR(7), \fBsystemd-system.conf\fR(5) .SH "NOTES" .IP " 1." 4 Seekable Sequential Key Generators @@ -507,3 +551,8 @@ Users, Groups, UIDs and GIDs on systemd systems .RS 4 \%https://systemd.io/UIDS-GIDS .RE +.IP " 3." 4 +Journal Export Format +.RS 4 +\%https://systemd.io/JOURNAL_EXPORT_FORMATS/#journal-export-format +.RE |