Module 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 地址的请求的处理速率。使用“漏斗”方法完成限制。

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

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

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指令时，这些指令才从上一级继承。

该指令出现在 1.17.1 版中。

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

该指令出现在版本 0.8.18 中。

在服务器由于速率超出而拒绝处理请求或延迟请求处理的情况下，设置所需的日志记录级别。延迟记录比拒绝记录少 1 分；例如，如果指定“ limit_req_log_level notice”，则以info级别记录延迟。

该指令出现在 1.3.15 版中。

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

设置共享内存区域的参数，该参数将保留各种键的状态。特别是，状态存储了当前过多请求的数量。 key可以包含文本，变量及其组合。密钥值为空的请求不予考虑。

Usage example:

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

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

客户端 IP 地址用作密钥。请注意，此处使用$binary_remote_addr变量代替$remote_addr。 $binary_remote_addr变量的大小对于 IPv4 地址始终为 4 个字节，对于 IPv6 地址始终为 16 个字节。存储状态在 32 位平台上始终占据 64 字节，在 64 位平台上始终占据 128 字节。一个 1 兆字节的区域可以保留约 1.6 万个 64 字节状态或约 8000 个 128 字节状态。

如果区域存储已用尽，则删除最近最少使用的状态。如果即使在此之后仍无法创建新状态，则请求将以error终止。

该速率以每秒请求数(r/s)指定。如果希望速率小于每秒一个请求，则以每分钟请求数(r/m)来指定。例如，每秒半请求为 30r/m。

sync参数(1.15.3)启用共享存储区的synchronization。

Embedded Variables

$limit_req_status

• 保留限制请求处理速率(1.17.6)的结果：PASSED，DELAYED，REJECTED，DELAYED_DRY_RUN或REJECTED_DRY_RUN