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#
| |
默认值 | — |
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;
}
此模式使用预定义的路由标识符, 这些标识符可能来自 URL、cookie 或请求参数。 灵活性较低,但适用于此类标识符已经存在的情况。
后端服务器可能返回一个客户端和服务器都知道的路由 ID。 此值必须与 sid 匹配。
后续请求应携带路由 ID, 例如通过 cookie 或 查询参数。
该指令接受一个可包含变量的字符串列表来提取路由 ID。 第一个非空值会与 sid 进行匹配。
在此示例中,Angie 首先检查 route cookie,
然后检查 route 查询参数:
upstream backend {
zone backend 1m;
server backend1.example.com:8080 "sid=server 1";
server backend2.example.com:8080 "sid=server 2";
sticky route $cookie_route $arg_route;
}
此模式使用动态生成的密钥将客户端分配给后端。 它很灵活,支持在共享内存中存储会话 以及各种标识符来源。
会话从后端服务器的响应中创建。
create 和 lookup 定义如何生成和定位会话,
两者都接受多个变量。
会话 ID 是 create 中第一个非空变量。
例如,它可能来自响应 cookie。
会话存储在共享内存中,
通过 zone name:size 定义。
如果在 timeout 时长(默认:1 小时)内未使用,会话将过期。
默认情况下,Angie 在每次使用时刷新会话。
要禁用此功能,请使用 norefresh。
客户端请求中的会话 ID 通过 lookup 提取,
使用列出的第一个非空变量。
如果找不到,则为新请求。
使用 header 可在接收到响应头时创建会话,
而不是在完整响应处理后。
示例:使用 examplecookie 创建会话:
upstream backend {
zone backend 1m;
server backend1.example.com:8080;
server backend2.example.com:8080;
sticky learn
create=$upstream_cookie_examplecookie
lookup=$cookie_examplecookie
zone=client_sessions:1m;
}
使用 remote_action 和 remote_result
通过外部会话存储管理会话 ID。
共享内存区域充当缓存;
外部存储具有权威性。
create 与 remote_action 不兼容。
会话在 timeout (默认:1 小时)后过期,
与 remote_action 无关。
默认情况下,Angie 在每次使用时刷新会话 TTL。
使用 norefresh 可禁用此功能。
zone 在使用 remote_action 时是可选的。
如果没有它,Angie 不保留本地会话缓存,
而是对每个其 lookup 变量能得出会话 ID 的请求查询外部存储;
存储的响应仍可通过 proxy_cache 进行缓存。
基本流程:
从第一个非空的
lookup变量中提取会话 ID。 如果没有,则回退到标准负载均衡。如果设置了
zone且会话存在,则使用它并停止。如果没有会话或没有 zone,选择一个服务器并向
remote_action端点发起 HTTP 子请求,包含:会话 ID($sticky_sessid);
服务器 ID($sticky_sid): 预先选定的服务器的
sid=值, 或其生成的默认值(参见 server)。
通过 HTTP 头(通过 proxy_set_header)发送这些信息。
远程存储响应:
200/201/204:如果设置了
zone,则确认所选服务器, Angie 将会话缓存到该区中。 如果未设置zone,存储必须返回与该会话绑定的服务器 ID, 该 ID 可能与$sticky_sid不同; Angie 通过remote_result提取该 ID, 并将请求路由到该服务器。409 表示冲突(如果设置了
zone)— 会话链接到另一个服务器。 使用remote_result提取更正后的服务器 ID。任何其他状态码、网络错误或超时 — 回退到最初选定的服务器。
remote_result得到的服务器 ID 为空, 或与任何可用服务器都不匹配 — 记录错误并按负载均衡方法选择服务器; 如果启用了 sticky_strict, 则改为返回 502 错误。
remote_result 使用 upstream_http_* 变量
从远程存储的响应中读取头部。
示例:会话 ID 来自 $cookie_bar,
通过 $upstream_http_x_sticky_sid 确认:
http {
upstream u1 {
server srv1;
server srv2;
sticky learn zone=sz:1m
lookup=$cookie_bar
remote_action=/remote_session
remote_result=$upstream_http_x_sticky_sid;
zone z 1m;
}
server {
listen localhost;
location / {
proxy_pass http://u1/;
}
location /remote_session {
internal;
proxy_set_header X-Sticky-Sessid $sticky_sessid;
proxy_set_header X-Sticky-Sid $sticky_sid;
proxy_set_header X-Sticky-Last $msec;
proxy_pass http://remote;
}
}
}
以下是一个简化的配置示例。
远程存储在 X-Sid 头中返回会话 ID,
从而确认或覆盖 Angie 的选择:
http {
proxy_cache_path c1 keys_zone=s1:1m;
upstream tc_0 {
server 10.0.0.1 sid=web-server-01;
server 10.0.0.2 sid=web-server-02;
sticky learn
lookup=$arg_id
remote_action=@create_session
remote_result=$upstream_http_x_sid;
}
server {
listen 127.0.0.1:8080;
location / {
proxy_pass http://tc_0/;
}
# Request to the remote session store
location @create_session {
internal;
proxy_set_header X-Sticky-Sessid $sticky_sessid;
proxy_set_header X-Sticky-Sid $sticky_sid;
proxy_set_header X-Sticky-Last $msec;
proxy_pass http://session_backend;
proxy_connect_timeout 1s;
proxy_read_timeout 1s;
proxy_cache s1;
proxy_cache_valid 200 1d;
proxy_cache_key "$scheme$proxy_host$request_uri$sticky_sessid";
}
}
}
响应示例:
HTTP/1.1 200 OK
...
X-Sid: web-server-01
X-Session-Backend: backend-pool-1
生成的 Angie 变量:
$upstream_http_x_sid→web-server-01$upstream_http_x_session_backend→backend-pool-1
remote_result 将使用 web-server-01
来选择匹配的 sid。
sticky 指令遵循上游服务器状态:
标记为
down或失败的服务器会被排除。超过
max_conns限制的服务器会被跳过。drain服务器在sticky模式下当标识符匹配时仍可能被选中用于新会话。恢复的服务器会自动重新使用。
您可以使用
sticky_secret 和 sticky_strict 进一步调整行为。
如果粘性失败且 sticky_strict 关闭,
则使用回退负载均衡;
如果开启,则拒绝请求。
sticky 中使用的每个 zone 必须专属于单个 upstream。
区域不能在多个 upstream 块之间共享。
sticky_secret#
将 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#
启用时,如果与会话绑定的服务器 ID 与组中任何服务器都不匹配, 或该服务器不可用, Angie 会向客户端返回 HTTP 502 错误, 而不是回退到负载均衡(默认行为)。
内置变量#
HTTP Upstream 模块的 $upstream_sticky_status
变量用于显示请求是否携带会话数据,以及是否到达了所绑定的服务器。
与 sticky 中的 与 sticky 中的 http_upstream_sticky 模块本身支持以下内置变量:$sticky_sessid (PRO)#remote_action 一起使用;
存储从 lookup 获取的初始会话 ID。$sticky_sid (PRO)#remote_action 一起使用;
存储由负载均衡方法预先选定的服务器的 ID:
该服务器的 sid= 值或其生成的默认值
(参见 server)。