ngx_stream_upstream_hc_module
ngx_stream_upstream_hc_module
模块(1.9.0)允许对组中服务器启用定期健康检查。服务器组必须驻留在共享内存中。
如果健康检查失败,则服务器将被视为不可用。如果为同一组服务器定义了多个健康检查,则任何一次检查失败都会使相应的服务器不可用。客户端连接不会传递给不可用的服务器,并且服务器不会处于「检查」状态。
此模块为商业订阅部分。
示例配置
使用此配置,nginx 将每 5 秒钟检查是否能与 tcp 组中的每个服务器建立 TCP 连接。如果无法与服务器建立连接,则健康检查将失败,并且服务器将被视为不可用。
可以为 UDP 协议配置健康检查:
在这种情况下,nginx 将发送 nginx health check
字符串,期望得到的响应中没有 ICMP Destination Unreachable
消息。
健康检查也可以配置为测试从服务器获得的数据。使用 match
指令单独配置测试规则,并在 health_check 指令的 match
参数中引用测试规则。
指令
health_check
对组中服务器启用定期健康检查。
支持以下可选参数:
interval=time
设置两次连续运行健康检查之间的间隔时间,默认为 5 秒。
jitter=time
设置每次运行健康检查将随机延迟的时间,默认没有延迟。
fails=number
设置指定服务器在连续运行健康检查失败次数达到
number
后,将被视为不可用,默认为 1。passes=number
设置指定服务器在连续通过健康检查次数达到
number
后,将被视为健康,默认为 1。mandatory
设置服务器的初始「检查中」(checking)状态,直到完成第一次健康检查运行(1.11.7)。客户端连接不会以「检查中」的状态传递到服务器。如果未指定该参数,则服务器初始状态将被视为健康。
port=number
定义连接到服务器执行健康检查(1.9.7)时使用的端口,默认等于服务器端口。
udp
指定将 UDP 协议代替默认的 TCP 协议(1.9.13)用于健康检查。
health_check_timeout
覆盖用于健康检查的 proxy_timeout 值。
match
定义用于验证对服务器运行健康检查返回的响应的具名测试集。
可以配置以下参数:
send string;
向服务器发送一个
string
(字符串)expect string | ~ regex;
从服务器获得的数据应匹配的文字字符串(1.9.12)或正则表达式。正则表达式以前
~*
修饰符(不区分大小写)或~
修饰符(不区分大小写)指定。
send
和 expect
参数都可以包含带有 \x
前缀的十六进制文字,后跟两个十六进制数字,例如 \x80
(1.9.12)。
如果满足以下条件,则通过健康检查:
TCP 连接建立成功
发送了来自
send
参数的string
(如果已指定)将从服务器获取的数据与来自
expect
参数的字符串或正则表达式匹配(如果已指定)经过的时间不超过 health_check_timeout 指令中指定的值
示例:
仅检查从服务器获得的数据的首个 proxy_buffer_size 字节。
原文档
http://nginx.org/en/docs/stream/ngx_stream_upstream_hc_module.html
最后更新于