journal: default ImportKernel=no until we make use of structured logging

[elogind.git] / man / journald.conf.xml

diff --git a/man/journald.conf.xml b/man/journald.conf.xml
index 251e01dddf8a1ae080113828988628328f2c535f..f82130b9cfca1056e8ffbde8ac7ab804284c8532 100644 (file)
--- a/man/journald.conf.xml
+++ b/man/journald.conf.xml
@@ -48,13 +48,15 @@
         </refnamediv>
 
         <refsynopsisdiv>
         </refnamediv>
 
         <refsynopsisdiv>

-                <para><filename>journald.conf</filename></para>
+                <para><filename>/etc/systemd/journald.conf</filename></para>

         </refsynopsisdiv>
 
         <refsect1>
                 <title>Description</title>
 
         </refsynopsisdiv>
 
         <refsect1>
                 <title>Description</title>
 

-                <para>This files configures various parameters of the systemd journal service.</para>
+                <para>This files configures various parameters of the
+                systemd journal service
+                <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>

 
         </refsect1>
 
 
         </refsect1>
 


@@ -126,7 +128,7 @@
                                 prefixed with
                                 <literal>System</literal> apply to the
                                 journal files when stored on a
                                 prefixed with
                                 <literal>System</literal> apply to the
                                 journal files when stored on a

-                                persistant file system, more
+                                persistent file system, more

                                 specifically
                                 <filename>/var/log/journal</filename>. The
                                 options prefixed with
                                 specifically
                                 <filename>/var/log/journal</filename>. The
                                 options prefixed with


@@ -142,9 +144,9 @@
                                 exists. Otherwise only the latter
                                 applies. Note that this means that
                                 during early boot and if the
                                 exists. Otherwise only the latter
                                 applies. Note that this means that
                                 during early boot and if the

-                                administrator disabled persistant
+                                administrator disabled persistent

                                 logging only the latter options apply,
                                 logging only the latter options apply,

-                                while the former apply if persistant
+                                while the former apply if persistent

                                 logging is enabled and the system is
                                 fully booted
                                 up. <varname>SystemMaxUse=</varname>
                                 logging is enabled and the system is
                                 fully booted
                                 up. <varname>SystemMaxUse=</varname>


@@ -208,12 +210,12 @@
                                 is running the respective option has
                                 no effect. By default only forwarding
                                 to syslog is enabled. These settings
                                 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
+                                may be overridden at boot time with the

                                 kernel command line options
                                 kernel command line options

-                                <literal>systemd_journald.forward_to_syslog=</literal>,
-                                <literal>systemd_journald.forward_to_kmsg=</literal>
+                                <literal>systemd.journald.forward_to_syslog=</literal>,
+                                <literal>systemd.journald.forward_to_kmsg=</literal>

                                 and
                                 and

-                                <literal>systemd_journald.forward_to_console=</literal>. If
+                                <literal>systemd.journald.forward_to_console=</literal>. If

                                 forwarding to the kernel log buffer and
                                 <varname>ImportKernel=</varname> is
                                 enabled at the same time care is taken
                                 forwarding to the kernel log buffer and
                                 <varname>ImportKernel=</varname> is
                                 enabled at the same time care is taken


@@ -222,13 +224,59 @@
                                 </para></listitem>
                         </varlistentry>
 
                                 </para></listitem>
                         </varlistentry>
 

+                        <varlistentry>
+                                <term><varname>MaxLevelStore=</varname></term>
+                                <term><varname>MaxLevelSyslog=</varname></term>
+                                <term><varname>MaxLevelKMsg=</varname></term>
+                                <term><varname>MaxLevelConsole=</varname></term>
+
+                                <listitem><para>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
+                                <literal>emerg</literal>,
+                                <literal>alert</literal>,
+                                <literal>crit</literal>,
+                                <literal>err</literal>,
+                                <literal>warning</literal>,
+                                <literal>notice</literal>,
+                                <literal>info</literal>,
+                                <literal>debug</literal> 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
+                                <literal>debug</literal> for
+                                <varname>MaxLevelStore=</varname> and
+                                <varname>MaxLevelSyslog=</varname>, to
+                                ensure that the all messages are
+                                written to disk and forwarded to
+                                syslog. Defaults to
+                                <literal>notice</literal> for
+                                <varname>MaxLevelKMsg=</varname> and
+                                <literal>info</literal> for
+                                <varname>MaxLevelConsole=</varname>.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>TTYPath=</varname></term>
+
+                                <listitem><para>Change the console TTY
+                                to use if
+                                <varname>ForwardToConsole=yes</varname>
+                                is used. Defaults to
+                                <filename>/dev/console</filename>.</para></listitem>
+                        </varlistentry>
+

                         <varlistentry>
                                 <term><varname>ImportKernel=</varname></term>
 
                                 <listitem><para>Controls whether
                                 kernel log messages shall be stored in
                                 the journal. Takes a boolean argument
                         <varlistentry>
                                 <term><varname>ImportKernel=</varname></term>
 
                                 <listitem><para>Controls whether
                                 kernel log messages shall be stored in
                                 the journal. Takes a boolean argument

-                                and defaults to enabled. Note that
+                                and defaults to disabled. Note that

                                 currently only one userspace service
                                 can read kernel messages at a time,
                                 which means that kernel log message
                                 currently only one userspace service
                                 can read kernel messages at a time,
                                 which means that kernel log message


@@ -238,6 +286,46 @@
                                 traditional syslog service.
                                 </para></listitem>
                         </varlistentry>
                                 traditional syslog service.
                                 </para></listitem>
                         </varlistentry>

+
+                        <varlistentry>
+                                <term><varname>Storage=</varname></term>
+
+                                <listitem><para>Controls where to
+                                store journal data. One of
+                                <literal>volatile</literal>,
+                                <literal>permanent</literal>,
+                                <literal>auto</literal> and
+                                <literal>none</literal>. If
+                                <literal>volatile</literal> journal
+                                log data will be stored only in
+                                memory, i.e. below the
+                                <filename>/run/log/journal</filename>
+                                hierarchy (which is created if
+                                needed). If
+                                <literal>permanent</literal> data will
+                                be stored preferably on disk,
+                                i.e. below the
+                                <filename>/var/log/journal</filename>
+                                hierarchy (which is created if
+                                needed), with a fallback to
+                                <filename>/run/log/journal</filename>
+                                (which is created if needed), during
+                                early boot and if the disk is not
+                                writable. <literal>auto</literal> is
+                                similar to
+                                <literal>permanent</literal> but the
+                                directory
+                                <filename>/var/log/journal</filename>
+                                is not created if needed, so that its
+                                existance controls where log data
+                                goes. <literal>none</literal> 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
+                                <literal>auto</literal>.</para></listitem>
+                        </varlistentry>

                 </variablelist>
 
         </refsect1>
                 </variablelist>
 
         </refsect1>


@@ -246,6 +334,7 @@
                   <title>See Also</title>
                   <para>
                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                   <title>See Also</title>
                   <para>
                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

+                          <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,

                           <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                           <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>