模块 ngx_http_limit_req_module
示例配置 指令 limit_req limit_req_dry_run limit_req_log_level limit_req_status limit_req_zone 嵌入变量 |
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 |
---|---|
默认值 | — |
上下文 |
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 |
---|---|
默认值 |
limit_req_dry_run off; |
上下文 |
http 、server 、location |
此指令出现在 1.17.1 版本中。
启用试运行模式。在此模式下,不会限制请求处理速率,但是,在共享内存区域中,过多的请求数量将照常计算。
语法 |
limit_req_log_level |
---|---|
默认值 |
limit_req_log_level error; |
上下文 |
http 、server 、location |
此指令出现在 0.8.18 版本中。
设置服务器由于速率超过而拒绝处理请求或延迟请求处理时的所需日志级别。延迟的日志级别比拒绝的日志级别低一点;例如,如果指定了“limit_req_log_level notice
”,则延迟将以 info
级别记录。
语法 |
limit_req_status |
---|---|
默认值 |
limit_req_status 503; |
上下文 |
http 、server 、location |
此指令出现在 1.3.15 版本中。
设置返回给拒绝请求的响应的状态码。
语法 |
limit_req_zone |
---|---|
默认值 | — |
上下文 |
http |
设置用于共享内存区域的参数,该区域将保留各种键的状态。特别是,状态存储当前过多的请求数。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
。$binary_remote_addr
变量的大小对于 IPv4 地址始终为 4 字节,对于 IPv6 地址始终为 16 字节。存储的状态在 32 位平台上始终占用 64 字节,在 64 位平台上始终占用 128 字节。1 兆字节区域可以保存大约 16000 个 64 字节状态或大约 8000 个 128 字节状态。
如果区域存储已用完,则会删除最近最少使用过的状态。即使在那之后也无法创建新状态,请求将以 错误 终止。
速率以每秒请求数 (r/s) 表示。如果需要低于每秒一个请求的速率,则以每分钟请求数 (r/m) 表示。例如,每秒半个请求是 30r/m。
sync
参数 (1.15.3) 启用共享内存区域的 同步。
sync
参数作为我们 商业订阅 的一部分提供。
此外,作为我们 商业订阅 的一部分,每个此类共享内存区域的 状态信息 可以使用 API 自 1.17.7 版本起 获取 或 重置。
嵌入变量
$limit_req_status
- 保留限制请求处理速率的结果 (1.17.6):
PASSED
、DELAYED
、REJECTED
、DELAYED_DRY_RUN
或REJECTED_DRY_RUN