comparison xml/en/docs/http/ngx_http_limit_req_module.xml @ 2291:3294470932c5

Documented the "delay" parameter for limit_req.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 27 Nov 2018 20:31:05 +0300
parents 283b1e67eaa6
children f86b5961e9b8
comparison
equal deleted inserted replaced
2290:65c6c1ee3c78 2291:3294470932c5
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9 9
10 <module name="Module ngx_http_limit_req_module" 10 <module name="Module ngx_http_limit_req_module"
11 link="/en/docs/http/ngx_http_limit_req_module.html" 11 link="/en/docs/http/ngx_http_limit_req_module.html"
12 lang="en" 12 lang="en"
13 rev="9"> 13 rev="10">
14 14
15 <section id="summary"> 15 <section id="summary">
16 16
17 <para> 17 <para>
18 The <literal>ngx_http_limit_req_module</literal> module (0.7.21) is used 18 The <literal>ngx_http_limit_req_module</literal> module (0.7.21) is used
51 51
52 <directive name="limit_req"> 52 <directive name="limit_req">
53 <syntax> 53 <syntax>
54 <literal>zone</literal>=<value>name</value> 54 <literal>zone</literal>=<value>name</value>
55 [<literal>burst</literal>=<value>number</value>] 55 [<literal>burst</literal>=<value>number</value>]
56 [<literal>nodelay</literal>]</syntax> 56 [<literal>nodelay</literal> |
57 <literal>delay</literal>=<value>number</value>]</syntax>
57 <default/> 58 <default/>
58 <context>http</context> 59 <context>http</context>
59 <context>server</context> 60 <context>server</context>
60 <context>location</context> 61 <context>location</context>
61 62
89 <example> 90 <example>
90 limit_req zone=one burst=5 nodelay; 91 limit_req zone=one burst=5 nodelay;
91 </example> 92 </example>
92 </para> 93 </para>
93 94
95 <para id="limit_req_delay">
96 The <literal>delay</literal> parameter (1.15.7) specifies a limit
97 at which excessive requests become delayed.
98 Default value is zero, i.e. all excessive requests are delayed.
99 </para>
100
94 <para> 101 <para>
95 There could be several <literal>limit_req</literal> directives. 102 There could be several <literal>limit_req</literal> directives.
96 For example, the following configuration will limit the processing rate 103 For example, the following configuration will limit the processing rate
97 of requests coming from a single IP address and, at the same time, 104 of requests coming from a single IP address and, at the same time,
98 the request processing rate by the virtual server: 105 the request processing rate by the virtual server: