Upstream Sticky#
该模块将客户端会话绑定到 Stream Upstream 模块服务器组中的服务器, 使同一会话的连接被传递到同一台服务器。 该模块的指令设置在 upstream 块中。
当 从源代码构建 时,该模块默认会与 Stream 模块一起构建(Stream 模块通过 --with-stream 启用);
可以通过 构建选项 --without-stream_upstream_sticky_module 禁用它。
在来自 我们的软件仓库 的包和镜像中,该模块已包含在
构建中。 Angie 将每个客户端地址绑定到其首个会话所用的服务器,
并将来自该地址的后续连接传递到同一台服务器。 默认值 — upstream 根据第一个参数中指定的模式,
配置客户端与上游服务器之间的粘性会话。
要逐步将带有 警告 此模式使用预定义的路由标识符,
这些标识符可以嵌入到 Angie 可访问的连接属性中。
它的灵活性较低,因为它依赖于预定义的值,
但如果已经在使用此类标识符,则更适合。 在这里,建立连接时,上游服务器
可以为客户端分配一个路由,并以双方
都知道的方式返回其标识符。
路由标识符
应使用 server 指令的
sid 参数的值。
请注意,如果指定了 sticky_secret 指令,
该参数会被额外哈希处理。 希望使用此路由的客户端的后续连接
必须包含服务器颁发的标识符,并以这样的方式
使其最终出现在 Angie 变量中。 指令参数指定可能包含变量的字符串,
用于路由。要选择传入连接定向到的服务器,
使用第一个非空值;
然后将其与 server 指令的
sid 参数进行比较。
如果服务器选择失败
或所选服务器无法接受连接,
将根据配置的负载均衡方法
选择另一台服务器。 这里 Angie 在 在此模式下,使用动态生成的密钥
将客户端绑定到特定的上游服务器;
此模式更加灵活,
因为它动态分配服务器,
将会话存储在共享内存区域中,
并支持多种传递会话标识符的方式。 在这里,会话是基于
来自上游服务器的连接属性创建的。
会话标识符是使用 会话存储在共享内存区域中;
其名称和大小由 默认情况下,Angie 通过在每次使用会话时
更新最后访问时间戳来延长会话生命周期。
希望使用会话的客户端的后续连接
必须包含其标识符。
在示例中,Angie 使用 $rdp_cookie 变量
创建和查找会话: 在此模式下, 此模式的一般操作原理如下:
如果在本地未找到会话标识符,
Angie 会向 当新连接到达时,Angie 执行以下操作: 首先,从 如果设置了 如果在本地未找到会话或未设置 来自 预选 服务器 的标识符
(在配置中,这是
$sticky_sid 变量):
该服务器的 远程存储处理请求并返回 HTTP 响应: 设置了 设置了 当从存储接收到任何其他 HTTP 代码,
或发生网络错误或超时时,
Angie 使用最初选择的服务器。 如果 服务器标识符通过 下面是一个简化的配置示例。
远程存储在 这里,来自远程存储的响应如下: 两个变量变为可用: 由于 标记为 已达到最大连接数的服务器
(使用 带有 如果先前不可用的服务器恢复,
在 将 string 作为盐值添加到 MD5 哈希函数中,
用于 盐值添加在哈希值之后;
要独立验证哈希机制: 启用时,如果与会话绑定的服务器标识符与组中任何服务器都不匹配,
或该服务器不可用,
Angie 将向客户端返回连接错误,
而不是回退到负载均衡(默认行为)。 Stream Upstream 模块的 $upstream_sticky_status
变量用于显示连接是否携带会话数据,以及是否到达了所绑定的服务器。
与 sticky 中的 与 sticky 中的 配置示例#
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;
}
指令#
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)sticky 的服务器退出轮换,
可以在 server 块中使用 drain 选项。sticky 指令必须出现在所有负载均衡方法指令之后,
否则将无法工作。$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;
}
}
create 和 lookup 参数列出了
指定如何创建新会话和查找现有会话的变量。
这两个参数都可以多次使用。create 指定的
第一个非空变量的值;
例如,这可以是
上游服务器名称。zone 参数指定。
如果会话在 timeout 指定的 时间 内
未被访问,则会被删除。
默认值为 1 小时。norefresh 参数改变了这种行为:
会话严格按超时时间过期,即使正在使用中。lookup 参数使用指定的变量列表
在连接中搜索会话标识符,
在第一个非空变量处停止。
如果未找到任何内容,则该请求被视为新请求。
找到的标识符的值
与共享内存中的会话进行匹配。
如果服务器选择失败
或所选服务器无法处理连接,
将根据配置的负载均衡方法
选择另一台服务器。connect 参数允许在与上游服务器
建立连接后立即创建会话。
如果没有它,会话仅在连接处理完成后创建。
(对于 UDP 连接,会话在服务器选择后立即创建。)stream {
upstream backend {
zone backend 1m;
server 127.0.0.1:3390;
server 127.0.0.1:3391;
sticky learn lookup=$rdp_cookie create=$rdp_cookie zone=sessions:1m;
}
server {
listen 127.0.0.1:3389;
rdp_preread on;
proxy_pass backend;
}
}
remote_action 和 remote_result 参数
允许使用远程会话存储(PRO)
动态分配和管理会话标识符。zone 参数是可选的。
设置该参数时,共享内存区充当本地会话缓存,
timeout 和 norefresh 的作用
与带 create 的 learn 模式中相同;
远程存储仍具有权威性。
未设置该参数时,Angie 不保留本地会话缓存,
而是对每个其 lookup 变量能得出会话标识符的连接
查询远程存储。remote_action 参数必须指向
client 上下文中的 location。
remote_uri 参数指定客户端 HTTP 请求
到指定 location 的 URI。
默认情况下,它是 /。
remote_uri 值可以包含变量。remote_action 参数指定的
远程存储发送同步子请求。lookup 列表中的
第一个非空变量中提取会话标识符。
如果所有变量都为空,
则使用正常的负载均衡算法,不使用粘性会话。zone,
Angie 会在共享内存区中查找该会话。
如果找到会话,Angie 使用其服务器并停止处理。zone,
Angie 按配置的负载均衡方法选择服务器。
然后向 remote_action 参数指定的
远程存储发送同步 HTTP 子请求,该请求应以
存储能理解的格式包含:lookup 参数的 会话 标识符
(在配置中,这是
$sticky_sessid 变量);sid= 值
或其生成的默认值(参见 server)。$sticky_sessid 和 $sticky_sid 变量会自动
以 stream_ 前缀导出到 HTTP 上下文:
$stream_sticky_sessid、$stream_sticky_sid。
这允许直接在 HTTP 指令中使用它们,
例如通过 proxy_set_header 使用 HTTP 头。zone 时,
代码为 200、201 或 204 的响应确认所选服务器,
并且会话会保存到共享内存区中。
未设置 zone 时,存储必须在此类响应中
返回与该会话绑定的服务器的标识符,
该标识符可能与 $sticky_sid 不同;
Angie 通过 remote_result 提取它,
并将连接路由到该服务器。zone 时,代码为 409 的响应表示冲突:
该会话标识符已存在,但绑定到另一个服务器。
远程存储必须在同一响应中返回正确的服务器标识符;
可以通过 remote_result 提取它。remote_result 得到的服务器标识符为空,
或与任何可用服务器都不匹配,
Angie 会记录错误并按负载均衡方法选择服务器;
如果启用了 sticky_strict,
客户端则会收到连接错误。remote_result 参数
从远程存储响应中提取:
它可以指定带有 upstream_http_ 前缀的变量,
这些变量由 Angie 自动创建,用于访问
来自远程存储的 HTTP 响应头,
或使用 $sent_body 来使用响应正文。
例如,此类响应中的 X-Sid: server1 头
在 $upstream_http_x_sid 变量中可访问,
其值为 server1。X-Sticky-Sid 头中返回服务器标识符,
从而确认或覆盖 Angie 的选择:http {
client {
location @sticky_client1 {
# 使用来自 stream upstream 的变量;
# 它将这些变量以 stream_* 前缀添加到 HTTP 上下文
proxy_set_header X-Sticky-Sessid $stream_sticky_sessid;
proxy_set_header X-Sticky-Sid $stream_sticky_sid;
proxy_set_header X-Sticky-Last $msec;
proxy_pass http://127.0.0.1:8080;
proxy_cache remote;
proxy_cache_valid 200 1d;
proxy_cache_key $scheme$proxy_host$request_uri$stream_sticky_sessid;
}
}
}
stream {
upstream u {
zone u 1m;
server 127.0.0.1:8081 sid=backend-01;
server 127.0.0.1:8082 sid=backend-02;
sticky learn lookup=$remote_addr # stream 变量
remote_action=@sticky_client1 # 来自 client 块的 location
remote_result=$upstream_http_x_sticky_sid # HTTP 变量
remote_uri=/foo; # 默认为 /
}
server {
listen 127.0.0.1:8080;
proxy_pass u;
}
}
HTTP/1.1 200 OK
...
X-Sticky-Sid: backend-01
X-Session-Info: active
$upstream_http_x_sticky_sid,
值为 backend-01;$upstream_http_x_session_info,
值为 active。$upstream_http_x_sticky_sid 变量
在 remote_result 参数中指定,
其值将被用于
选择具有 sid=backend-01 的服务器。sticky 指令会考虑 upstream 中服务器的状态:down 或由于故障而暂时不可用的服务器
将被排除在选择之外。max_conns 时)将被暂时跳过。drain 选项的服务器
在 sticky 模式下当标识符匹配时
可以被选择用于创建新会话。sticky 会自动恢复使用它。sticky 的行为可以通过
sticky_secret 和 sticky_strict 指令进一步配置。
如果 sticky 无法选择服务器或服务器不可用,
请求将根据所选的负载均衡方法进行处理,
除非启用了 sticky_strict 指令。
在 sticky_strict on; 模式下,请求将被拒绝并返回错误。sticky 指令的 zone 参数中
指定的共享内存区域
不能在不同的 upstream 组之间共享;
每个组必须使用自己的区域。sticky_secret#
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#
内置变量#
stream_upstream_sticky 模块本身支持以下内置变量:$sticky_sessid (PRO)#remote_action 一起使用;
存储从 lookup 获取的初始会话标识符。$sticky_sid (PRO)#remote_action 一起使用;
存储由负载均衡方法预先选定的服务器的标识符:
该服务器的 sid= 值或其生成的默认值
(参见 server)。