Модуль http_upstream

Модуль `http_upstream`#

Предоставляет контекст для описания группы серверов, которые могут использоваться в директивах proxy_pass, fastcgi_pass, uwsgi_pass, scgi_pass, memcached_pass и grpc_pass.

Пример конфигурации#

upstream backend {
    zone backend 1m;
    server backend1.example.com       weight=5;
    server backend2.example.com:8080;
    server backend3.example.com       service=_example._tcp resolve;
    server unix:/tmp/backend3;

    server backup1.example.com:8080   backup;
    server backup2.example.com:8080   backup;
}

resolver 127.0.0.53 status_zone=resolver;

server {
    location / {
        proxy_pass http://backend;
    }
}

Директивы#

upstream#

Синтаксис:: upstream имя { … }
Умолчание:: —
Контекст:: http

Описывает группу серверов. Серверы могут слушать на разных портах. Кроме того, можно одновременно использовать серверы, слушающие на TCP- и UNIX-сокетах.

Пример:

upstream backend {
    server backend1.example.com weight=5;
    server 127.0.0.1:8080       max_fails=3 fail_timeout=30s;
    server unix:/tmp/backend3;

    server backup1.example.com  backup;
}

По умолчанию запросы распределяются по серверам циклически (в режиме round-robin) с учетом весов серверов. В вышеприведенном примере каждые 7 запросов будут распределены так: 5 запросов на backend1.example.com и по одному запросу на второй и третий серверы.

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

upstream_probe#

Added in version 1.2.0.

Синтаксис:: upstream_probe имя [uri=адрес] [port=число] [interval=время] [test=условие] [essential] [fails=число] [passes=число] [max_body=размер] [mode=always|idle|onfail];
Умолчание:: —
Контекст:: location

Задает активную проверку работоспособности серверов тех upstream, которые указаны в директивах proxy_pass, uwsgi_pass и т. д. в том же контексте location, где находится директива upstream_probe. При этом Angie PRO регулярно выполняет запросы согласно указанным параметрам к каждому серверу в составе апстрима.

Сервер проходит проверку, если запрос к нему успешно выполняется с учетом всех параметров самой директивы upstream_probe и всех параметров, влияющих на использование апстримов тем контекстом location, где она задана. Это касается в том числе директив proxy_next_upstream, uwsgi_next_upstream и пр., а также proxy_set_header и т. д.

Чтобы использовать проверки, в апстриме необходима зона разделяемой памяти (zone). Для одного апстрима можно определить несколько проверок.

Могут быть заданы следующие параметры:

`имя`	Обязательное имя проверки.
`uri`	URI запроса, который добавляется к аргументу proxy_pass, uwsgi_pass и т. д. По умолчанию — `/`.
`port`	Альтернативный порт для запроса.
`interval`	Интервал между проверками. По умолчанию — `5s`.
`method`	HTTP-метод запроса проверки. По умолчанию — `GET`.
`test`	Проверяемое при запросе условие; задается строкой с переменными. Если результат подстановки переменных — `""` или `"0"`, проверка не пройдена.
`essential`	Если параметр задан, то изначально состояние сервера подлежит уточнению и клиентские запросы не передаются ему, пока проверка не будет пройдена.
`fails`	Число последовательных неуспешных запросов, при котором проверка считает сервер неработающим. По умолчанию — 1.
`passes`	Число последовательных успешных запросов, при котором проверка считает сервер работающим. По умолчанию — 1.
`max_body`	Максимальный объем памяти для тела ответа. По умолчанию — `256k`.
`mode`	Режим проверки в зависимости от работоспособности серверов: `always` — серверы проверяются независимо от состояния; `idle` — проверяются неработающие серверы, а также серверы, где с последнего клиентского запроса прошло время `interval`. `onfail` — проверяются серверы только в неработающем состоянии. По умолчанию — `always`.

Пример:

upstream backend {
    zone backend 1m;

    server backend1.example.com;
    server backend2.example.com;
}

map $upstream_status $good {
    200     "1";
}

server {
    listen ...;

    location @probes {
        ...
        proxy_pass http://backend;

        upstream_probe backend_probe
            uri=/probe
            port=10004
            interval=5s
            test=$good
            essential
            fails=3
            passes=3
            max_body=10m
            mode=idle;
    }
}

Детали работы:

Изначально сервер не получает клиентские запросы, пока не пройдет все заданные для него проверки с параметром essential. Если таких проверок нет, сервер считается работающим.
Сервер считается неработающим и не получает клиентские запросы, если какая-либо заданная для него проверка достигает своего порога fails или сам сервер достигает порога max_fails.
Чтобы неработающий сервер снова мог считаться работающим, все заданные для него проверки должны достичь своего порога passes; после этого учитывается порог max_fails.

server#

Синтаксис:: server адрес [параметры];
Умолчание:: —
Контекст:: upstream

Задает адрес и другие параметры сервера. Адрес может быть указан в виде доменного имени или IP-адреса, и необязательного порта, или в виде пути UNIX-сокета, который указывается после префикса unix:. Если порт не указан, используется порт 80. Доменное имя, которому соответствует несколько IP-адресов, задает сразу несколько серверов.

Могут быть заданы следующие параметры:

weight=число

задает вес сервера
по умолчанию 1.

max_conns=число

ограничивает максимальное число одновременных активных соединений к проксируемому серверу.
Значение по умолчанию равно 0 и означает, что ограничения нет. Если группа не находится в зоне разделяемой памяти, то ограничение работает отдельно для каждого рабочего процесса.

Примечание

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

max_fails=число — задает число неудачных попыток связи с сервером, которые должны произойти в течение заданного fail_timeout времени для того, чтобы сервер считался недоступным; после этого он будет повторно проверен через то же самое время.

Что считается неудачной попыткой, определяется директивами proxy_next_upstream, fastcgi_next_upstream, uwsgi_next_upstream, scgi_next_upstream, memcached_next_upstream и grpc_next_upstream.

При превышении max_fails сервер также признается неработающим с точки зрения upstream_probe; клиентские запросы не будут направляться к нему, пока проверки не признают его работающим.

Примечание

Если в апстриме задан только один server, max_fails не работает и будет игнорироваться.

`max_fails=1`	число попыток по умолчанию
`max_fails=0`	отключает учет попыток

fail_timeout=время — задает период времени, в течение которого должно произойти определенное число неудачных попыток связи с сервером (max_fails), чтобы сервер считался недоступным. Затем сервер остается недоступным в течение того же самого времени, прежде чем будет проверен повторно.

Значение по умолчанию — 10 секунд.

Примечание

Если в апстриме задан только один server, fail_timeout не работает и будет игнорироваться.

`backup`	помечает сервер как запасной. На него будут передаваться запросы в случае, если не работают основные серверы.
`down`	помечает сервер как постоянно недоступный.
`drain`	помечает сервер как разгружаемый (draining); это значит, что он получает только запросы сессий, привязанных ранее через sticky. В остальном поведение такое же, как в режиме `down`.

Осторожно

Параметр backup нельзя использовать совместно с методами балансировки нагрузки hash, ip_hash и random.

Параметры down и drain взаимно исключающие.

Added in version 1.1.0.

resolve

позволяет отслеживать изменения списка IP-адресов, соответствующего доменному имени, и обновлять его без перезагрузки конфигурации. При этом группа должна находиться в зоне разделяемой памяти; также должен быть определен преобразователь имен в адреса.

service=имя

включает преобразование SRV-записей DNS и задает имя сервиса. Для работы параметра необходимо задать параметр resolve у сервера, не указывая порт сервера при имени хоста.

Если в имени службы нет точек, формируется имя по стандарту RFC: к имени службы добавляется префикс _, затем через точку добавляется _tcp. Так, имя службы http даст в результате _http._tcp.

Angie PRO разрешает SRV-записи, объединяя нормализованное имя службы и имя хоста и получая список серверов для полученной комбинации через DNS, вместе с их приоритетами и весами.

