Upstream Sticky#

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

当 从源代码构建 时,该模块默认会被构建;可以通过 构建选项 --without-http_upstream_sticky_module 禁用它。

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

相关指南

配置示例#

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

    sticky cookie srv_id max-age=3600;
}

指令#

sticky#

语法

sticky cookie name [attr=value]...;

sticky route value...;

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

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

默认值

—

上下文

upstream

配置会话亲和性,以将客户端会话绑定到代理服务器, 模式由第一个参数指定; 要排空配置了 sticky 指令的服务器, 可以在 server 块中使用 drain 选项。

警告

sticky 指令必须在所有指定特定负载均衡方法的指令之后使用, 否则将不起作用。 如果与 bind_conn (PRO) 指令一起使用, 则 bind_conn 必须在 sticky 之后。

此模式使用 cookie 来管理会话。 适用于已经使用 cookie 进行会话跟踪的场景。

在应用任何粘性之前,第一个客户端请求 会根据配置的负载均衡方法发送到后端服务器。 然后 Angie 会设置一个标识所选服务器的 cookie。

cookie 名称(name)由 sticky 指令定义, 其值对应于 sid (来自 server 指令)。 如果设置了 sticky_secret,此值会进一步进行哈希处理。

后续携带此 cookie 的请求会被路由到 由其 sid 指定的服务器。 如果该服务器不可用或无法处理请求, 则通过配置的负载均衡方法选择另一个服务器。

您可以在指令中分配 cookie 属性; 默认情况下,仅设置 path=/。 属性值可以包含变量。 要删除某个属性,请将其设置为空值:attr=。 例如,sticky cookie path= 会省略 path 属性。

此示例设置一个名为 srv_id 的 cookie,有效期为 1 小时, 使用来自变量的域名:

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

    sticky cookie srv_id domain=$my_domain max-age=3600;
}

sticky 指令遵循上游服务器状态:

  • 标记为 down 或失败的服务器会被排除。

  • 超过 max_conns 限制的服务器会被跳过。

  • drain 服务器在 sticky 模式下当标识符匹配时仍可能被选中用于新会话。

  • 恢复的服务器会自动重新使用。

您可以使用 sticky_secret 和 sticky_strict 进一步调整行为。 如果粘性失败且 sticky_strict 关闭, 则使用回退负载均衡; 如果开启,则拒绝请求。

sticky 中使用的每个 zone 必须专属于单个 upstream。 区域不能在多个 upstream 块之间共享。

sticky_secret#

语法

sticky_secret string;

默认值

—

上下文

upstream

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

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

    sticky cookie cookie_name;
    sticky_secret my_secret.$remote_addr;
}

盐值会附加到被哈希的值后面; 要独立验证哈希机制:

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

sticky_strict#

语法

sticky_strict on | off;

默认值

sticky_strict off;

上下文

upstream

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

内置变量#

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

$sticky_sessid (PRO)#

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

$sticky_sid (PRO)#

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