模块 ngx_http_limit_req_module

Example Configuration
Directives
     limit_req
     limit_req_dry_run
     limit_req_log_level
     limit_req_status
     limit_req_zone
Embedded Variables

ngx_http_limit_req_module模块(0.7.21)用于限制每个定义的密钥的请求处理速率,特别是来自单个IP地址的请求的处理速率。该限制是使用“漏桶”方法完成的。

配置示例

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

    ...

    server {

        ...

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

指令

句法: limit_req zone=name [burst=number] [nodelay | delay=number];
默认:
语境: http, server,location

设置共享内存区域和请求的最大突发大小。如果请求速率超过为区域配置的速率,则会延迟其处理,以便以定义的速率处理请求。过多的请求会被延迟,直到其数量超过最大突发大小,在这种情况下,请求会因错误而 终止。默认情况下,最大突发大小等于零。例如,指令

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

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

平均每秒不超过 1 个请求,突发不超过 5 个请求。

如果不希望在请求受到限制时延迟过多的请求,nodelay则应使用该参数:

limit_req zone=one burst=5 nodelay;

参数delay(1.15.7) 指定过多请求被延迟的限制。默认值为零,即所有过多的请求都会被延迟。

可能有多个limit_req指令。例如,以下配置将限制来自单个IP地址的请求的处理速率,同时限制虚拟服务器的请求处理速率:

limit_req_zone $binary_remote_addr zone=perip:10m rate=1r/s;
limit_req_zone $server_name zone=perserver:10m rate=10r/s;

server {
    ...
    limit_req zone=perip burst=5 nodelay;
    limit_req zone=perserver burst=10;
}

当且仅当当前级别上没有limit_req定义任何指令时,这些指令才会从先前的配置级别继承。

句法: limit_req_dry_run on | off;
默认:
limit_req_dry_run off;
语境: http, server,location

该指令出现在版本 1.17.1 中。

启用试运行模式。在这种模式下,请求处理速率不受限制,但是在共享内存区域中,过多的请求数量照常计算。

句法: limit_req_log_level info | notice | warn | error;
默认:
limit_req_log_level error;
语境: http, server,location

该指令出现在0.8.18版本中。

针对服务器因速率超出而拒绝处理请求或延迟请求处理的情况设置所需的日志记录级别。延迟的记录级别比拒绝的记录级别低 1 分;例如,如果limit_req_log_level notice指定“ ”,则延迟会随info级别一起记录。

句法: limit_req_status code;
默认:
limit_req_status 503;
语境: http, server,location

该指令出现在 1.3.15 版本中。

设置响应被拒绝的请求而返回的状态代码。

句法: limit_req_zone key zone=name:size rate=rate [sync];
默认:
语境: http

设置共享内存区域的参数,该区域将保留各个键的状态。特别是,状态存储当前过量请求的数量。可以key包含文本、变量及其组合。不考虑具有空键值的请求。

在版本 1.7.6 之前,akey只能包含一个变量。

使用示例:

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

这里,状态被保存在一个10兆字节的区域“one”中,并且该区域的平均请求处理速率不能超过每秒1个请求。

客户端 IP 地址用作密钥。$remote_addr请注意, 此处使用的是变量,而不是$binary_remote_addr。对于 IPv4 地址,变量$binary_remote_addr的大小始终为 4 字节;对于 IPv6 地址,变量的大小始终为 16 字节。存储的状态在 32 位平台上始终占用 64 字节,在 64 位平台上始终占用 128 字节。1 MB 区域可以保存大约 16,000 个 64 字节状态或大约 8,000 个 128 字节状态。

如果区域存储耗尽,则删除最近最少使用的状态。如果即使在此之后仍无法创建新状态,则请求将因错误而终止。

该速率以每秒请求数 (r/s) 为单位指定。如果需要每秒少于一个请求的速率,则以每分钟请求 (r/m) 的形式指定。例如每秒半请求为30r/m。

参数sync(1.15.3)启用 共享内存区域的 同步。

该参数作为我们商业订阅sync的一部分提供 。

此外,作为我们 商业订阅的一部分, 自 1.17.7 起 ,可以 使用API获取重置每个此类共享内存区域的状态信息

嵌入变量

$limit_req_status
保留限制请求处理速率的结果 (1.17.6): PASSED, DELAYED, REJECTED, DELAYED_DRY_RUN, 或 REJECTED_DRY_RUN