comparison xml/en/docs/ngx_core_module.xml @ 3090:27532d42102b default tip

Documented the "rate" parameter of the "error_log" directive.
author Maxim Dounin <mdounin@mdounin.ru>
date Sun, 16 Jun 2024 06:55:30 +0300
parents eb5950986b11
children
comparison
equal deleted inserted replaced
3089:23b9cbb0c11d 3090:27532d42102b
8 <!DOCTYPE module SYSTEM "../../../dtd/module.dtd"> 8 <!DOCTYPE module SYSTEM "../../../dtd/module.dtd">
9 9
10 <module name="Core functionality" 10 <module name="Core functionality"
11 link="/en/docs/ngx_core_module.html" 11 link="/en/docs/ngx_core_module.html"
12 lang="en" 12 lang="en"
13 rev="28"> 13 rev="29">
14 14
15 <section id="example" name="Example Configuration"> 15 <section id="example" name="Example Configuration">
16 16
17 <para> 17 <para>
18 <example> 18 <example>
207 207
208 </directive> 208 </directive>
209 209
210 210
211 <directive name="error_log"> 211 <directive name="error_log">
212 <syntax><value>file</value> [<value>level</value>]</syntax> 212 <syntax>
213 <value>file</value>
214 [<value>level</value>]
215 [<literal>rate</literal>=<value>rate</value>]</syntax>
213 <default>logs/error.log error</default> 216 <default>logs/error.log error</default>
214 <context>main</context> 217 <context>main</context>
215 <context>http</context> 218 <context>http</context>
216 <context>mail</context> 219 <context>mail</context>
217 <context>stream</context> 220 <context>stream</context>
256 <note> 259 <note>
257 For <literal>debug</literal> logging to work, nginx needs to 260 For <literal>debug</literal> logging to work, nginx needs to
258 be built with <literal>--with-debug</literal>, 261 be built with <literal>--with-debug</literal>,
259 see “<link doc="debugging_log.xml"/>”. 262 see “<link doc="debugging_log.xml"/>”.
260 </note> 263 </note>
261 264 </para>
265
266 <para>
267 The <literal>rate</literal> parameter (1.27.2) specifies
268 the maximum allowed logging rate in messages per second (m/s)
269 for each worker process.
270 By default, <literal>rate=1000m/s</literal> is used.
271 Setting <value>rate</value> to 0 disables rate limiting.
272 Additionally, rate limiting is not used
273 if logging level is set to <literal>debug</literal> or
274 debugging log is enabled for the <link id="debug_connection">connection</link>.
275 </para>
276
277 <para>
262 <note> 278 <note>
263 The directive can be specified on the 279 The directive can be specified on the
264 <literal>stream</literal> level 280 <literal>stream</literal> level
265 starting from version 1.7.11, 281 starting from version 1.7.11,
266 and on the <literal>mail</literal> level 282 and on the <literal>mail</literal> level