ngx_http_upstream_hc_module

Module ngx_http_upstream_hc_module

• 示例配置

• 指令

• health_check

• 匹配

该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指令单独配置，并在matchhealth_check指令的参数中引用：

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设置特定服务器连续通过的运行状况检查的次数，在此之后服务器将被视为健康，默认uri值为1. = uri定义健康检查请求中使用的URI，默认为“ /”。mandatory设置服务器的初始“检查”状态，直到第一次健康状况检查完成（1.11.7）。客户端请求不会以“检查”状态传递给服务器。如果未指定参数，则服务器最初将被视为健康。match= name指定match配置响应应通过的测试的块，以便运行状况检查通过。默认情况下，响应应该有状态代码2xx或3xx。port= number定义连接到服务器以执行健康检查时使用的端口（1.9.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/htmlheader Content-Type != text/html;头的“Content-Type”包含“Content-Type”，其值不是text/htmlheader Connection ~ close;包含头的值“Connection”，值与匹配正则表达式的closeheader Connection !~ close;头包含“Connection”，值不匹配正则表达式closeheader Host;头包含“主机” header ! X-Accel-Redirect;头缺少“X-Accel “-Redirect” body ~ "Welcome to nginx!";正文匹配正则表达式“ Welcome to nginx!” body !~ "Welcome to nginx!";正文不匹配正则表达式“ Welcome to nginx!”

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

只检查响应主体的第一个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";
}