SRV-записи с наивысшим приоритетом (те, которые имеют минимальное значение приоритета) разрешаются как основные серверы, а прочие записи становятся запасными серверами. Если backup установлено с server, SRV-записи с наивысшим приоритетом разрешаются как запасные серверы, а прочие записи игнорируются.
Вес аналогичен параметру weight директивы server. Если вес задан как в самой директиве, так и в SRV-записи, используется вес, установленный в директиве.

В этом примере выполняется поиск записи _http._tcp.backend.example.com:

server backend.example.com service=http resolve;

Added in version 1.1.0-P1.

sid=id

задает ID сервера в группе.
Если параметр не задан, то ID задается как шестнадцатеричный MD5-хэш IP-адреса и порта или пути UNIX-сокета.

Added in version 1.4.0.

slow_start=время

задает время восстановления веса сервера, возвращающегося к работе при балансировке нагрузки методом round-robin или least_conn.

Если параметр задан и сервер после сбоя снова считается работающим с точки зрения max_fails и upstream_probe, то такой сервер равномерно набирает указанный для него вес в течение заданного времени.

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

Примечание

Если в апстриме задан только один server, slow_start не работает и будет игнорироваться.

Added in version 1.2.0.

state#

Синтаксис:: state файл;
Умолчание:: —
Контекст:: upstream

Указывает файл, где постоянно хранится список серверов апстрима. При установке из наших пакетов для хранения таких файлов специально создается каталог /var/lib/angie/state/ (/var/db/angie/state/ во FreeBSD) с соответствующими правами доступа, и в конфигурации остается добавить лишь имя файла:

upstream backend {

    zone backend 1m;
    state /var/lib/angie/state/<ИМЯ ФАЙЛА>;
}

Список серверов здесь имеет формат, аналогичный server. Содержимое файла изменяется при любом изменении серверов в разделе /config/http/upstreams/ через API конфигурации. Файл считывается при запуске Angie PRO или перезагрузке конфигурации.

Осторожно

Чтобы использовать директиву state в блоке upstream, в нем не должно быть директив server, но нужна зона разделяемой памяти (zone).

zone#

Синтаксис:: zone имя [размер];
Умолчание:: —
Контекст:: upstream

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

hash#

Синтаксис:: hash ключ [consistent];
Умолчание:: —
Контекст:: upstream

Задает метод балансировки нагрузки для группы, при котором соответствие клиента серверу определяется при помощи хэшированного значения ключа. В качестве ключа может использоваться текст, переменные и их комбинации. Следует отметить, что любое добавление или удаление серверов в группе может привести к перераспределению большинства ключей на другие серверы. Метод совместим с библиотекой Perl Cache::Memcached.

Если задан параметр consistent, то вместо вышеописанного метода будет использоваться метод консистентного хэширования ketama. Метод гарантирует, что при добавлении сервера в группу или его удалении на другие серверы будет перераспределено минимальное число ключей. Применение метода для кэширующих серверов обеспечивает больший процент попаданий в кэш. Метод совместим с библиотекой Perl Cache::Memcached::Fast при значении параметра ketama_points равным 160.

ip_hash#

Синтаксис:: ip_hash;
Умолчание:: —
Контекст:: upstream

Задает для группы метод балансировки нагрузки, при котором запросы распределяются по серверам на основе IP-адресов клиентов. В качестве ключа для хэширования используются первые три октета IPv4-адреса клиента или IPv6-адрес клиента целиком. Метод гарантирует, что запросы одного и того же клиента будут всегда передаваться на один и тот же сервер. Если же этот сервер будет считаться недоступным, то запросы этого клиента будут передаваться на другой сервер. С большой долей вероятности это также будет один и тот же сервер.

Если один из серверов нужно убрать на некоторое время, то для сохранения текущего хэширования IP-адресов клиентов этот сервер нужно пометить параметром down:

upstream backend {
    ip_hash;

    server backend1.example.com;
    server backend2.example.com;
    server backend3.example.com down;
    server backend4.example.com;
}

keepalive#

Синтаксис:: keepalive соединения;
Умолчание:: —
Контекст:: upstream

Задействует кэш соединений для группы серверов.

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

Примечание

