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

设置两次连续运行状况检查之间的间隔，默认值为 5 秒。

jitter=time

设置每个运行状况检查将随机延迟的时间，默认情况下没有延迟。

fails=number

设置特定服务器连续运行状况检查失败的次数，之后该服务器将被视为不健康，默认值为 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 健康检查需要具有 match 块，其中包含 send 和 expect 参数。

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 参数，则已发送 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 字节的数据。