模块 ngx_stream_upstream_hc_module

ngx_stream_upstream_hc_module 模块 (1.9.0) 允许对 组 中的服务器启用定期健康检查。服务器组必须驻留在 共享内存 中。

如果健康检查失败，则服务器将被视为不健康。如果为同一组服务器定义了多个健康检查，则任何检查的单个失败都将导致相应的服务器被视为不健康。客户端连接不会传递到不健康的服务器和处于“检查”状态的服务器。

此模块作为我们 商业订阅 的一部分提供。

upstream tcp {
    zone upstream_tcp 64k;

    server backend1.example.com:12345 weight=5;
    server backend2.example.com:12345 fail_timeout=5s slow_start=30s;
    server 192.0.2.1:12345            max_fails=3;

    server backup1.example.com:12345  backup;
    server backup2.example.com:12345  backup;
}

server {
    listen     12346;
    proxy_pass tcp;
    health_check;
}

使用此配置，Nginx 将每五秒检查一次与 tcp 组中每个服务器建立 TCP 连接的能力。当无法建立与服务器的连接时，健康检查将失败，并且服务器将被视为不健康。

可以为 UDP 协议配置健康检查

upstream dns_upstream {

    zone   dns_zone 64k;

    server dns1.example.com:53;
    server dns2.example.com:53;
    server dns3.example.com:53;
}

server {
    listen       53 udp;
    proxy_pass   dns_upstream;
    health_check udp;
}

在这种情况下，预期对发送的字符串“nginx health check”的回复中没有 ICMP“Destination Unreachable”消息。

还可以配置健康检查以测试从服务器获取的数据。使用 match 指令单独配置测试，并在 health_check 指令的 match 参数中引用。

启用对 组 中的服务器进行定期健康检查。

支持以下可选参数

interval=时间

设置两次连续健康检查之间的时间间隔，默认为 5 秒。

jitter=时间

设置每个健康检查将随机延迟的时间，默认为没有延迟。

fails=数字

设置特定服务器连续失败的健康检查次数，在此之后该服务器将被视为不健康，默认为 1。

passes=数字

设置特定服务器连续通过的健康检查次数，在此之后该服务器将被视为健康，默认为 1。

mandatory [persistent]

设置服务器的初始“检查”状态，直到完成第一次健康检查（1.11.7）。客户端连接不会传递到处于“检查”状态的服务器。如果未指定该参数，则服务器将最初被视为健康。

persistent 参数 (1.21.1) 在重新加载后为服务器设置初始“正常”状态，如果服务器在重新加载之前被视为健康。

match=名称

指定配置测试的 match 块，成功的连接应通过这些测试才能使健康检查通过。默认情况下，对于 TCP，仅检查与服务器建立 TCP 连接的能力。对于 UDP，预期对发送的字符串“nginx health check”的回复中没有 ICMP“Destination Unreachable”消息。

在 1.11.7 版本之前，默认情况下，UDP 健康检查需要一个带有 send 和 expect 参数的 match 块。

port=数字

定义连接到服务器以执行健康检查时使用的端口 (1.9.7)。默认情况下，等于 server 端口。

udp

指定应使用 UDP 协议进行健康检查，而不是默认的 TCP 协议 (1.9.13)。

health_check_timeout 5s;

覆盖健康检查的 proxy_timeout 值。

定义用于验证服务器对健康检查响应的命名测试集。

可以配置以下参数

send 字符串;

向服务器发送一个 字符串;

expect 字符串 | ~ 正则表达式;

从服务器获取的数据应匹配的字面字符串 (1.9.12) 或正则表达式。正则表达式以“~*”修饰符（进行不区分大小写的匹配）或“~”修饰符（进行区分大小写的匹配）开头指定。

send 和 expect 参数都可以包含以“\x”后跟两位十六进制数字为前缀的十六进制文字，例如“\x80” (1.9.12)。

如果以下条件满足，则健康检查通过

• 成功建立 TCP 连接；
• 如果已指定，则发送了 send 参数中的 字符串；
• 如果已指定，则从服务器获取的数据与 expect 参数中的字符串或正则表达式匹配；
• 经过的时间不超过 health_check_timeout 指令中指定的值。

示例

upstream backend {
    zone     upstream_backend 10m;
    server   127.0.0.1:12345;
}

match http {
    send     "GET / HTTP/1.0\r\nHost: localhost\r\n\r\n";
    expect ~ "200 OK";
}

server {
    listen       12346;
    proxy_pass   backend;
    health_check match=http;
}

仅检查从服务器获取的前 proxy_buffer_size 字节数据。