Upstream Sticky#

Привязывает клиентские сессии к серверам групп потокового модуля Upstream, чтобы соединения одной сессии передавались на один и тот же сервер. Директивы модуля задаются в блоке 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;
}

Angie привязывает каждый адрес клиента к серверу его первой сессии и передает последующие соединения с этого адреса на тот же сервер.

Директивы#

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

По умолчанию

—

Контекст

upstream

Настраивает привязку клиентских сессий к проксируемым серверам в режиме, заданном первым параметром; для разгрузки серверов, у которых задана директива sticky, можно использовать опцию drain в блоке server.

Предупреждение

Директива sticky должна использоваться после всех директив, задающих тот или иной метод балансировки нагрузки, иначе она не будет работать.

Этот режим использует предопределенные идентификаторы маршрутов, которые могут быть встроены в свойства соединения, доступные Angie. Он менее гибок, так как зависит от предопределенных значений, но лучше подходит, если такие идентификаторы уже используются.

Здесь при установлении соединения проксируемый сервер может назначить клиенту маршрут и вернуть его идентификатор способом, известным им обоим. В качестве идентификатора маршрута должно использоваться значение параметра sid директивы server. Учтите, что параметр дополнительно хэшируется, если задана директива sticky_secret.

Последующие соединения от клиентов, желающих использовать этот маршрут, должны содержать выданный сервером идентификатор, причем так, чтобы он попал в переменные Angie.

В параметрах директивы указываются строки, которые могут содержать переменные для маршрутизации. Чтобы выбрать сервер, куда направляется входящее соединение, используется первое непустое значение; она затем сравнивается с параметром sid директивы server. Если выбрать сервер не удается или выбранный сервер не может принять соединение, то будет выбран другой сервер согласно настроенному методу балансировки.

Здесь Angie ищет идентификатор маршрута в переменной $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;
    }
}

Директива 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 в режиме 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#

Синтаксис

sticky_strict on | off;

По умолчанию

sticky_strict off;

Контекст

upstream

Если директива включена, Angie возвращает клиенту ошибку соединения, когда идентификатор сервера, закрепленный за сессией, не соответствует ни одному серверу группы или этот сервер недоступен, а не переходит к балансировке нагрузки, как по умолчанию.

Встроенные переменные#

Переменная $upstream_sticky_status потокового модуля Upstream показывает, содержало ли соединение данные о привязке и попало ли оно на привязанный сервер. Сам модуль stream_upstream_sticky поддерживает следующие встроенные переменные:

$sticky_sessid#

Используется с remote_action в sticky; хранит начальный идентификатор сессии, взятый из lookup.

$sticky_sid#

Используется с remote_action в sticky; хранит идентификатор сервера, предварительно выбранного методом балансировки: значение его параметра sid= или идентификатор, сгенерированный по умолчанию (см. server).