[nginx-site] Documented the "rate" parameter of the "error_log" ...

[Maxim Dounin]

details:   http://freenginx.org/hg/nginx-site/rev/27532d42102b
branches:  
changeset: 3090:27532d42102b
user:      Maxim Dounin <mdounin at mdounin.ru>
date:      Sun Jun 16 06:55:30 2024 +0300
description:
Documented the "rate" parameter of the "error_log" directive.

diffstat:

 xml/en/docs/ngx_core_module.xml |  20 ++++++++++++++++++--
 xml/ru/docs/ngx_core_module.xml |  20 ++++++++++++++++++--
 2 files changed, 36 insertions(+), 4 deletions(-)

diffs (90 lines):

diff --git a/xml/en/docs/ngx_core_module.xml b/xml/en/docs/ngx_core_module.xml
--- a/xml/en/docs/ngx_core_module.xml
+++ b/xml/en/docs/ngx_core_module.xml
@@ -10,7 +10,7 @@
 <module name="Core functionality"
         link="/en/docs/ngx_core_module.html"
         lang="en"
-        rev="28">
+        rev="29">
 
 <section id="example" name="Example Configuration">
 
@@ -209,7 +209,10 @@ and should not be set directly by the us
 
 
 <directive name="error_log">
-<syntax><value>file</value> [<value>level</value>]</syntax>
+<syntax>
+    <value>file</value>
+    [<value>level</value>]
+    [<literal>rate</literal>=<value>rate</value>]</syntax>
 <default>logs/error.log error</default>
 <context>main</context>
 <context>http</context>
@@ -258,7 +261,20 @@ For <literal>debug</literal> logging to 
 be built with <literal>--with-debug</literal>,
 see “<link doc="debugging_log.xml"/>”.
 </note>
+</para>
 
+<para>
+The <literal>rate</literal> parameter (1.27.2) specifies
+the maximum allowed logging rate in messages per second (m/s)
+for each worker process.
+By default, <literal>rate=1000m/s</literal> is used.
+Setting <value>rate</value> to 0 disables rate limiting.
+Additionally, rate limiting is not used
+if logging level is set to <literal>debug</literal> or
+debugging log is enabled for the <link id="debug_connection">connection</link>.
+</para>
+
+<para>
 <note>
 The directive can be specified on the
 <literal>stream</literal> level
diff --git a/xml/ru/docs/ngx_core_module.xml b/xml/ru/docs/ngx_core_module.xml
--- a/xml/ru/docs/ngx_core_module.xml
+++ b/xml/ru/docs/ngx_core_module.xml
@@ -10,7 +10,7 @@
 <module name="Основная функциональность"
         link="/ru/docs/ngx_core_module.html"
         lang="ru"
-        rev="28">
+        rev="29">
 
 <section id="example" name="Пример конфигурации">
 
@@ -208,7 +208,10 @@ env OPENSSL_ALLOW_PROXY_CERTS=1;
 
 
 <directive name="error_log">
-<syntax><value>файл</value> [<value>уровень</value>]</syntax>
+<syntax>
+    <value>файл</value>
+    [<value>уровень</value>]
+    [<literal>rate</literal>=<value>скорость</value>]</syntax>
 <default>logs/error.log error</default>
 <context>main</context>
 <context>http</context>
@@ -256,7 +259,20 @@ env OPENSSL_ALLOW_PROXY_CERTS=1;
 nginx с <literal>--with-debug</literal>,
 см. “<link doc="debugging_log.xml"/>”.
 </note>
+</para>
 
+<para>
+Параметр <literal>rate</literal> (1.27.2) задаёт
+максимально допустимую скорость записи в лог в сообщениях в секунду (m/s)
+для каждого рабочего процесса.
+По умолчанию используется <literal>rate=1000m/s</literal>.
+Установка <literal>скорости</literal> в 0 отключает ограничение скорости.
+Кроме того, ограничение скорости не используется,
+если уровень лога установлен в <literal>debug</literal> или
+отладочный лог включён для <link id="debug_connection">соединения</link>.
+</para>
+
+<para>
 <note>
 Директива может быть указана на
 уровне <literal>stream</literal>