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,
можно использовать опцию drain
в блоке server.
Предупреждение
Директива sticky должна использоваться после всех директив,
задающих тот или иной метод балансировки нагрузки,
иначе она не будет работать.
Если она используется наряду с директивой bind_conn (PRO),
то bind_conn должна стоять после sticky.
Этот режим использует cookie для хранения сессий. Он подходит для ситуаций, когда cookie уже используются для управления сессиями.
Здесь запрос от клиента, пока не привязанного к какому-то серверу, отправляется на сервер, выбираемый согласно настроенному методу балансировки. При этом Angie устанавливает cookie с уникальным значением, идентифицирующим сервер.
Имя cookie (name) задается директивой sticky,
а значение (value) соответствует
параметру sid
директивы server.
Учтите, что параметр дополнительно хэшируется,
если задана директива sticky_secret.
Последующие запросы от клиента, содержащие такой cookie, передаются на сервер, заданный значением cookie, то есть сервер с указанным sid. Если выбрать сервер не удается или выбранный сервер не может обработать запрос, то будет выбран другой сервер согласно настроенному методу балансировки.
Директива позволяет назначать атрибуты такого cookie;
единственный атрибут, устанавливаемый по умолчанию, — path=/.
Значения атрибутов задаются строками с переменными.
Чтобы удалить атрибут, задайте для него пустое значение: attr=.
Так, sticky cookie path= задает cookie без атрибута path.
Здесь Angie создает cookie srv_id со сроком действия в 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 или другие свойства запроса. Он менее гибок, так как зависит от предопределенных значений, но лучше подходит, если такие идентификаторы уже используются.
Здесь проксируемый сервер при получении запроса может назначить клиенту маршрут и вернуть его идентификатор способом, известным им обоим. В качестве идентификатора маршрута должно использоваться значение параметра sid директивы server. Учтите, что параметр дополнительно хэшируется, если задана директива sticky_secret.
Последующие запросы от клиентов, желающих использовать этот маршрут, должны содержать выданный сервером идентификатор, причем так, чтобы он попал в переменные Angie, например в cookie или аргументы запроса.
В параметрах директивы указываются строки, которые могут содержать переменные, чтобы извлечь идентификатор маршрута. Чтобы выбрать сервер, куда передается поступивший запрос, используется первое непустое значение; она затем сравнивается с параметром sid директивы server. Если выбрать сервер не удается или выбранный сервер не может обработать запрос, то будет выбран другой сервер согласно настроенному методу балансировки.
Здесь Angie ищет идентификатор маршрута в cookie route,
затем в аргументе запроса 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 перечисляются переменные,
указывающие, как создаются новые и ищутся существующие сессии.
Оба параметра можно использовать по нескольку раз.
Идентификатором сессии служит значение первой непустой переменной,
указанной с create;
например, это может быть
cookie с проксируемого сервера.
Сессии хранятся в зоне разделяемой памяти;
ее имя и размер задаются параметром zone.
Если к сессии не было обращений в течение времени
timeout, она удаляется.
Значение по умолчанию — 1 час.
По умолчанию Angie продлевает срок действия сессии,
обновляя метку времени последнего обращения при каждом использовании.
Параметр norefresh отключает это поведение:
сессия истечет строго по таймауту, даже если продолжает использоваться.
Такой режим удобен,
когда требуется принудительно завершать сессию по истечении времени,
например, при интеграции с внешними менеджерами сессий.
Последующие запросы от клиентов, желающих использовать сессию,
должны содержать ее идентификатор.
Параметр lookup ищет идентификатор сессии в пользовательском запросе
по заданному для него списку переменных,
останавливаясь на первой непустой.
Если ничего не найдено — запрос считается новым.
Значение найденного идентификатора
сопоставляется с сессиями в разделяемой памяти.
Если выбрать сервер не удается
или выбранный сервер не может обработать запрос,
то будет выбран другой сервер
согласно настроенному методу балансировки.
Параметр header позволяет создать сессию
сразу после получения заголовков ответа от проксируемого сервера.
Без него сессия создается только после завершения обработки запроса.
В примере Angie создает сессию,
устанавливая в ответе cookie с именем 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
позволяют динамически назначать идентификаторы сессий и управлять ими
с использованием удаленного хранилища сессий.
При этом зона разделяемой памяти выступает в роли локального кэша,
а удаленное хранилище является авторитетным источником.
Поэтому параметр create
несовместим с remote_action,
так как идентификаторы сессий должны создаваться удаленно.
Если к сессии не было обращений в течение времени
timeout, она удаляется.
Значение по умолчанию — 1 час.
Настройка remote_action не влияет на таймаут.
По умолчанию Angie продлевает срок действия сессии,
обновляя метку времени последнего обращения при каждом ее использовании.
Параметр norefresh меняет это поведение:
сессия истекает строго по таймауту, даже если используется.
Параметр zone
в конфигурации sticky с remote_action
необязателен.
Если он не задан,
Angie полностью полагается на удаленное хранилище:
не кэширует сессии локально
(хотя позволяет кэшировать ответы хранилища через proxy_cache)
и обращается к удаленному хранилищу при каждом запросе,
для которого переменные lookup дают идентификатор сессии.
Общий принцип работы режима таков:
если идентификатор сессии не найден локально или истек таймаут,
Angie отправляет синхронный подзапрос в некое удаленное хранилище,
заданное параметром remote_action.
При поступлении HTTP-запроса Angie выполняет следующие действия:
Сначала извлекается идентификатор сессии из первой непустой переменной в списке
lookup. Если все переменные пустые, используется обычный алгоритм балансировки нагрузки без привязки.Если задан параметр
zone, Angie ищет существующую сессию в локальной разделяемой памяти. При обнаружении используется связанный с ней сервер и обработка завершается.Если сессия не найдена локально или параметр
zoneне задан, сервер выбирается как обычно, согласно настроенному методу балансировки. Затем Angie отправляет в удаленное хранилище, заданное параметромremote_action, синхронный HTTP-подзапрос, который должен содержать в понятном хранилищу виде:идентификатор сессии из параметра
lookup(в конфигурации это переменная $sticky_sessid);идентификатор предварительно выбранного сервера: значение его параметра
sid=или идентификатор, сгенерированный по умолчанию (см. server; в конфигурации это переменная $sticky_sid).
Проще всего можно передать эти идентификаторы через HTTP-заголовки с помощью proxy_set_header.
Удаленное хранилище обрабатывает запрос и возвращает HTTP-ответ:
Если задан параметр
zone, ответ с кодом 200, 201 или 204 подтверждает выбранный сервер, и сессия сохраняется в зоне разделяемой памяти. Безzoneхранилище возвращает в таком ответе идентификатор сервера, закрепленного за сессией (он может отличаться от$sticky_sid); Angie извлекает его черезremote_resultи направляет запрос на сервер с этим идентификатором.Ответ с кодом 409 указывает на конфликт (лишь при наличии
zone): данный идентификатор сессии уже существует, но связан с другим сервером. Удаленное хранилище должно одновременно с этим вернуть правильный идентификатор сервера в HTTP-заголовке; извлечь его можно черезremote_result.При получении от хранилища любого другого HTTP-кода, а также при ошибке сети или таймауте Angie использует изначально выбранный сервер.
Если
remote_resultдает пустой идентификатор сервера или идентификатор, которому не соответствует ни один доступный сервер, Angie записывает ошибку в лог и выбирает сервер методом балансировки; при включенной директиве sticky_strict клиент вместо этого получает ошибку 502.
Идентификатор сервера извлекается из ответа удаленного хранилища
через параметр remote_result:
в нем можно указывать переменные
с префиксом upstream_http_,
которые создаются Angie автоматически для доступа
к заголовкам HTTP-ответов от удаленного хранилища.
Например, заголовок X-Sid: server1 в таком ответе
становится доступным в переменной $upstream_http_x_sid
со значением server1.
В следующем примере Angie создает сессию,
использует переменную $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
и таким образом подтверждает или переопределяет выбор 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/;
}
# Запрос к удаленному хранилищу сессий
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
Становятся доступными две переменные:
$upstream_http_x_sid, со значениемweb-server-01;$upstream_http_x_session_backend, со значениемbackend-pool-1.
Так как переменная $upstream_http_x_sid
указана в параметре remote_result,
то ее значение будет использовано
для выбора сервера с sid=web-server-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#
Добавляет строку как соль в функцию MD5-хэширования
для директивы sticky в режимах cookie и route.
Строка может содержать переменные, например $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#
Если директива включена, Angie возвращает клиенту ошибку HTTP 502, когда идентификатор сервера, закрепленный за сессией, не соответствует ни одному серверу группы или этот сервер недоступен, а не переходит к балансировке нагрузки, как по умолчанию.
Встроенные переменные#
Переменная $upstream_sticky_status
HTTP-модуля Upstream показывает, содержал ли запрос
данные о привязке и попал ли он на привязанный сервер. Сам модуль
Используется с Используется с http_upstream_sticky поддерживает следующие встроенные переменные:$sticky_sessid (PRO)#remote_action в sticky;
хранит начальный идентификатор сессии, взятый из lookup.$sticky_sid (PRO)#remote_action в sticky;
хранит идентификатор сервера, предварительно выбранного методом балансировки:
значение его параметра sid=
или идентификатор, сгенерированный по умолчанию
(см. server).