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=значение]...;

sticky route значение...;

sticky learn zone=зона create=$create_var1... lookup=$lookup_var1... [header] [norefresh] [timeout=время];

sticky learn [zone=зона] lookup=$lookup_var1... remote_action=uri remote_result=$remote_var [norefresh] [timeout=время]; (PRO)

По умолчанию

—

Контекст

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;
}

Директива sticky учитывает состояние серверов в upstream:

  • Серверы, помеченные как down или временно недоступные из-за сбоев, исключаются из выбора.

  • Серверы, которые достигли максимального количества соединений (при использовании max_conns), временно пропускаются.

  • Серверы с опцией drain могут быть выбраны для создания новых сессий в режиме sticky при совпадении идентификаторов.

  • Если ранее недоступный сервер восстанавливается, sticky автоматически возобновляет его использование.

Поведение sticky можно дополнительно настроить директивами sticky_secret и sticky_strict. Если в ходе работы sticky выбрать сервер не удается или он недоступен, запрос будет обработан согласно выбранному методу балансировки нагрузки, если только не включена директива sticky_strict. В режиме sticky_strict on; запрос отклоняется с ошибкой.

Зоны разделяемой памяти, указываемые в параметре zone директивы sticky, не могут использоваться совместно различными upstream; каждая группа должна использовать свою собственную зону.

sticky_secret#

Синтаксис

sticky_secret строка;

По умолчанию

—

Контекст

upstream

Добавляет строку как соль в функцию 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#

Синтаксис

sticky_strict on | off;

По умолчанию

sticky_strict off;

Контекст

upstream

Если директива включена, 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).