Upstream#
Предоставляет контекст для описания группы серверов, которые могут использоваться в директиве proxy_pass.
Привязку сессий и балансировку по обратной связи (PRO)
обеспечивают отдельные модули Upstream Sticky и
Upstream Feedback;
их директивы тоже задаются в блоке upstream.
Связанные руководства
Балансировка нагрузки: балансировка HTTP без
ip_hash.Панель Console Light: показывает только группы с zone.
Пример конфигурации#
upstream backend {
zone backend 1m;
server backend1.example.com:1935 weight=5;
server unix:/tmp/backend3;
server backend3.example.com service=_example._tcp resolve;
server backup1.example.com:1935 backup;
server backup2.example.com:1935 backup;
}
resolver 127.0.0.53 status_zone=resolver;
server {
listen 1936;
proxy_pass backend;
}
Директивы#
backup_switch (PRO)#
Добавлено в версии 1.10.0: PRO
Директива включает возможность начать выбор серверов не с основной группы, а с активной, то есть той, где в предыдущий раз был успешно найден сервер. Если найти сервер в активной группе для очередного запроса не удается, и поиск переходит к резервной группе, то уже эта группа становится активной, и последующие запросы сначала направляются на серверы этой группы.
Если параметр permanent определен без значения времени,
группа остается активной после выбора,
и автоматическая перепроверка групп с меньшим уровнем не происходит.
Если время задано,
то активный статус группы истекает через указанный интервал,
и балансировщик снова проверяет группы с меньшим уровнем,
возвращаясь к ним, если серверы работают нормально.
Пример:
upstream media_backend {
zone media_backend 1m;
server primary1.example.com:1935;
server primary2.example.com:1935;
server reserve1.example.com:1935 backup;
server reserve2.example.com:1935 backup;
backup_switch permanent=2m;
}
Если балансировщик переключается с основных серверов на резервную группу, все последующие запросы обрабатываются этой резервной группой в течение 2 минут. По истечении 2 минут балансировщик повторно проверяет основные серверы и снова делает их активными, если они работают нормально.
hash#
При сборке из исходного кода поддержку этой директивы
можно отключить с помощью параметра сборки
--without-stream_upstream_hash_module.
Задает метод балансировки нагрузки для группы, при котором соответствие клиента серверу определяется при помощи хэшированного значения ключа. В качестве ключа можно использовать переменные. Следует отметить, что любое добавление или удаление серверов в группе может привести к перераспределению большинства ключей на другие серверы. Метод совместим с библиотекой Perl Cache::Memcached.
Пример использования:
hash $remote_addr;
Если задан параметр consistent, то вместо вышеописанного метода будет
использоваться метод консистентного хэширования ketama.
Метод гарантирует, что при добавлении сервера в группу или его удалении на
другие серверы будет перераспределено минимальное число ключей. Применение
метода для кэширующих серверов обеспечивает больший процент попаданий в кэш.
Метод совместим с библиотекой Perl Cache::Memcached::Fast при значении параметра
ketama_points, равном 160.
Имя в директиве server может разрешаться в несколько адресов:
при загрузке конфигурации или с помощью параметра resolve.
С параметром consistent метод хэширует не адреса, а имя (при параметре
service это целевые имена SRV-записей): соединение, ключ которого
приходится на имя, передается одному из адресов этого имени циклически
(в режиме round-robin) с учетом весов, поэтому ключ не закреплен ни за одним
конкретным адресом.
Без consistent каждый адрес считается отдельным сервером, но Angie
не сортирует адреса, поэтому на разных экземплярах Angie один и тот же ключ
может попадать на разные адреса.
О том, как закрепить ключи за отдельными адресами, см. в руководстве по балансировке нагрузки.
least_conn#
При сборке из исходного кода поддержку этой директивы
можно отключить с помощью параметра сборки
--without-stream_upstream_least_conn_module.
Задает для группы метод балансировки нагрузки, при котором соединение передается серверу с наименьшим числом активных соединений, с учетом весов серверов. Если подходит сразу несколько серверов, они выбираются циклически (в режиме round-robin) с учетом их весов.
least_time#
| |
По умолчанию | — |
upstream |
При сборке из исходного кода поддержку этой директивы
можно отключить с помощью параметра сборки
--without-stream_upstream_least_time_module.
Задает для группы метод балансировки нагрузки, при котором вероятность передачи соединения активному серверу обратно пропорциональна среднему времени его ответа; чем оно меньше, тем больше соединений будет получать сервер.
| Директива учитывает среднее время установки соединения. |
| Директива использует среднее время получения первого байта ответа. |
| Директива использует среднее время получения полного ответа. |
| Выполняет ту же функцию, что и response_time_factor, и переопределяет его, если параметр задан. |
| Указывает условную переменную,
которая контролирует, какие соединения учитываются при расчете.
Среднее значение обновляется,
только если условная переменная соединения
не равна Примечание По умолчанию активные проверки (PRO)
не включаются в расчет;
комбинация переменной $upstream_probe
с |
Текущие значения представлены как connect_time, first_byte_time
и last_byte_time в объекте health сервера
среди метрик апстрима в API.
no_port (PRO)#
Добавлено в версии 1.12.0: PRO
Явно помечает группу серверов как не использующую порты: адреса ее серверов задаются без порта, а порт соединения указывается в каждой ссылающейся на группу директиве proxy_pass.
Директива предназначена для групп, в которых серверы не перечислены статически, а добавляются динамически через API конфигурации. Такие группы нуждаются в зонах разделяемой памяти и по умолчанию считаются использующими порты. Одну группу без портов можно затем использовать для проксирования на разные порты без дублирования списка серверов:
upstream backend {
zone backend 1m;
no_port;
}
server {
listen 8443;
proxy_pass backend:8443;
}
server {
listen 8080;
proxy_pass backend:8080;
}
Группа считается не использующей порты и без этой директивы, если адреса ее
серверов заданы доменными именами или IP-адресами без
портов. Директива no_port явно фиксирует это свойство группы и запрещает
адреса с указанным портом.
В группе без портов допустимы только доменные имена и IP-адреса без портов; пути
UNIX-сокетов и серверы с параметром service= для разрешения записей DNS
SRV не допускаются. Доменные имена и IP-адреса в одной группе должны быть либо
все с портами, либо все без них; смешивать эти варианты нельзя.
random#
При сборке из исходного кода поддержку этой директивы
можно отключить с помощью параметра сборки
--without-stream_upstream_random_module.
Задает для группы метод балансировки нагрузки, при котором соединение передается случайно выбранному серверу, с учетом весов серверов.
Если указан необязательный параметр two, Angie случайным образом выбирает два сервера и передает соединение тому из них, у которого меньше активных соединений на единицу веса.
response_time_factor#
Задает для метода балансировки нагрузки least_time коэффициент сглаживания предыдущего значения при вычислении среднего времени ответа по формуле экспоненциально взвешенного скользящего среднего.
Чем больше указанное число, тем меньше новые значения влияют на среднее; если
указать 90, то будет взято 90 % от предыдущего значения и лишь 10 % от
нового. Допустимые значения — от 0 до 99 включительно.
Текущие результаты вычислений представлены как connect_time (время
установления соединения), first_byte_time (время получения первого
байта ответа) и last_byte_time (время получения ответа целиком) в
объекте health сервера среди метрик апстрима в API.
Примечание
При подсчете учитываются только успешные ответы; что считать неуспешным ответом, определяют директивы proxy_next_upstream.
server#
Задает адрес и другие параметры сервера.
Адрес может быть указан в виде доменного имени или IP-адреса
либо в виде пути UNIX-сокета после префикса unix:.
Доменное имя, которому соответствует несколько IP-адресов,
задает сразу несколько серверов.
Для доменного имени или IP-адреса порт обязателен,
кроме группы без портов (PRO),
где он опускается и задается в директиве proxy_pass.
Могут быть заданы следующие параметры:
| Задает вес сервера. По умолчанию — 1. |
| Ограничивает максимальное число одновременных активных соединений к проксируемому серверу. Значение по умолчанию равно |
max_fails=число — задает число неудачных попыток связи с сервером,
которые должны произойти в течение заданного fail_timeout времени для того, чтобы сервер считался недоступным; после
этого он будет повторно проверен через то же самое время.
В данном случае неудачной попыткой считается ошибка или таймаут при установке соединения с сервером.
Примечание
Если директива server в группе разрешается в несколько серверов,
ее настройка max_fails применяется к каждому серверу отдельно.
Если после разрешения всех директив server
в апстриме остается только один сервер,
настройка max_fails не действует и будет проигнорирована.
| Число попыток по умолчанию. |
| Отключает учет попыток. |
fail_timeout=время — задает период времени, в течение которого
должно произойти определенное число неудачных попыток связи с сервером
(max_fails), чтобы сервер считался недоступным.
Затем сервер остается недоступным в течение того же самого времени,
прежде чем будет проверен повторно.
Значение по умолчанию — 10 секунд.
Примечание
Если директива server в группе разрешается в несколько серверов,
ее настройка fail_timeout применяется к каждому серверу отдельно.
Если после разрешения всех директив server
в апстриме остается только один сервер,
настройка fail_timeout не действует и будет проигнорирована.
| Помечает сервер как запасной. На него будут передаваться запросы в случае, если не работают основные серверы. |
| Помечает сервер как постоянно недоступный. |
| Помечает сервер как разгружаемый (draining); это значит,
что он получает только запросы сессий,
привязанных ранее через sticky.
В остальном поведение такое же, как в режиме |
Предупреждение
Параметр backup нельзя использовать совместно с методами
балансировки нагрузки hash и random.
Параметры down и drain взаимно исключающие.
| Позволяет отслеживать изменения списка IP-адресов, соответствующего доменному имени, и обновлять его без перезагрузки конфигурации. При этом группа должна находиться в зоне разделяемой памяти; также должен быть определен преобразователь имен в адреса. |
| Включает преобразование SRV-записей DNS и задает имя сервиса. При указании этого параметра необходимо также задать параметр resolve, не указывая порт сервера при имени хоста. Если в имени службы нет точек, формируется имя по стандарту RFC:
к имени службы добавляется префикс Angie разрешает SRV-записи, объединяя нормализованное имя службы и имя хоста и получая список серверов для полученной комбинации через DNS, вместе с их приоритетами и весами.
|
В этом примере выполняется поиск записи _http._tcp.backend.example.com:
server backend.example.com service=http resolve;
| Задает ID сервера в группе. Если параметр не задан, то ID задается как шестнадцатеричный MD5-хэш IP-адреса и порта или пути UNIX-сокета. |
| Задает время восстановления веса сервера, возвращающегося к работе при балансировке нагрузки методом round-robin или least_conn. Если параметр задан и сервер после сбоя снова считается работающим с точки зрения max_fails и upstream_probe (PRO), то такой сервер равномерно набирает указанный для него вес в течение заданного времени. Если параметр не задан, то в аналогичной ситуации сервер сразу начинает работу с указанным для него весом. |
Примечание
Если в апстриме задан только один server,
slow_start не работает и будет игнорироваться.
state (PRO)#
Указывает файл, где постоянно хранится список серверов апстрима.
При установке из
наших пакетов
для хранения таких файлов специально создается каталог
/var/lib/angie/state/ (/var/db/angie/state/ во FreeBSD)
с соответствующими правами доступа,
и в конфигурации остается добавить лишь имя файла:
upstream backend {
zone backend 1m;
state /var/lib/angie/state/<ИМЯ_ФАЙЛА>;
}
Список серверов здесь имеет формат, аналогичный server. Содержимое файла изменяется при любом изменении серверов в разделе /config/stream/upstreams/ через API конфигурации. Файл считывается при запуске Angie или перезагрузке конфигурации.
Предупреждение
Чтобы использовать директиву state в блоке upstream,
в нем не должно быть директив server,
но нужна зона разделяемой памяти (zone).
upstream#
Описывает группу серверов. Серверы могут слушать на разных портах. Кроме того, можно одновременно использовать серверы, слушающие на TCP- и UNIX-сокетах.
Пример:
upstream backend {
zone backend 1m;
server backend1.example.com:1935 weight=5;
server 127.0.0.1:1935 max_fails=3 fail_timeout=30s;
server unix:/tmp/backend2;
server backend3.example.com:1935 resolve;
server backup1.example.com:1935 backup;
}
По умолчанию соединения распределяются по серверам циклически (в режиме round-robin) с учетом весов серверов. В вышеприведенном примере каждые 7 соединений будут распределены так: 5 соединений на backend1.example.com:1935 и по одному соединению на второй и третий серверы. Распределение является равномерным: соединения к серверу с большим весом распределяются по всему циклу, а не отправляются подряд одной группой.
Если при попытке работы с сервером происходит ошибка, то соединение передается следующему серверу, и так далее до тех пор, пока не будут опробованы все работающие серверы. Если связь с серверами не удалась, соединение будет закрыто.
Примечание
По умолчанию сервер, у которого изредка происходят неудачные попытки, не достигающие порога max_fails, временно получает меньшую долю соединений и восстанавливает свою полную долю в течение последующих соединений. Это отличается от slow_start, который плавно возвращает сервер к работе только после того, как сервер был помечен недоступным и затем восстановился.
zone#
При сборке из исходного кода поддержку этой директивы
можно отключить с помощью параметра сборки
--without-stream_upstream_zone_module.
Задает имя и размер зоны разделяемой памяти, в которой хранятся конфигурация группы и ее рабочее состояние, разделяемые между рабочими процессами. В одной и той же зоне могут быть сразу несколько групп. В этом случае достаточно указать размер только один раз.
Примечание
Перезагрузка конфигурации создает зону заново независимо от того,
изменилось ли значение размер: счетчики, состояние пассивных
проверок и накопленная история балансировки начинаются с нуля. Адреса,
в которые разрешились серверы с параметром resolve, переносятся
в новую зону; в Angie PRO переносится и признак работоспособности,
на который опираются активные проверки с параметром persistent.
Примечание
Метрики группы собираются, только если настроена эта зона. Без нее группа не отображается в /status/stream/upstreams/<upstream>, в виджете «TCP/UDP-апстримы» и в выводе Prometheus, и предупреждение при этом не выводится.
Встроенные переменные#
Модуль хранит IP-адрес и порт или путь к UNIX-сокету сервера группы. Если при проксировании были сделаны обращения к нескольким серверам, то их адреса разделяются запятой, например: 192.168.1.1:1935, 192.168.1.2:1935, unix:/tmp/sock" Если сервер не может быть выбран, то переменная хранит имя группы серверов. число байт, полученных от сервера группы. Значения нескольких соединений разделяются запятыми и двоеточиями подобно адресам в переменной $upstream_addr. число байт, переданных на сервер группы. Значения нескольких соединений разделяются запятыми и двоеточиями подобно адресам в переменной $upstream_addr. хранит время, затраченное на установление соединения с сервером группы; время хранится в секундах с точностью до миллисекунд. Времена нескольких соединений разделяются запятыми и двоеточиями подобно адресам в переменной $upstream_addr. адрес проксируемого сервера, выбранного для текущей попытки соединения; в
отличие от $upstream_addr, где накапливается список адресов всех
серверов, к которым были обращения при повторных попытках, эта переменная всегда
содержит только один адрес и становится доступна сразу после выбора сервера, в
том числе во время вычисления переменных в директиве proxy_bind. время получения первого байта данных; время хранится в секундах с точностью до миллисекунд. Времена нескольких соединений разделяются запятыми подобно адресам в переменной $upstream_addr. длительность сессии в секундах с точностью до миллисекунд. Времена нескольких соединений разделяются запятыми подобно адресам в переменной $upstream_addr. Статус соединений в группах с sticky. Соединение направлено в группу серверов, где привязка не используется. Соединение не содержит информации о привязке к серверу. Соединение с привязкой направлено на желаемый сервер. Соединение с привязкой направлено на сервер,
выбранный по алгоритму балансировки. Статусы из нескольких соединений разделяются запятыми и двоеточиями
аналогично адресам в переменной $upstream_addr.stream_upstream поддерживает следующие встроенные переменные:$upstream_addr#$upstream_bytes_received#$upstream_bytes_sent#$upstream_connect_time#$upstream_current_addr (PRO)#$upstream_first_byte_time#$upstream_session_time#$upstream_sticky_status#""NEWHITMISS