HttpLimitReqModule - Revision history

Admin: /* Directives */

2012-05-11T07:54:46Z

‎Directives

Admin: /* limit_req_zone */

2012-05-11T07:54:15Z

‎limit_req_zone

Admin: /* limit_req */

2012-05-11T07:53:59Z

‎limit_req

Admin: /* limit_req_zone */

2012-05-11T07:52:58Z

‎limit_req_zone

Admin: /* Directives */

2012-05-02T19:32:40Z

‎Directives

Admin: /* limit_req_zone */

2012-04-30T15:46:15Z

‎limit_req_zone

Admin: /* Directives */

2012-04-30T15:45:48Z

‎Directives

VBart: Added link to the original documentation

2012-04-21T15:29:51Z

Added link to the original documentation

Olau: Fix up explanation of limit_req to be more clear /* Directives */

2012-01-16T12:17:22Z

Fix up explanation of limit_req to be more clear - ‎Directives

Samael at 09:57, 13 August 2011

2011-08-13T09:57:41Z

New page

= Synopsis =

This module allows you to limit the number of requests for a given session, or as a special case, with one address.

Restriction done using leaky bucket.

= Example Configuration =

<geshi lang="nginx">
http {
limit_req_zone $binary_remote_addr zone=one:10m rate=1r/s;

...

server {

...

location /search/ {
limit_req zone=one burst=5;
}
</geshi>

= Directives =
'''Syntax:''' ''limit_req_log_level '''info|notice|warn|error'''''

'''Default:''' ''warn''

'''Context:''' ''http''

Controls the log level of the rejected requests. Delayed requests are logged at the next less severe level, though, for example when limit_req_log_level is set to "error", delayed requests are logged at "warn".

'''Syntax:''' ''limit_req_zone '''$session_variable''' zone='''name_of_zone''':'''size''' rate='''rate'''''

'''Default:''' ''none''

'''Context:''' ''http''

The directive describes the area, which stores the state of the sessions. The values of the sessions is determined by the given variable. Example of usage:

<pre>
limit_req_zone $binary_remote_addr zone=one:10m rate=1r/s;
</pre>

In this case, the session state is allocated 10MB as a zone called "one", and the average speed of queries for this zone is limited to 1 request per second.

The sessions are tracked per-user in this case, but note that instead of the variable $remote_addr, we've used the variable $binary_remote_addr, reducing the size of the state to 64 bytes. A 1 MB zone can hold approximately 16000 states of this size.

The speed is set in requests per second or requests per minute. The rate must be an integer, so if you need to specify less than one request per second, say, one request every two seconds, you would specify it as "30r/m".

'''Syntax:''' ''limit_req zone='''zone''' burst='''burst''' [nodelay]''

'''Default:''' ''none''

'''Context:''' ''http, server, location''

The directive specifies the zone ('''zone''') and the maximum possible bursts of requests (burst). If the rate exceeds the demands outlined in the zone, the request is delayed, so that queries are processed at a given speed. Excess requests are delayed until their number does not exceed a specified number of bursts. In this case the request is completed the code "Service unavailable" (503). By default, the burst is zero.

For example, the directive

<geshi lang="nginx">
limit_req_zone $binary_remote_addr zone=one:10m rate=1r/s;

server {
location /search/ {
limit_req zone=one burst=5;
}

</geshi>

allows a user no more than 1 request per second on average, with bursts of no more than 5 queries.
If the excess requests within the limit burst delay are not necessary, you should use the nodelay:

<pre>
limit_req zone=one burst=5 nodelay;
</pre>

@@ Line 23: / Line 23: @@
 = Directives =
 == limit_req ==
 <include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_limit_req_module/limit_req.txt" />
@@ Line 68: / Line 47: @@
              limit_req   zone=one  burst=5  nodelay;
 </pre>
 = References =
 [http://nginx.org/en/docs/http/ngx_http_limit_req_module.html Original Documentation]

@@ Line 44: / Line 44: @@
 The speed is set in requests per second or requests per minute. The rate must be an integer, so if you need to specify less than one request per second, say, one request every two seconds, you would specify it as "30r/m".
-== limit_req_zone ==
+== limit_req ==
-<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_limit_req_module/limit_req_zone.txt" />
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_limit_req_module/limit_req.txt" />
 The directive specifies the zone ('''zone''') and the maximum possible bursts of requests (burst). If the rate exceeds the demands outlined in the zone, the request is delayed, so that queries are processed at a given speed. Excess requests are delayed while their number does not exceed a specified number of bursts. If the number of waiting requests exceed burst, the request is completed with the code 503 "Service Temporarily Unavailable". By default, the burst is zero.

@@ Line 29: / Line 29: @@
 Controls the log level of the rejected requests. Delayed requests are logged at the next less severe level, though, for example when limit_req_log_level is set to "error", delayed requests are logged at "warn".
-== limit_req ==
+== limit_req_zone ==
-<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_limit_req_module/limit_req.txt" />
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_limit_req_module/limit_req_zone.txt" />
 The directive describes the area, which stores the state of the sessions. The values of the sessions is determined by the given variable. Example of usage:

@@ Line 29: / Line 29: @@
 Controls the log level of the rejected requests. Delayed requests are logged at the next less severe level, though, for example when limit_req_log_level is set to "error", delayed requests are logged at "warn".
-== limit_req_zone ==
+== limit_req ==
-<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_limit_req_module/limit_req_zone.txt" />
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_limit_req_module/limit_req.txt" />
 The directive describes the area, which stores the state of the sessions. The values of the sessions is determined by the given variable. Example of usage:

@@ Line 25: / Line 25: @@
 == limit_req_log_level ==
-<include wikitext nopre src="http://wiki.nginx.org/nginx.org/ngx_http_limit_req_module/limit_req_log_level.txt" />
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_limit_req_module/limit_req_log_level.txt" />
 Controls the log level of the rejected requests. Delayed requests are logged at the next less severe level, though, for example when limit_req_log_level is set to "error", delayed requests are logged at "warn".
 == limit_req_zone ==
-<include wikitext nopre src="http://wiki.nginx.org/nginx.org/ngx_http_limit_req_module/limit_req_zone.txt" />
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_limit_req_module/limit_req_zone.txt" />
 The directive describes the area, which stores the state of the sessions. The values of the sessions is determined by the given variable. Example of usage:
@@ Line 45: / Line 45: @@
 == limit_req_zone ==
-<include wikitext nopre src="http://wiki.nginx.org/nginx.org/ngx_http_limit_req_module/limit_req_zone.txt" />
+<include wikitext nopre src="http://wiki.nginx.org/nginx.org/http/ngx_http_limit_req_module/limit_req_zone.txt" />
 The directive specifies the zone ('''zone''') and the maximum possible bursts of requests (burst). If the rate exceeds the demands outlined in the zone, the request is delayed, so that queries are processed at a given speed. Excess requests are delayed while their number does not exceed a specified number of bursts. If the number of waiting requests exceed burst, the request is completed with the code 503 "Service Temporarily Unavailable". By default, the burst is zero.

← Older revision		Revision as of 15:29, 21 April 2012
Line 77:		Line 77:
	limit_req zone=one burst=5 nodelay;		limit_req zone=one burst=5 nodelay;
	</pre>		</pre>
		+
		+	= References =
		+
		+	[http://nginx.org/en/docs/http/ngx_http_limit_req_module.html Original Documentation]

@@ Line 56: / Line 56: @@
 '''Context:''' ''http, server, location''
-The directive specifies the zone ('''zone''') and the maximum possible bursts of requests (burst). If the rate exceeds the demands outlined in the zone, the request is delayed, so that queries are processed at a given speed. Excess requests are delayed until their number does not exceed a specified number of bursts. In this case the request is completed the code "Service unavailable" (503). By default, the burst is zero.
+The directive specifies the zone ('''zone''') and the maximum possible bursts of requests (burst). If the rate exceeds the demands outlined in the zone, the request is delayed, so that queries are processed at a given speed. Excess requests are delayed while their number does not exceed a specified number of bursts. If the number of waiting requests exceed burst, the request is completed with the code 503 "Service Temporarily Unavailable". By default, the burst is zero.
 For example, the directive
@@ Line 70: / Line 70: @@
 </geshi>
-allows a user no more than 1 request per second on average, with bursts of no more than 5 queries.
+allows a user no more than 1 request per second on average, with bursts of no more than 5 requests.
-If the excess requests within the limit burst delay are not necessary, you should use the nodelay:
 <pre>
              limit_req   zone=one  burst=5  nodelay;
 </pre>