Следует особо отметить, что директива keepalive не ограничивает общее число соединений с серверами группы, которые рабочие процессы Angie PRO могут открыть. Параметр соединения следует устанавливать достаточно консервативно, чтобы серверы группы по-прежнему могли обрабатывать новые входящие соединения.

Внимание

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

Пример конфигурации группы серверов memcached с постоянными соединениями:

upstream memcached_backend {
    server 127.0.0.1:11211;
    server 10.0.0.2:11211;

    keepalive 32;
}

server {
    #...

    location /memcached/ {
        set $memcached_key $uri;
        memcached_pass memcached_backend;
    }

}

Для HTTP директиву proxy_http_version следует установить в «1.1», а поле заголовка «Connection» — очистить:

upstream http_backend {
    server 127.0.0.1:8080;

    keepalive 16;
}

server {
    #...

    location /http/ {
        proxy_pass http://http_backend;
        proxy_http_version 1.1;
        proxy_set_header Connection "";
    #    ...
    }
}

Примечание

Хоть это и не рекомендуется, но также возможно использование постоянных соединений с HTTP/1.0, путем передачи поля заголовка «Connection: Keep-Alive» серверу группы.

Для работы постоянных соединений с FastCGI-серверами потребуется включить директиву fastcgi_keep_conn:

upstream fastcgi_backend {
    server 127.0.0.1:9000;

    keepalive 8;
}

server {
    #...

    location /fastcgi/ {
        fastcgi_pass fastcgi_backend;
        fastcgi_keep_conn on;
    #    ...
    }
}

Примечание

Протоколы SCGI и uwsgi не определяют семантику постоянных соединений.

keepalive_requests#

Синтаксис:: keepalive_requests число;
Умолчание:: keepalive_requests 1000;
Контекст:: upstream

Задает максимальное число запросов, которые можно сделать по одному постоянному соединению. После того как сделано максимальное число запросов, соединение закрывается.

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

keepalive_time#

Синтаксис:: keepalive_time время;
Умолчание:: keepalive_time 1h;
Контекст:: upstream

Ограничивает максимальное время, в течение которого могут обрабатываться запросы в рамках постоянного соединения. По достижении заданного времени соединение закрывается после обработки очередного запроса.

keepalive_timeout#

Синтаксис:: keepalive_timeout время;
Умолчание:: keepalive_timeout 60s;
Контекст:: upstream

Задает таймаут, в течение которого неактивное постоянное соединение с сервером группы не будет закрыто.

bind_conn#

Синтаксис:: bind_conn значение;
Умолчание:: —
Контекст:: upstream

Позволяет привязать серверное соединение к клиентскому в момент, когда значение, заданное строкой из переменных, становится отличным от "" и "0".

Внимание

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

Внимание

При использовании директивы настройки модуля http_proxy должны допускать использование постоянных соединений, например:

proxy_http_version 1.1;
proxy_set_header Connection "";

Типичный пример использования директивы — проксирование соединений с NTLM-аутентификацией, где требуется обеспечить привязку клиента к серверу в начале согласования:

map $http_authorization   $ntlm {
    ~*^N(?:TLM|egotiate)  1;
}

upstream ntlm_backend {
    server 127.0.0.1:8080;
    bind_conn $ntlm;
}

server {
    # ...
    location / {
        proxy_pass http://ntlm_backend;
        proxy_http_version 1.1;
        proxy_set_header Connection "";
        # ...
    }
}

least_conn#

Синтаксис:: least_conn;
Умолчание:: —
Контекст:: upstream

Задает для группы метод балансировки нагрузки, при котором запрос передается серверу с наименьшим числом активных соединений, с учетом весов серверов. Если подходит сразу несколько серверов, они выбираются циклически (в режиме round-robin) с учетом их весов.

least_time#

Синтаксис:: least_time header | last_byte;
Умолчание:: —
Контекст:: upstream

Задает для группы метод балансировки нагрузки, при котором вероятность передачи запроса активному серверу обратно пропорциональна среднему времени его ответа; чем оно меньше, тем больше запросов будет получать сервер.

