Upstream Sticky#

该模块将客户端会话绑定到 Stream Upstream 模块服务器组中的服务器, 使同一会话的连接被传递到同一台服务器。 该模块的指令设置在 upstream 块中。

当 从源代码构建 时,该模块默认会与 Stream 模块一起构建(Stream 模块通过 --with-stream 启用); 可以通过 构建选项 --without-stream_upstream_sticky_module 禁用它。

在来自 我们的软件仓库 的包和镜像中,该模块已包含在 构建中。

配置示例#

upstream backend {
    zone backend 1m;
    server backend1.example.com:1935;
    server backend2.example.com:1935;

    sticky learn zone=clients:1m create=$remote_addr lookup=$remote_addr;
}

Angie 将每个客户端地址绑定到其首个会话所用的服务器, 并将来自该地址的后续连接传递到同一台服务器。

指令#

sticky#

语法

sticky route value...;

sticky learn zone=zone create=$create_var1... lookup=$lookup_var1... [connect] [norefresh] [timeout=time];

sticky learn [zone=zone] lookup=$lookup_var1... remote_action=uri remote_result=$remote_var [remote_uri=uri] [norefresh] [timeout=time]; (PRO)

默认值

—

上下文

upstream

根据第一个参数中指定的模式, 配置客户端与上游服务器之间的粘性会话。 要逐步将带有 sticky 的服务器退出轮换, 可以在 server 块中使用 drain 选项。

警告

sticky 指令必须出现在所有负载均衡方法指令之后, 否则将无法工作。

此模式使用预定义的路由标识符, 这些标识符可以嵌入到 Angie 可访问的连接属性中。 它的灵活性较低,因为它依赖于预定义的值, 但如果已经在使用此类标识符,则更适合。

在这里,建立连接时,上游服务器 可以为客户端分配一个路由,并以双方 都知道的方式返回其标识符。 路由标识符 应使用 server 指令的 sid 参数的值。 请注意,如果指定了 sticky_secret 指令, 该参数会被额外哈希处理。

希望使用此路由的客户端的后续连接 必须包含服务器颁发的标识符,并以这样的方式 使其最终出现在 Angie 变量中。

指令参数指定可能包含变量的字符串, 用于路由。要选择传入连接定向到的服务器, 使用第一个非空值; 然后将其与 server 指令的 sid 参数进行比较。 如果服务器选择失败 或所选服务器无法接受连接, 将根据配置的负载均衡方法 选择另一台服务器。

这里 Angie 在 $route 变量中查找路由标识符, 该变量根据 $ssl_preread_server_name 接收其值(注意必须启用 ssl_preread):

stream {

    map $ssl_preread_server_name $route {

        a.example.com            a;
        b.example.com            b;
        default                  "";
    }

    upstream backend {

        zone backend 1m;

        server 127.0.0.1:8081 sid=a;
        server 127.0.0.1:8082 sid=b;

        sticky route $route;
    }

    server {

        listen 127.0.0.1:8080;

        ssl_preread on;

        proxy_pass backend;
    }
}

sticky 指令会考虑 upstream 中服务器的状态:

  • 标记为 down 或由于故障而暂时不可用的服务器 将被排除在选择之外。

  • 已达到最大连接数的服务器 (使用 max_conns 时)将被暂时跳过。

  • 带有 drain 选项的服务器 在 sticky 模式下当标识符匹配时 可以被选择用于创建新会话。

  • 如果先前不可用的服务器恢复, sticky 会自动恢复使用它。

sticky 的行为可以通过 sticky_secret 和 sticky_strict 指令进一步配置。 如果 sticky 无法选择服务器或服务器不可用, 请求将根据所选的负载均衡方法进行处理, 除非启用了 sticky_strict 指令。 在 sticky_strict on; 模式下,请求将被拒绝并返回错误。

在 sticky 指令的 zone 参数中 指定的共享内存区域 不能在不同的 upstream 组之间共享; 每个组必须使用自己的区域。

sticky_secret#

语法

sticky_secret string;

默认值

—

上下文

upstream

将 string 作为盐值添加到 MD5 哈希函数中, 用于 route 模式下的 sticky 指令。 String 可以包含变量,例如 $remote_addr:

upstream backend {
    zone backend 1m;
    server 127.0.0.1:8081 sid=a;
    server 127.0.0.1:8082 sid=b;

    sticky route $route;
    sticky_secret my_secret.$remote_addr;
}

盐值添加在哈希值之后; 要独立验证哈希机制:

$ echo -n "<VALUE><SALT>" | md5sum

sticky_strict#

语法

sticky_strict on | off;

默认值

sticky_strict off;

上下文

upstream

启用时,如果与会话绑定的服务器标识符与组中任何服务器都不匹配, 或该服务器不可用, Angie 将向客户端返回连接错误, 而不是回退到负载均衡(默认行为)。

内置变量#

Stream Upstream 模块的 $upstream_sticky_status 变量用于显示连接是否携带会话数据,以及是否到达了所绑定的服务器。 stream_upstream_sticky 模块本身支持以下内置变量:

$sticky_sessid (PRO)#

与 sticky 中的 remote_action 一起使用; 存储从 lookup 获取的初始会话标识符。

$sticky_sid (PRO)#

与 sticky 中的 remote_action 一起使用; 存储由负载均衡方法预先选定的服务器的标识符: 该服务器的 sid= 值或其生成的默认值 (参见 server)。