模块 ngx_http_limit_req_module

ngx_http_limit_req_module 模块 (0.7.21) 用于限制按定义键的请求处理速率，特别是限制来自单个 IP 地址的请求处理速率。此限制使用“漏桶”（leaky bucket）方法完成。

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 $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 off;

启用模拟运行模式。在此模式下，请求处理速率不受限制，但在共享内存区域中，超额请求的数量会照常被统计。

limit_req_log_level error;

设置服务器因速率超限而拒绝处理请求或延迟处理请求时的期望日志级别。延迟的日志级别比拒绝的日志级别低一级；例如，如果指定“limit_req_log_level notice”，则延迟将以 info 级别记录日志。

limit_req_status 503;

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

设置共享内存区域的参数，该区域将保留各种键的状态。特别是，状态存储当前超额请求的数量。key 可以包含文本、变量及其组合。键值为空的请求不被统计。

在 1.7.6 版本之前，key 只能包含一个变量。

使用示例

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

在此，状态保存在一个 10 兆字节的区域“one”中，此区域的平均请求处理速率不能超过每秒 1 个请求。

客户端 IP 地址用作键。请注意，这里使用的是 $binary_remote_addr 变量而不是 $remote_addr。对于 IPv4 地址，$binary_remote_addr 变量的大小总是 4 字节；对于 IPv6 地址，大小总是 16 字节。存储的状态在 32 位平台上总是占用 64 字节，在 64 位平台上总是占用 128 字节。一个兆字节的区域可以存储约 1.6 万个 64 字节状态或约 8 千个 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