Upstream Sticky#
Привязывает клиентские сессии к серверам групп потокового модуля Upstream, чтобы соединения одной сессии передавались на один и тот же сервер. Директивы модуля задаются в блоке upstream.
При сборке из исходного кода модуль собирается по
умолчанию вместе с модулем Stream (который включается
параметром --with-stream); его можно отключить с помощью
параметра сборки
--without-stream_upstream_sticky_module.
В пакетах и образах из наших репозиториев модуль
включен в сборку. Angie привязывает каждый адрес клиента к серверу его первой сессии и передает
последующие соединения с этого адреса на тот же сервер. По умолчанию — upstream Настраивает привязку клиентских сессий к проксируемым серверам
в режиме, заданном первым параметром;
для разгрузки серверов,
у которых задана директива Предупреждение Директива Этот режим использует предопределенные идентификаторы маршрутов,
которые могут быть встроены в свойства соединения, доступные Angie.
Он менее гибок, так как зависит от предопределенных значений,
но лучше подходит, если такие идентификаторы уже используются. Здесь при установлении соединения проксируемый сервер
может назначить клиенту маршрут и вернуть его идентификатор способом,
известным им обоим.
В качестве идентификатора маршрута
должно использоваться значение параметра sid
директивы server.
Учтите, что параметр дополнительно хэшируется,
если задана директива sticky_secret. Последующие соединения от клиентов, желающих использовать этот маршрут,
должны содержать выданный сервером идентификатор, причем так,
чтобы он попал в переменные Angie. В параметрах директивы указываются строки, которые могут содержать
переменные для маршрутизации. Чтобы выбрать сервер, куда направляется
входящее соединение, используется первое непустое значение;
она затем сравнивается с параметром sid
директивы server.
Если выбрать сервер не удается
или выбранный сервер не может принять соединение,
то будет выбран другой сервер
согласно настроенному методу балансировки. Здесь Angie ищет идентификатор маршрута в переменной В этом режиме для привязки клиента к конкретному проксируемому серверу
используется динамически генерируемый ключ;
этот режим более гибок,
так как назначает серверы на ходу,
хранит сеансы в зоне разделяемой памяти
и поддерживает различные способы передачи идентификаторов сессий. Здесь сессия создается
на основе свойств соединения, идущих от проксируемого сервера.
С параметрами Идентификатором сессии служит значение первой непустой переменной,
указанной с Сессии хранятся в зоне разделяемой памяти;
ее имя и размер задаются параметром По умолчанию Angie продлевает срок действия сессии,
обновляя метку времени последнего обращения при каждом ее использовании.
Параметр Последующие соединения от клиентов, желающих использовать сессию,
должны содержать ее идентификатор.
Параметр Параметр В примере Angie создает и ищет сессии,
используя переменную $rdp_cookie: Параметры Параметр Параметр Общий принцип работы режима таков:
если идентификатор сессии не найден локально,
Angie отправляет синхронный подзапрос в некое удаленное хранилище,
заданное параметром При поступлении нового соединения Angie выполняет следующие действия: Сначала извлекается идентификатор сессии из первой непустой переменной
в списке Если задан параметр Если сессия не найдена локально или параметр идентификатор сессии из параметра идентификатор предварительно выбранного сервера:
значение его параметра Переменные Удаленное хранилище обрабатывает запрос и возвращает HTTP-ответ: Если задан параметр Ответ с кодом 409 указывает на конфликт (лишь при наличии При получении от хранилища любого другого HTTP-кода,
а также при ошибке сети или таймауте
Angie использует изначально выбранный сервер. Если Идентификатор сервера извлекается из ответа удаленного хранилища
через параметр Ниже показан упрощенный пример конфигурации.
Удаленное хранилище возвращает идентификатор сервера в заголовке Здесь при следующем ответе от удаленного хранилища: Становятся доступными две переменные: Так как переменная Директива Серверы, помеченные как Серверы, которые достигли максимального количества соединений
(при использовании Серверы с опцией Если ранее недоступный сервер восстанавливается,
Поведение Зоны разделяемой памяти,
указываемые в параметре Добавляет строку как соль в функцию MD5-хэширования
для директивы sticky в режиме Соль добавляется после хэшируемого значения;
чтобы независимо проверить механизм хэширования: Если директива включена, Angie возвращает клиенту ошибку соединения,
когда идентификатор сервера, закрепленный за сессией,
не соответствует ни одному серверу группы или этот сервер недоступен,
а не переходит к балансировке нагрузки, как по умолчанию. Переменная $upstream_sticky_status
потокового модуля Upstream показывает, содержало ли
соединение данные о привязке и попало ли оно на привязанный сервер. Сам модуль
Используется с Используется с Пример конфигурации#
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 значение...;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,
можно использовать опцию drain в блоке server.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 действуют так же,
как в режиме learn с create;
авторитетным источником при этом остается удаленное хранилище.
Если он не задан, Angie не кэширует сессии локально
и обращается к удаленному хранилищу при каждом соединении,
для которого переменные lookup дают идентификатор сессии.remote_action должен указывать на location
в контексте client.
Параметр remote_uri задает URI клиентского HTTP-запроса
к указанному location.
По умолчанию он равен /.
Значение remote_uri может содержать переменные.remote_action.lookup.
Если все переменные пустые,
используется обычный алгоритм балансировки нагрузки без привязки.zone,
Angie ищет существующую сессию в локальной разделяемой памяти.
При обнаружении используется связанный с ней сервер
и обработка завершается.zone не задан,
сервер выбирается как обычно, согласно настроенному методу балансировки.
Затем Angie отправляет в удаленное хранилище,
заданное параметром remote_action, синхронный HTTP-подзапрос,
который должен содержать в понятном хранилищу виде:lookup
(в конфигурации это переменная
$sticky_sessid);sid=
или идентификатор, сгенерированный по умолчанию
(см. server;
в конфигурации это переменная
$sticky_sid).$sticky_sessid и $sticky_sid автоматически
экспортируются в HTTP-контекст c префиксом stream_:
$stream_sticky_sessid, $stream_sticky_sid.
Это позволяет напрямую использовать их в HTTP-директивах,
например через HTTP-заголовки с помощью proxy_set_header.zone,
ответ с кодом 200, 201 или 204 подтверждает выбранный сервер,
и сессия сохраняется в зоне разделяемой памяти.
Без zone хранилище возвращает в таком ответе
идентификатор сервера, закрепленного за сессией
(он может отличаться от $sticky_sid);
Angie извлекает его через remote_result
и направляет соединение на сервер с этим идентификатором.zone):
данный идентификатор сессии уже существует, но связан с другим сервером.
Удаленное хранилище должно одновременно с этим
вернуть правильный идентификатор сервера;
извлечь его можно через 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 {
# используем переменные из потокового upstream;
# он добавляет эти переменные в HTTP-контекст с префиксом stream_*
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 # location из блока client
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; запрос отклоняется с ошибкой.zone директивы sticky,
не могут использоваться совместно различными upstream;
каждая группа должна использовать свою собственную зону.sticky_secret#
route.
Строка может содержать переменные, например $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 в sticky;
хранит начальный идентификатор сессии, взятый из lookup.$sticky_sid (PRO)#remote_action в sticky;
хранит идентификатор сервера, предварительно выбранного методом балансировки:
значение его параметра sid=
или идентификатор, сгенерированный по умолчанию
(см. server).