В режиме header учитывается среднее время получения заголовков ответа; в режиме last_byte — среднее время получения полного ответа.

Подсчет средних значений управляется директивой response_time_factor. Текущие значения представлены как header_time (только заголовки) и response_time (ответы целиком) в объекте health сервера среди метрик апстрима в API.

queue#

Added in version 1.4.0.

Синтаксис:: queue число [timeout=время];
Умолчание:: —
Контекст:: upstream

Если для запроса не удается назначить проксируемый сервер с первой попытки (например, при краткосрочном перебое в работе или всплеске нагрузки с достижением предела max_conns), запрос не отклоняется; вместо этого Angie PRO пытается поставить его в очередь на обработку.

Численный параметр директивы задает максимальное количество запросов в очереди рабочего процесса. Если очередь целиком заполнена, клиенту отдается ошибка 502 (Bad Gateway).

Примечание

К запросам в очереди также применяется логика директивы proxy_next_upstream. В частности, если для запроса был выбран сервер, но передать его туда не удалось, то он может вернуться в очередь.

Если сервер для передачи запроса в очереди не был выбран за время timeout (по умолчанию — 60 секунд), клиенту отдается ошибка 502 (Bad Gateway). Еще из очереди удаляются запросы от клиентов, преждевременно закрывших соединение; в API есть счетчики состояний запросов, проходящих через очередь.

Внимание

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

random#

Синтаксис:: random [two];
Умолчание:: —
Контекст:: upstream

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

Если указан необязательный параметр two, Angie PRO случайным образом выбирает два сервера, из которых выбирает сервер, используя метод least_conn, при котором запрос передается на сервер с наименьшим количеством активных соединений.

response_time_factor#

Синтаксис:: response_time_factor число;
Умолчание:: response_time_factor 90;
Контекст:: upstream

Задает для метода балансировки нагрузки least_time коэффициент сглаживания предыдущего значения при вычислении среднего времени ответа по формуле экспоненциально взвешенного скользящего среднего.

Чем больше указанное число, тем меньше новые значения влияют на среднее; если указать 90, то будет взято 90 % от предыдущего значения и лишь 10 % от нового. Допустимые значения — от 0 до 99 включительно.

Текущие результаты вычислений представлены как header_time (только заголовки) и response_time (ответы целиком) в объекте health сервера среди метрик апстрима в API.

Примечание

При подсчете учитываются только успешные ответы; что считать неуспешным ответом, определяют директивы proxy_next_upstream, fastcgi_next_upstream, uwsgi_next_upstream, scgi_next_upstream, memcached_next_upstream и grpc_next_upstream. Кроме того, значение header_time пересчитывается, только если получены и обработаны все заголовки, а response_time — только если получен весь ответ.

sticky#

Added in version 1.1.0-P1.

Синтаксис:: sticky cookie name [attr=значение]…;
sticky route $variable…;
sticky learn zone=зона create=$variable1… lookup=$cookie1… [header] [timeout=время];
Умолчание:: —
Контекст:: upstream

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

Внимание

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

В этом режиме запрос от клиента, пока не привязанного к какому-то серверу, отправляется на сервер, выбираемый согласно настроенному методу балансировки. При этом данные о выбранном таким образом сервере сохраняются в cookie, который Angie PRO создает специально для этой цели.

Имя cookie (name) задается самой директивой sticky, а значение (value) соответствует параметру sid директивы server (учтите, что параметр дополнительно хэшируется, если задана директива sticky_secret).

Последующие запросы от клиента, содержащие соответствующий cookie, передаются на сервер, соответствующий значению cookie, то есть имеющий заданный в нем sid. Если выбрать сервер не удается или выбранный таким образом сервер не может обработать запрос, то будет выбран другой сервер согласно настроенному методу балансировки.

Директива позволяет назначать атрибуты такого cookie; единственный атрибут, устанавливаемый по умолчанию, — path=/. Значения атрибутов задаются строками с переменными. Чтобы удалить атрибут, задайте для него пустое значение: attr=. Так, sticky cookie path= задает cookie без атрибута path.

