模块 ngx_http_upstream_hc_module

Example Configuration Directives      health_check      match

该模块允许对 周围位置引用的组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，则健康检查将失败，服务器将被视为不健康。

可以配置运行状况检查来测试响应的状态代码、某些标头字段及其值的存在以及正文内容。使用match指令单独配置测试，并在health_checkmatch指令的参数 中引用：

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，并且Welcome to nginx!正文中包含“ ”。

指令

启用对周围位置引用的 组 中的服务器进行定期运行状况检查 。

支持以下可选参数：

interval=time

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

jitter=time

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

fails=number

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

passes=number

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

uri=uri

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

mandatory[ persistent]

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

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

match=name

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

port=number

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

type= grpc [ grpc_service= name] [ grpc_status= code]

启用对 gRPC 服务器或使用可选 参数 (1.19.5)指定的特定 gRPC 服务 进行定期 运行状况检查。grpc_service如果服务器不支持 gRPC 健康检查协议，则可以使用可选参数指定将被视为健康的 grpc_status非零 gRPC 状态 （例如，状态代码“ 12”/“ ”）：UNIMPLEMENTED

health_check mandatory type=grpc grpc_status=12;

type= 参数grpc必须在所有其他指令参数之后指定， grpc_service并且grpc_status 必须位于type=后面grpc。uri该参数与或 match参数 不兼容 。

keepalive_time=time

启用keepalive 连接以进行运行状况检查，并指定可以通过一个 keepalive 连接处理请求的时间 (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;

标头包含“Content-Type”及其值text/html

header Content-Type != text/html;

标头包含“Content-Type”，其值不是text/html

header Connection ~ close;

标头包含“Connection”，其值与正则表达式匹配close

header Connection !~ close;

标头包含“Connection”，其值与正则表达式不匹配close

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