模块 ngx_stream_upstream_module

ngx_stream_upstream_module 模块 (1.9.0) 用于定义可由 proxy_pass 指令引用的服务器组。

upstream backend {
    hash $remote_addr consistent;

    server backend1.example.com:12345  weight=5;
    server backend2.example.com:12345;
    server unix:/tmp/backend3;

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

server {
    listen 12346;
    proxy_pass backend;
}

动态可配置组，具有定期 运行状况检查，作为我们的 商业订阅 的一部分提供

resolver 10.0.0.1;

upstream dynamic {
    zone upstream_dynamic 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 backend3.example.com:12345 resolve;
    server backend4.example.com       service=http resolve;

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

server {
    listen 12346;
    proxy_pass dynamic;
    health_check;
}

定义服务器组。服务器可以在不同的端口上侦听。此外，可以在 TCP 和 UNIX 域套接字上侦听的服务器可以混合使用。

示例

upstream backend {
    server backend1.example.com:12345 weight=5;
    server 127.0.0.1:12345            max_fails=3 fail_timeout=30s;
    server unix:/tmp/backend2;
    server backend3.example.com:12345 resolve;

    server backup1.example.com:12345  backup;
}

默认情况下，使用加权循环负载平衡方法在服务器之间分配连接。在上面的示例中，每个 7 个连接将按如下方式分配：5 个连接转到 backend1.example.com:12345，每个连接到第二个和第三个服务器。如果在与服务器通信期间发生错误，连接将传递到下一个服务器，依此类推，直到尝试所有正在运行的服务器。如果与所有服务器的通信都失败，则连接将关闭。

定义服务器的 address 和其他 parameters。地址可以指定为具有强制端口的域名或 IP 地址，或指定为在“unix:”前缀后指定的 UNIX 域套接字路径。解析为多个 IP 地址的域名一次定义多个服务器。

可以定义以下参数

weight=number

设置服务器的权重，默认为 1。

max_conns=number

限制与代理服务器的最大 number 个并发连接（1.11.5）。默认值为零，表示没有限制。如果服务器组不驻留在 共享内存 中，则限制适用于每个工作进程。

在 1.11.5 版本之前，此参数作为我们 商业订阅 的一部分提供。

max_fails=number

设置在 fail_timeout 参数设置的持续时间内与服务器通信失败的次数，以将服务器视为在 fail_timeout 参数也设置的持续时间内不可用。默认情况下，失败尝试次数设置为 1。零值禁用尝试计数。在此，失败尝试是在与服务器建立连接时发生的错误或超时。

fail_timeout=time

集合

• 在与服务器通信的指定次数失败期间，将服务器视为不可用；
• 以及服务器将被视为不可用的时间段。

默认情况下，该参数设置为 10 秒。

备份

将服务器标记为备份服务器。当主服务器不可用时，将传递到备份服务器的连接。

该参数不能与 哈希 和 随机 负载均衡方法一起使用。

关闭

将服务器标记为永久不可用。

此外，以下参数作为我们的 商业订阅 的一部分提供

解析

监视与服务器的域名相对应的 IP 地址的更改，并在无需重新启动 nginx 的情况下自动修改上游配置。服务器组必须驻留在 共享内存 中。

为了使此参数生效，必须在 流 块或相应的 上游 块中指定 resolver 指令。

service=name

启用 DNS SRV 记录解析，并设置服务 name (1.9.13)。为了使此参数生效，有必要为服务器指定 解析 参数，并指定不带端口号的主机名。

如果服务名称不包含点（“.”），则构造 RFC 兼容的名称，并将 TCP 协议添加到服务前缀。例如，要查找 _http._tcp.backend.example.com SRV 记录，有必要指定指令

server backend.example.com service=http resolve;

如果服务名称包含一个或多个点，则通过连接服务前缀和服务器名称来构造名称。例如，要查找 _http._tcp.backend.example.com 和 server1.backend.example.com SRV 记录，有必要指定指令

server backend.example.com service=_http._tcp resolve;
server example.com service=server1.backend resolve;

最高优先级的 SRV 记录（具有相同最低优先级值的记录）解析为主要服务器，其余 SRV 记录解析为备份服务器。如果为服务器指定了 备份 参数，则高优先级 SRV 记录解析为备份服务器，其余 SRV 记录将被忽略。

slow_start=time

设置服务器从零恢复到标称值的时间，当不健康的服务器变为健康时，或当服务器在一段时间后变为可用，而在此之前被认为不可用。默认值为零，即禁用缓慢启动。

该参数不能与 哈希 和 随机 负载均衡方法一起使用。

如果组中只有一个服务器，则忽略max_fails、fail_timeout和slow_start参数，并且永远不会将这样的服务器视为不可用。

定义共享内存区域的名称和大小，该区域保存组的配置和在工作进程之间共享的运行时状态。多个组可以共享同一个区域。在这种情况下，只需指定一次大小即可。

此外，作为我们商业订阅的一部分，这些组允许更改组成员资格或修改特定服务器的设置，而无需重启 nginx。可以通过API模块（1.13.3）访问配置。

在 1.13.3 版本之前，只能通过upstream_conf处理的特殊位置访问配置。

指定一个文件，该文件保存动态可配置组的状态。

示例

state /var/lib/nginx/state/servers.conf; # path for Linux
state /var/db/nginx/state/servers.conf;  # path for FreeBSD

状态当前仅限于具有其参数的服务器列表。在解析配置时读取该文件，并且每次上游配置更改时都会更新该文件。应避免直接更改文件内容。该指令不能与server指令一起使用。

在配置重新加载或二进制升级期间进行的更改可能会丢失。

此指令作为我们商业订阅的一部分提供。

为服务器组指定负载均衡方法，其中客户端-服务器映射基于哈希的键值。键可以包含文本、变量及其组合（1.11.2）。用法示例

hash $remote_addr;

请注意，从组中添加或删除服务器可能会导致将大多数键重新映射到不同的服务器。该方法与Cache::MemcachedPerl 库兼容。

如果指定了consistent参数，则将使用ketama一致哈希方法。该方法确保在将服务器添加到组或从组中删除服务器时，只有少数键会重新映射到不同的服务器。这有助于为缓存服务器实现更高的缓存命中率。该方法与Cache::Memcached::FastPerl 库兼容，其中ketama_points参数设置为 160。

指定组应使用负载均衡方法，其中连接将传递给活动连接数最少的服务器，同时考虑服务器的权重。如果有多个这样的服务器，则使用加权循环负载均衡方法依次尝试这些服务器。

指定一个组应使用一种负载均衡方法，其中连接将传递给具有最短平均时间和最少活动连接数的服务器，同时考虑服务器的权重。如果存在多个此类服务器，则使用加权循环负载均衡方法依次尝试这些服务器。

如果指定了 connect 参数，则使用连接到上游服务器的 连接 时间。如果指定了 first_byte 参数，则使用接收 第一个字节 数据的时间。如果指定了 last_byte，则使用接收 最后一个字节 数据的时间。如果指定了 inflight 参数 (1.11.6)，则也会考虑不完整的连接。

在 1.11.6 版本之前，默认情况下会考虑不完整的连接。

此指令作为我们商业订阅的一部分提供。

指定一个组应使用一种负载均衡方法，其中连接将传递给随机选择的服务器，同时考虑服务器的权重。

可选的 two 参数指示 nginx 随机选择 两个 服务器，然后使用指定的 method 选择一个服务器。默认方法是 least_conn，它将连接传递给具有最少活动连接数的服务器。

least_time 方法将连接传递给具有最短平均时间和最少活动连接数的服务器。如果指定了 least_time=connect 参数，则使用连接到上游服务器的 连接 时间。如果指定了 least_time=first_byte 参数，则使用接收 第一个字节 数据的时间。如果指定了 least_time=last_byte，则使用接收 最后一个字节 数据的时间。

least_time 方法作为我们 商业订阅 的一部分提供。

配置用于将上游服务器的名称解析为地址的名称服务器，例如

resolver 127.0.0.1 [::1]:5353;

地址可以指定为域名或 IP 地址，并可以指定端口（可选）。如果未指定端口，则使用端口 53。名称服务器将以循环方式进行查询。

默认情况下，nginx 在解析时将查找 IPv4 和 IPv6 地址。如果不需要查找 IPv4 或 IPv6 地址，则可以指定 ipv4=off (1.23.1) 或 ipv6=off 参数。

默认情况下，nginx 使用响应的 TTL 值缓存答案。可选的 valid 参数允许覆盖它

resolver 127.0.0.1 [::1]:5353 valid=30s;

为了防止 DNS 欺骗，建议在适当安全受信任的本地网络中配置 DNS 服务器。

可选的 status_zone 参数启用 收集 指定 zone 中请求和响应的 DNS 服务器统计信息。

此指令作为我们商业订阅的一部分提供。

resolver_timeout 30s;

设置名称解析超时，例如

resolver_timeout 5s;

此指令作为我们商业订阅的一部分提供。

ngx_stream_upstream_module 模块支持以下嵌入式变量

$upstream_addr

保留上游服务器的 IP 地址和端口，或 UNIX 域套接字的路径（1.11.4）。如果在代理期间联系了多台服务器，则它们的地址用逗号分隔，例如“192.168.1.1:12345, 192.168.1.2:12345, unix:/tmp/sock”。如果无法选择服务器，则该变量保留服务器组的名称。

$upstream_bytes_received

从上游服务器接收的字节数（1.11.4）。多个连接的值用逗号分隔，就像 $upstream_addr 变量中的地址一样。

$upstream_bytes_sent

发送到上游服务器的字节数（1.11.4）。多个连接的值用逗号分隔，就像 $upstream_addr 变量中的地址一样。

$upstream_connect_time

连接到上游服务器的时间（1.11.4）；时间以秒为单位保留，具有毫秒分辨率。多个连接的时间用逗号分隔，就像 $upstream_addr 变量中的地址一样。

$upstream_first_byte_time

接收第一个数据字节的时间（1.11.4）；时间以秒为单位保留，具有毫秒分辨率。多个连接的时间用逗号分隔，就像 $upstream_addr 变量中的地址一样。

$upstream_session_time

会话持续时间（以秒为单位，具有毫秒分辨率）（1.11.4）。多个连接的时间用逗号分隔，就像 $upstream_addr 变量中的地址一样。