Здесь Angie PRO создает cookie srv_id со сроком действия в 1 час и доменом, заданным переменной:

upstream backend {
    server backend1.example.com:8080;
    server backend2.example.com:8080;

    sticky cookie srv_id domain=$my_domain max-age=3600;
}

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

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

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

Здесь Angie PRO ищет идентификатор маршрута в cookie route, затем в аргументе запроса route:

upstream backend {
    server backend1.example.com:8080 sid="server1";
    server backend2.example.com:8080 sid="server2";

    sticky route $cookie_route $arg_route;
}

В этом режиме сессия создается на основе ответа проксируемого сервера. Параметры create и lookup перечисляют переменные, указывающие, как создаются новые и ищутся существующие сессии. Оба параметра можно использовать по нескольку раз.

Идентификатором сессии служит значение первой непустой переменной, указанная в create; например, это может быть cookie с проксируемого сервера.

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

Сессии хранятся в зоне общей памяти; ее имя и размер задаются параметром zone. Если к сессии не было обращений в течение времени timeout, она удаляется. Значение по умолчанию — 10 минут.

Параметр header позволяет создать сессию сразу после получения заголовков ответа от проксируемого сервера. Без него сессия создается только после завершения обработки запроса.

В примере Angie PRO создает сессию, устанавливая в ответе cookie с именем examplecookie:

upstream backend {
    server backend1.example.com:8080;
    server backend2.example.com:8080;

    sticky learn
        create=$upstream_cookie_examplecookie
        lookup=$cookie_examplecookie
        zone=client_sessions:1m;
}

sticky_strict#

Added in version 1.1.0-P1.

Синтаксис:: sticky_strict on | off;
Умолчание:: sticky_strict off;
Контекст:: upstream

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

sticky_secret#

Added in version 1.1.0-P1.

Синтаксис:: sticky_secret строка;
Умолчание:: —
Контекст:: upstream

Добавляет строку как соль в функцию MD5-хэширования для директивы sticky в режимах cookie и route. Строка может содержать переменные, например $remote_addr:

