FAQ

Page Discussion History

Difference between revisions of "HttpLimitReqModule"

(Directives)
 
(One intermediate revision by one user not shown)
Line 1: Line 1:
 +
__NOINDEX__
 +
 +
<span style="color:red">WARNING: this article is obsoleted. Please refer to http://nginx.org/en/docs/ for the latest official documentation.</span>
 +
 
= Synopsis =
 
= Synopsis =
  

Latest revision as of 11:12, 10 April 2014


WARNING: this article is obsoleted. Please refer to http://nginx.org/en/docs/ for the latest official documentation.

Contents

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

http {
    limit_req_zone  $binary_remote_addr  zone=one:10m   rate=1r/s;
 
    ...
 
    server {
 
        ...
 
        location /search/ {
            limit_req   zone=one  burst=5;
        }

Directives

limit_req

Syntax: limit_req zone = name [ burst = number ] [ nodelay ]
Default:
Context: http
server
location
Reference:limit_req


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

limit_req_zone  $binary_remote_addr  zone=one:10m   rate=1r/s;
 
    server {
        location /search/ {
            limit_req   zone=one  burst=5;
        }

allows a user no more than 1 request per second on average, with bursts of no more than 5 requests.

If delaying excess requests within a burst is not necessary, you should use the option nodelay:

            limit_req   zone=one  burst=5  nodelay;

limit_req_log_level

Syntax: limit_req_log_level info | notice | warn | error
Default: error
Context: http
server
location
Appeared in: 0.8.18
Reference:limit_req_log_level


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

Syntax: limit_req_zone $variable zone = name : size rate = rate
Default:
Context: http
Reference:limit_req_zone


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:

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

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".

References

Original Documentation