ngx_stream_upstream_hc_module 模块

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

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

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

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=time

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

jitter=time

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

fails=number

设置某个服务器连续失败的健康检查次数，达到该次数后此服务器将被视为不健康，默认为 1。

passes=number

设置某个服务器连续通过的健康检查次数，达到该次数后该服务器将被视为健康，默认为 1。

mandatory [persistent]

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

persistent 参数 (1.21.1) 设置服务器在重新加载后的初始“up”状态，前提是重新加载前服务器被视为健康。

match=name

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

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

port=number

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

udp

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

health_check_timeout 5s;

覆盖健康检查的 proxy_timeout 值。

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

可以配置以下参数

send string;

向服务器发送一个 string；

expect string | ~ regex;

从服务器获得的数据应匹配的字面字符串 (1.9.12) 或正则表达式。正则表达式使用前导的“*”修饰符（用于不区分大小写的匹配）或“~”修饰符（用于区分大小写的匹配）指定。

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

健康检查通过的条件是

• 成功建立 TCP 连接；
• 如果指定了 send 参数中的 string，该字符串已被发送；
• 如果指定了 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 字节。