模块 ngx_stream_upstream_hc_module

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

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

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

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;
}

tcp通过此配置，nginx 将每五秒 检查一次与组中每个服务器建立 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;
}

Destination Unreachable在这种情况下，在回复发送的字符串“ ”时预计 不会出现 ICMP“ ”消息nginx health check。

还可以配置运行状况检查来测试从服务器获取的数据。使用match指令单独配置测试，并在health_checkmatch指令的参数中引用。

启用组 中服务器的定期运行状况检查 。

支持以下可选参数：

interval=time

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

jitter=time

设置每次健康检查随机延迟的时间，默认不延迟。

fails=number

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

passes=number

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

mandatory[ persistent]

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

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

match=name

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

在版本 1.11.7 之前，默认情况下，UDP 运行状况检查需要带有send和Expect参数的匹配块 。

port=number

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

udp

UDP指定应使用 该协议而不是默认TCP协议（1.9.13）进行健康检查。

health_check_timeout 5s;

覆盖 运行状况检查的proxy_timeout 值。

定义用于验证服务器对运行状况检查的响应的命名测试集。

可以配置以下参数：

send string;

发送 astring到服务器；

expect string| ~ regex;

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

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

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

• TCP连接成功建立；
• fromstring参数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字节。