Upstream Probe

该模块为 stream_upstream 实现主动健康探针。

配置示例

server {
    listen ...;

    # ...
    proxy_pass backend;
    upstream_probe_timeout 1s;

    upstream_probe backend_probe
        port=12345
        interval=5s
        test=$good
        essential
        fails=3
        passes=3
        max_response=512k
        mode=onfail
        "send=data:GET / HTTP/1.0\r\n\r\n";
}

备注

根据 RFC 2616（HTTP/1.1）和 RFC 9110（HTTP 语义）规范， HTTP 头部必须使用 CRLF 序列（\r\n）进行分隔，而不能仅使用 \n。

指令

upstream_probe (PRO)

语法	upstream_probe name [port=number] [interval=time] [test=condition] [essential [persistent]] [fails=number] [passes=number] [max_response=size] [mode=always | idle | onfail] [udp] [send=string];
默认	—
上下文	server

定义一个针对 upstream 组内服务器的主动健康探针， 该组在与 upstream_probe 指令相同的 server 上下文中通过 proxy_pass 指令指定。

如果向服务器的请求成功，并考虑到 upstream_probe 指令的所有参数设置以及影响 server 上下文如何使用上游的所有参数，包括 proxy_next_upstream 指令，则服务器通过探针。

为了使用探针，上游必须具有共享内存区域 (zone)。 一个上游可以配置多个探针。

接受以下参数：

name	探针的必需名称。
port	探针请求的备用端口号。
interval	探针之间的 间隔。 默认值 — 5s。
test	探针的条件，定义为变量字符串。 如果变量替换结果为 "" 或 "0"，则探针不通过。
essential	如果设置，则检查服务器的初始状态，因此在探针通过之前，服务器不会接收客户端请求。
persistent	设置此参数需要先启用 essential； 在 配置重载 之前被认为健康的 persistent 服务器开始接收请求，而无需先通过此探针。
fails	使服务器不健康的连续失败探针次数。 默认值 — 1。
passes	使服务器健康的连续通过探针次数。 默认值 — 1。
max_response	响应的最大内存大小。如果指定零 值，则禁用响应等待。 默认值 — 256k。
mode	探针模式，取决于服务器的健康状态： always — 无论状态如何都探测服务器； idle — 探测不健康的服务器和自上次客户端请求以来经过 interval 的服务器。 onfail — 仅探测不健康的服务器。 默认值 — always。
udp	如果指定，则使用UDP协议进行探测。 默认情况下，使用TCP进行探测。
send	用于检查的数据； 这可以是带有前缀 data: 的字符串或带有数据的文件名 （绝对指定或相对于 /usr/local/angie/ 目录）。

示例：

upstream backend {
    zone backend 1m;

    server a.example.com;
    server b.example.com;
}

map $upstream_probe_response $good {
    ~200    "1";
    default  "";
}

server {
    listen ...;

    # ...
    proxy_pass backend;
    upstream_probe_timeout 1s;

    upstream_probe backend_probe
        port=12345
        interval=5s
        test=$good
        essential
        persistent
        fails=3
        passes=3
        max_response=512k
        mode=onfail
        "send=data:GET / HTTP/1.0\r\n\r\n";
}

探针操作细节：

• 最初，服务器在通过为其配置的 所有 essential 探针之前不会接收客户端请求， 如果配置被重载并且服务器在此之前被认为是健康的，则跳过 persistent 探针。 如果没有这样的探针，则认为服务器是健康的。

• 如果为服务器配置的 任何 探针达到 fails 或服务器达到 max_fails，则该服务器被认为是不健康的，不会接收客户端请求。

• 为了使不健康的服务器再次被认为是健康的， 为其配置的 所有 探针必须达到各自的 passes； 之后，还会考虑 max_fails。

upstream_probe_timeout (PRO)

语法	upstream_probe_timeout time;
默认值	upstream_probe_timeout 50s;
上下文	server

为使用 upstream_probe (PRO) 指令配置的健康检查设置与服务器建立连接的最大空闲 时间；如果超过此限制，连接将被关闭。

内置变量

stream_upstream 模块支持以下内置变量：

$upstream_probe (PRO)

当前活动的 upstream_probe 的名称。

$upstream_probe_response (PRO)

在由 upstream_probe 配置的主动探针期间接收到的响应内容。