upstream backend {
    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

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

Модуль http_upstream поддерживает следующие встроенные переменные:

`$upstream_addr`#

хранит IP-адрес и порт или путь к UNIX-сокету сервера группы. Если при обработке запроса были сделаны обращения к нескольким серверам, то их адреса разделяются запятой, например:

192.168.1.1:80, 192.168.1.2:80, unix:/tmp/sock

Если произошло внутреннее перенаправление от одной группы серверов на другую с помощью «X-Accel-Redirect» или error_page, то адреса, соответствующие разным группам серверов, разделяются двоеточием, например:

192.168.1.1:80, 192.168.1.2:80, unix:/tmp/sock : 192.168.10.1:80, 192.168.10.2:80

Если сервер не может быть выбран, то переменная хранит имя группы серверов.

`$upstream_bytes_received`#

число байт, полученных от сервера группы. Значения нескольких соединений разделяются запятыми и двоеточиями подобно адресам в переменной $upstream_addr.

`$upstream_bytes_sent`#

число байт, переданных на сервер группы. Значения нескольких соединений разделяются запятыми и двоеточиями подобно адресам в переменной $upstream_addr.

`$upstream_cache_status`#

хранит статус доступа к кэшу ответов. Статус может быть одним из MISS, BYPASS, EXPIRED, STALE, UPDATING, REVALIDATED или HIT:

MISS: Ответ не найден в кэше, и запрос передан на сервер.
BYPASS: Кэш обойден, и запрос напрямую передан на сервер.
EXPIRED: Ответ в кэше устарел, и на сервер передан новый запрос для обновления контента.
STALE: Ответ в кэше устарел, но по-прежнему передается клиентам, пока через какое-то время не произойдет обновление контента c сервера.
UPDATING: Ответ в кэше устарел, но по-прежнему передается клиентам, пока уже идущее обновление контента c сервера не завершится.
REVALIDATED: Ответ в кэше устарел, но был успешно перепроверен и не нуждается в обновлении с сервера.
HIT: Ответ был взят из кэша.

Если запрос пошел в обход кэша без обращения к нему, переменная не устанавливается.

`$upstream_connect_time`#

хранит время, затраченное на установление соединения с сервером группы; время хранится в секундах с точностью до миллисекунд. В случае SSL включает в себя время, потраченное на рукопожатие. Времена нескольких соединений разделяются запятыми и двоеточиями подобно адресам в переменной $upstream_addr.

`$upstream_header_time`#

хранит время, затраченное на получение заголовка ответа от сервера группы; время хранится в секундах с точностью до миллисекунд. Времена нескольких ответов разделяются запятыми и двоеточиями подобно адресам в переменной $upstream_addr.

`$upstream_http_` имя#

хранят поля заголовка ответа сервера. Например, поле заголовка ответа «Server» доступно в переменной $upstream_http_server. Правила преобразования имен полей заголовка ответа в имена переменных такие же, как для переменных с префиксом «$http_». Необходимо иметь в виду, что поля заголовка запоминаются только из ответа последнего сервера.

`$upstream_probe_body` (PRO)#

Тело ответа от сервера, полученного при проверке upstream_probe. Его размер ограничен параметром max_body.

`$upstream_queue_time`#

хранит время, проведенное запросом в очереди до очередного выбора сервера и выраженное в секундах с точностью до миллисекунд. Времена нескольких попыток разделяются запятыми и двоеточиями подобно адресам в переменной $upstream_addr.

`$upstream_response_length`#

хранит длину ответа, полученного от сервера группы; длина хранится в байтах. Длины нескольких ответов разделяются запятыми и двоеточиями подобно адресам в переменной $upstream_addr.

`$upstream_response_time`#

хранит время, затраченное на получение ответа от сервера группы; время хранится в секундах с точностью до миллисекунд. Времена нескольких ответов разделяются запятыми и двоеточиями подобно адресам в переменной $upstream_addr.

`$upstream_status`#

хранит статус ответа, полученного от сервера группы. Статусы нескольких ответов разделяются запятыми и двоеточиями подобно адресам в переменной $upstream_addr. Если сервер не может быть выбран, то переменная хранит статус 502 (Bad Gateway).

`$upstream_sticky_status`#

Статус привязанного запроса.

`''`	запрос к upstream не обрабатывался модулем http_upstream_sticky
`NEW`	запрос не содержит информации о привязке к серверу
`HIT`	запрос с привязкой отправлен на соответствующий сервер
`MISS`	запрос с привязкой отправлен на сервер, выбранный по алгоритму балансировки

Статусы нескольких ответов разделяются запятыми и двоеточиями подобно адресам в переменной $upstream_addr.

`$upstream_trailer_` имя#

хранит поля из конца ответа, полученного от сервера группы.

Модуль http_upstream

Содержание

Модуль http_upstream#

Пример конфигурации#

Директивы#

upstream#

upstream_probe#

server#

state#

zone#

hash#

ip_hash#

keepalive#

keepalive_requests#

keepalive_time#

keepalive_timeout#

bind_conn#

least_conn#

least_time#

queue#

random#

response_time_factor#

sticky#

sticky_strict#

sticky_secret#

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

$upstream_addr#

$upstream_bytes_received#

$upstream_bytes_sent#

$upstream_cache_status#

$upstream_connect_time#

$upstream_cookie_ имя#

$upstream_header_time#

$upstream_http_ имя#

$upstream_probe_body (PRO)#

$upstream_queue_time#

$upstream_response_length#

$upstream_response_time#

$upstream_status#

$upstream_sticky_status#

$upstream_trailer_ имя#

Модуль `http_upstream`#

`$upstream_addr`#

`$upstream_bytes_received`#

`$upstream_bytes_sent`#

`$upstream_cache_status`#

`$upstream_connect_time`#

`$upstream_cookie_` имя#

`$upstream_header_time`#

`$upstream_http_` имя#

`$upstream_probe_body` (PRO)#

`$upstream_queue_time`#

`$upstream_response_length`#

`$upstream_response_time`#

`$upstream_status`#

`$upstream_sticky_status`#

`$upstream_trailer_` имя#