From: Lennart Poettering <lennart@poettering.net>
Date: Fri, 6 Jan 2023 10:00:48 +0000 (+0100)
Subject: man: document explicitly that LogRateLimit= has no effect on StandardOutput=file:…
X-Git-Tag: v253-rc1~172
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=578033356d10f135a1fd146c929d68f41c658378;p=thirdparty%2Fsystemd.git

man: document explicitly that LogRateLimit= has no effect on StandardOutput=file:…

Fixes: #25951
---

diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml
index 78cede439c3..567a0fad321 100644
--- a/man/systemd.exec.xml
+++ b/man/systemd.exec.xml
@@ -2909,16 +2909,21 @@ StandardInputData=V2XigLJyZSBubyBzdHJhbmdlcnMgdG8gbG92ZQpZb3Uga25vdyB0aGUgcnVsZX
         <term><varname>LogRateLimitIntervalSec=</varname></term>
         <term><varname>LogRateLimitBurst=</varname></term>
 
-        <listitem><para>Configures the rate limiting that is applied to messages generated by this unit. If, in the
-        time interval defined by <varname>LogRateLimitIntervalSec=</varname>, more messages than specified in
-        <varname>LogRateLimitBurst=</varname> 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. The time
-        specification for <varname>LogRateLimitIntervalSec=</varname> may be specified in the following units: "s",
-        "min", "h", "ms", "us" (see
-        <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details).
-        The default settings are set by <varname>RateLimitIntervalSec=</varname> and <varname>RateLimitBurst=</varname>
-        configured in <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
-        </para></listitem>
+        <listitem><para>Configures the rate limiting that is applied to log messages generated by this
+        unit. If, in the time interval defined by <varname>LogRateLimitIntervalSec=</varname>, more messages
+        than specified in <varname>LogRateLimitBurst=</varname> 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. The time specification for <varname>LogRateLimitIntervalSec=</varname> may be
+        specified in the following units: "s", "min", "h", "ms", "us" (see
+        <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
+        details).  The default settings are set by <varname>RateLimitIntervalSec=</varname> and
+        <varname>RateLimitBurst=</varname> configured in
+        <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. Note
+        that this only applies to log messages that are processed by the logging subsystem, i.e. by
+        <filename>systemd-journald.service</filename>. This means, if you connect a service's stderr directly
+        to a file via <varname>StandardOutput=file:…</varname> or a similar setting the rate limiting will
+        not be applied to messages written that way (but they will be enforced for messages generated via
+        <function>syslog()</function> or similar).</para></listitem>
       </varlistentry>
 
       <varlistentry>