模块 ngx_http_upstream_hc_module

示例配置 指令      健康检查      匹配

模块ngx_http_upstream_hc_module允许启用对环境位置中引用的服务器组的定期健康检查。服务器组必须位于共享内存中。

如果健康检查失败，服务器将被认为是不健康的。如果为同一组服务器定义了多个健康检查，任何检查的单一失败都会使相应的服务器被认为是不健康的。客户端请求不会传递给不健康的服务器以及处于“检查中”的服务器。

请注意，在使用健康检查时，大多数变量将是空值。

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

示例配置

upstream dynamic {
    zone upstream_dynamic 64k;

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

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

server {
    location / {
        proxy_pass http://dynamic;
        health_check;
    }
}

根据此配置，nginx 将每五秒向backend组中的每个服务器发送“/”请求。如果发生任何通信错误或超时，或者代理服务器响应的状态码不是 2xx 或 3xx，健康检查将失败，服务器将被认为是不健康的。

健康检查可以配置为测试响应的状态码、某些头字段及其值的存在以及正文内容。使用匹配指令单独配置测试，并在health_check指令的match参数中引用：

http {
    server {
    ...
        location / {
            proxy_pass http://backend;
            health_check match=welcome;
        }
    }

    match welcome {
        status 200;
        header Content-Type = text/html;
        body ~ "Welcome to nginx!";
    }
}

此配置显示，为了健康检查通过，健康检查请求的响应应该成功，状态码为 200，并且正文中包含“欢迎使用 nginx!”。

指令

启用对环境位置中引用的服务器组的定期健康检查。

支持以下可选参数：

间隔=时间

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

抖动=时间

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

失败次数=数字

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

通过次数=数字

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

URI=URI

定义健康检查请求中使用的URI，默认为“/”。

强制 [持久]

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

参数持久（1.19.7）在重新加载后设置服务器的初始“上线”状态，如果服务器在重新加载前被认为是健康的。

匹配=名称

指定匹配块配置响应应通过的测试，以使健康检查通过。默认情况下，响应应具有状态码2xx或3xx。

端口=数字

定义用于连接服务器执行健康检查的端口（1.9.7）。默认情况下，等于服务器端口。

类型=grpc [grpc服务=名称] [grpc状态=代码]

启用周期性gRPC服务器或指定了可选的grpc服务参数的特定gRPC服务的健康检查（1.19.5）。如果服务器不支持gRPC健康检查协议，则可以使用可选的grpc状态参数指定非零的gRPC状态（例如，状态码“12” / “未实现”），将被视为健康的：

health_check mandatory type=grpc grpc_status=12;

必须在所有其他指令参数之后指定类型=grpc参数，grpc服务和grpc状态必须在类型=grpc之后。该参数与URI或匹配参数不兼容。

保持活动时间=时间

启用健康检查的保持活动连接，并指定请求可以通过一个保持活动连接处理的时间（1.21.7）。默认情况下，保持活动连接已禁用。

定义用于验证健康检查请求的响应的命名测试集。

响应中可以测试以下项目：

status 200;

状态为200

status ! 500;

状态不是500

status 200 204;

状态为200或204

status ! 301 302;

状态既不是301也不是302

status 200-399;

状态在200到399的范围内

status ! 400-599;

状态不在400到599的范围内

status 301-303 307;

状态为301、302、303或307中的一个

header Content-Type = text/html;

头部包含值为text/html的“Content-Type”

header Content-Type != text/html;

头部包含值不是text/html的“Content-Type”

header Connection ~ close;

头部包含值匹配正则表达式close的“Connection”

header Connection !~ close;

头部包含值不匹配正则表达式close的“Connection”

header Host;

头部包含“Host”

header ! X-Accel-Redirect;

头部不包含“X-Accel-Redirect”

body ~ "Welcome to nginx!";

正文与正则表达式“Welcome to nginx!”匹配

body !~ "Welcome to nginx!";

正文不与正则表达式“Welcome to nginx!”匹配

require $variable ...;

所有指定的变量都不为空且不等于“0”（1.15.9）。

如果指定了多个测试，则只有在所有测试都匹配时，响应才匹配。

仅检查响应主体的前256k。

示例：

# status is 200, content type is "text/html",
# and body contains "Welcome to nginx!"
match welcome {
    status 200;
    header Content-Type = text/html;
    body ~ "Welcome to nginx!";
}

# status is not one of 301, 302, 303, or 307, and header does not have "Refresh:"
match not_redirect {
    status ! 301-303 307;
    header ! Refresh;
}

# status ok and not in maintenance mode
match server_ok {
    status 200-399;
    body !~ "maintenance mode";
}

# status is 200 or 204
map $upstream_status $good_status {
    200 1;
    204 1;
}

match server_ok {
    require $good_status;
}