Mercurial > hg > nginx-site
diff xml/ru/docs/http/ngx_http_upstream_hc_module.xml @ 1945:88477c5d2751
Moved "health_check" and "match" to ngx_http_upstream_hc_module.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Thu, 30 Mar 2017 21:26:44 +0300 |
parents | xml/ru/docs/http/ngx_http_upstream_module.xml@a58b35cc0823 |
children | 37df1535ea91 |
line wrap: on
line diff
copy from xml/ru/docs/http/ngx_http_upstream_module.xml copy to xml/ru/docs/http/ngx_http_upstream_hc_module.xml --- a/xml/ru/docs/http/ngx_http_upstream_module.xml +++ b/xml/ru/docs/http/ngx_http_upstream_hc_module.xml @@ -1,28 +1,30 @@ <?xml version="1.0"?> <!-- - Copyright (C) Igor Sysoev Copyright (C) Nginx, Inc. --> <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> -<module name="Модуль ngx_http_upstream_module" - link="/ru/docs/http/ngx_http_upstream_module.html" +<module name="Модуль ngx_http_upstream_hc_module" + link="/ru/docs/http/ngx_http_upstream_hc_module.html" lang="ru" - rev="59"> + rev="1"> <section id="summary"> <para> -Модуль <literal>ngx_http_upstream_module</literal> -позволяет описывать группы серверов, -которые могут использоваться в директивах -<link doc="ngx_http_proxy_module.xml" id="proxy_pass"/>, -<link doc="ngx_http_fastcgi_module.xml" id="fastcgi_pass"/>, -<link doc="ngx_http_uwsgi_module.xml" id="uwsgi_pass"/>, -<link doc="ngx_http_scgi_module.xml" id="scgi_pass"/> и -<link doc="ngx_http_memcached_module.xml" id="memcached_pass"/>. +Модуль <literal>ngx_http_upstream_hc_module</literal> +позволяет активировать периодические проверки работоспособности серверов в +<link doc="ngx_http_upstream_module.xml" id="upstream">группе</link>, +указанной в содержащем location. +</para> + +<para> +<note> +Модуль доступен как часть +<commercial_version>коммерческой подписки</commercial_version>. +</note> </para> </section> @@ -32,38 +34,12 @@ <para> <example> -upstream <emphasis>backend</emphasis> { - server backend1.example.com weight=5; - server backend2.example.com:8080; - server unix:/tmp/backend3; - - server backup1.example.com:8080 backup; - server backup2.example.com:8080 backup; -} - -server { - location / { - proxy_pass http://<emphasis>backend</emphasis>; - } -} -</example> -</para> - -<para> -Динамически настраиваемая группа, -доступна как часть -<commercial_version>коммерческой подписки</commercial_version>: -<example> -resolver 10.0.0.1; - -upstream <emphasis>dynamic</emphasis> { +upstream dynamic { zone upstream_dynamic 64k; server backend1.example.com weight=5; server backend2.example.com:8080 fail_timeout=5s slow_start=30s; server 192.0.2.1 max_fails=3; - server backend3.example.com resolve; - server backend4.example.com service=http resolve; server backup1.example.com:8080 backup; server backup2.example.com:8080 backup; @@ -71,7 +47,7 @@ upstream <emphasis>dynamic</emphasis> { server { location / { - proxy_pass http://<emphasis>dynamic</emphasis>; + proxy_pass http://dynamic; health_check; } } @@ -83,671 +59,6 @@ server { <section id="directives" name="Директивы"> -<directive name="upstream"> -<syntax block="yes"><value>название</value></syntax> -<default/> -<context>http</context> - -<para> -Описывает группу серверов. -Серверы могут слушать на разных портах. -Кроме того, можно одновременно использовать серверы, -слушающие на TCP- и UNIX-сокетах. -</para> - -<para> -Пример: -<example> -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; -} -</example> -</para> - -<para> -По умолчанию запросы распределяются по серверам циклически -(в режиме round-robin) с учётом весов серверов. -В вышеприведённом примере каждые 7 запросов будут распределены так: -5 запросов на <literal>backend1.example.com</literal> -и по одному запросу на второй и третий серверы. -Если при попытке работы с сервером происходит ошибка, то запрос -передаётся следующему серверу, и так далее до тех пор, пока не будут опробованы -все работающие серверы. -Если не удастся получить успешный ответ -ни от одного из серверов, то клиенту будет возвращён результат работы -с последним сервером. -</para> - -</directive> - - -<directive name="server"> -<syntax><value>адрес</value> [<value>параметры</value>]</syntax> -<default/> -<context>upstream</context> - -<para> -Задаёт <value>адрес</value> и другие <value>параметры</value> -сервера. -Адрес может быть указан в виде доменного имени или IP-адреса, -и необязательного порта, или в виде пути UNIX-сокета, который -указывается после префикса “<literal>unix:</literal>”. -Если порт не указан, используется порт 80. -Доменное имя, которому соответствует несколько IP-адресов, -задаёт сразу несколько серверов. -</para> - -<para> -Могут быть заданы следующие параметры: -<list type="tag"> - -<tag-name id="weight"> -<literal>weight</literal>=<value>число</value> -</tag-name> -<tag-desc> -задаёт вес сервера, по умолчанию 1. -</tag-desc> - -<tag-name id="max_conns"> -<literal>max_conns</literal>=<value>число</value> -</tag-name> -<tag-desc> -ограничивает максимальное <value>число</value> одновременных активных -соединений к проксируемому серверу (1.11.5). -Значение по умолчанию равно 0 и означает, что ограничения нет. -Если группа не находится в <link id="zone">зоне разделяемой памяти</link>, -то ограничение работает отдельно для каждого рабочего процесса. -<note> -При включённых <link id="keepalive">неактивных постоянных</link> соединениях, -нескольких -<link doc="../ngx_core_module.xml" id="worker_processes">рабочих процессах</link> -и <link id="zone">зоне разделяемой памяти</link>, -суммарное число активных и неактивных соединений с проксируемым сервером -может превышать значение <literal>max_conns</literal>. -</note> -<note> -Начиная с версии 1.5.9 и до версии 1.11.5 -этот параметр был доступен как часть -<commercial_version>коммерческой подписки</commercial_version>. -</note> -</tag-desc> - -<tag-name id="max_fails"> -<literal>max_fails</literal>=<value>число</value> -</tag-name> -<tag-desc> -задаёт число неудачных попыток работы с сервером, которые должны произойти -в течение времени, заданного параметром <literal>fail_timeout</literal>, -чтобы сервер считался недоступным на период времени, также заданный -параметром <literal>fail_timeout</literal>. -По умолчанию число попыток устанавливается равным 1. -Нулевое значение отключает учёт попыток. -Что считается неудачной попыткой, определяется директивами -<link doc="ngx_http_proxy_module.xml" id="proxy_next_upstream"/>, -<link doc="ngx_http_fastcgi_module.xml" id="fastcgi_next_upstream"/>, -<link doc="ngx_http_uwsgi_module.xml" id="uwsgi_next_upstream"/>, -<link doc="ngx_http_scgi_module.xml" id="scgi_next_upstream"/> и -<link doc="ngx_http_memcached_module.xml" id="memcached_next_upstream"/>. -</tag-desc> - -<tag-name id="fail_timeout"> -<literal>fail_timeout</literal>=<value>время</value> -</tag-name> -<tag-desc> -задаёт -<list type="bullet"> - -<listitem> -время, в течение которого должно произойти заданное число неудачных -попыток работы с сервером для того, чтобы сервер считался недоступным; -</listitem> - -<listitem> -и время, в течение которого сервер будет считаться недоступным. -</listitem> - -</list> -По умолчанию параметр равен 10 секундам. -</tag-desc> - -<tag-name id="backup"> -<literal>backup</literal> -</tag-name> -<tag-desc> -помечает сервер как запасной сервер. -На него будут передаваться запросы в случае, если не работают основные серверы. -</tag-desc> - -<tag-name id="down"> -<literal>down</literal> -</tag-name> -<tag-desc> -помечает сервер как постоянно недоступный. -</tag-desc> - -</list> -</para> - -<para> -Кроме того, -следующие параметры доступны как часть -<commercial_version>коммерческой подписки</commercial_version>: -<list type="tag"> - -<tag-name id="resolve"> -<literal>resolve</literal> -</tag-name> -<tag-desc> -отслеживает изменения IP-адресов, соответствующих доменному имени сервера, -и автоматически изменяет конфигурацию группы -без необходимости перезапуска nginx (1.5.12). -Группа должна находиться в <link id="zone">зоне разделяемой памяти</link>. -<para> -Для работы этого параметра -директива <link doc="ngx_http_core_module.xml" id="resolver"/> -должна быть задана в блоке -<link doc="ngx_http_core_module.xml" id="http"/>. -Пример: -<example> -http { - resolver 10.0.0.1; - - upstream u { - zone ...; - ... - server example.com resolve; - } -} -</example> -</para> -</tag-desc> - -<tag-name id="route"> -<literal>route</literal>=<value>строка</value> -</tag-name> -<tag-desc> -задаёт имя маршрута к серверу. -</tag-desc> - -<tag-name id="service"> -<literal>service</literal>=<value>имя</value> -</tag-name> -<tag-desc> -включает преобразование -<link url="https://tools.ietf.org/html/rfc2782">SRV</link>-записей -DNS и задаёт <value>имя</value> сервиса (1.9.13). -Для работы параметра необходимо указать -параметр <link id="resolve"/> для сервера -и не указывать порт сервера. -<para> -Если имя сервиса не содержит точку (“<literal>.</literal>”), то -имя составляется в соответствии с -<link url="https://tools.ietf.org/html/rfc2782">RFC</link> -и в префикс службы добавляется протокол TCP. -Например, для получения -SRV-записи <literal>_http._tcp.backend.example.com</literal> -необходимо указать директиву: -<example> -server backend.example.com service=http resolve; -</example> -Если имя сервиса содержит одну и более точек, то имя составляется -при помощи соединения префикса службы и имени сервера. -Например, для получения SRV-записей -<literal>_http._tcp.backend.example.com</literal> -и <literal>server1.backend.example.com</literal> -необходимо указать директивы: -<example> -server backend.example.com service=_http._tcp resolve; -server example.com service=server1.backend resolve; -</example> -</para> - -<para> -SRV-записи с наивысшим приоритетом -(записи с одинаковым наименьшим значением приоритета) -преобразуются в основные серверы, -остальные SRV-записи преобразуются в запасные серверы. -Если в конфигурации сервера указан параметр <link id="backup"/>, -высокоприоритетные SRV-записи преобразуются в запасные серверы, -остальные SRV-записи игнорируются. -</para> -</tag-desc> - -<tag-name id="slow_start"> -<literal>slow_start</literal>=<value>время</value> -</tag-name> -<tag-desc> -задаёт <value>время</value>, в течение которого вес сервера -восстановится от нуля до своего номинального значения в ситуации, когда -неработоспособный (unhealthy) сервер вновь становится работоспособным -(<link id="health_check">healthy</link>) -или когда сервер становится доступным по прошествии времени, -в течение которого он считался <link id="fail_timeout">недоступным</link>. -Значение по умолчанию равно нулю и означает, что медленный старт выключен. -<note> -Параметр нельзя использовать совместно с -методами балансировки нагрузки <link id="hash"/> и <link id="ip_hash"/>. -</note> -</tag-desc> - -</list> -</para> - -<para> -<note> -Если в группе только один сервер, параметры <literal>max_fails</literal>, -<literal>fail_timeout</literal> и <literal>slow_start</literal> -игнорируются и такой сервер никогда не будет считаться недоступным. -</note> -</para> - -</directive> - - -<directive name="zone"> -<syntax><value>имя</value> [<value>размер</value>]</syntax> -<default/> -<context>upstream</context> -<appeared-in>1.9.0</appeared-in> - -<para> -Задаёт <value>имя</value> и <value>размер</value> зоны разделяемой памяти, -в которой хранятся конфигурация группы и её рабочее состояние, -разделяемые между рабочими процессами. -В одной и той же зоне могут быть сразу несколько групп. -В этом случае достаточно указать <value>размер</value> только один раз. -</para> - -<para> -Дополнительно, как часть -<commercial_version>коммерческой подписки</commercial_version>, -в таких группах для изменения состава группы -или настроек отдельных серверов -нет необходимости перезапускать nginx. -Конфигурация доступна через специальный location, -в котором указана директива -<link doc="ngx_http_upstream_conf_module.xml" id="upstream_conf"/>. -</para> - -</directive> - - -<directive name="state"> -<syntax><value>файл</value></syntax> -<default/> -<context>upstream</context> -<appeared-in>1.9.7</appeared-in> - -<para> -Задаёт <value>файл</value>, в котором хранится состояние -динамически настраиваемой группы. -</para> - -<para> -Примеры: -<example> -state /var/lib/nginx/state/servers.conf; # путь для Linux -state /var/db/nginx/state/servers.conf; # путь для FreeBSD -</example> -</para> - -<para> -В данный момент состояние ограничено списком серверов с их параметрами. -Файл читается при парсинге конфигурации и обновляется каждый раз при -<link doc="ngx_http_upstream_conf_module.xml" id="upstream_conf">изменении</link> -конфигурации группы. -Изменение содержимого файла напрямую не рекомендуется. -Директиву нельзя использовать -совместно с директивой <link id="server"/>. -</para> - -<para> -<note> -Изменения, совершённые в момент -<link doc="../control.xml" id="reconfiguration">перезагрузки конфигурации</link> -или <link doc="../control.xml" id="upgrade">обновления бинарного файла</link>, -могут быть потеряны. -</note> -</para> - -<para> -<note> -Эта директива доступна как часть -<commercial_version>коммерческой подписки</commercial_version>. -</note> -</para> - -</directive> - - -<directive name="hash"> -<syntax><value>ключ</value> [<literal>consistent</literal>]</syntax> -<default/> -<context>upstream</context> -<appeared-in>1.7.2</appeared-in> - -<para> -Задаёт метод балансировки нагрузки для группы, при котором -соответствие клиента серверу определяется при помощи -хэшированного значения <value>ключа</value>. -В качестве <value>ключа</value> может использоваться -текст, переменные и их комбинации. -Следует отметить, что любое добавление или удаление серверов в группе -может привести к перераспределению большинства ключей на другие серверы. -Метод совместим с библиотекой Perl -<link url="http://search.cpan.org/perldoc?Cache%3A%3AMemcached">Cache::Memcached</link>. -</para> - -<para> -Если задан параметр <literal>consistent</literal>, то вместо -вышеописанного метода будет использоваться метод консистентного хэширования -<link url="http://www.last.fm/user/RJ/journal/2007/04/10/392555/">ketama</link>. -Метод гарантирует, что при добавлении сервера в группу или его удалении -на другие серверы будет перераспределено минимальное число ключей. -Применение метода для кэширующих серверов обеспечивает -больший процент попаданий в кэш. -Метод совместим с библиотекой Perl -<link url="http://search.cpan.org/perldoc?Cache%3A%3AMemcached%3A%3AFast">Cache::Memcached::Fast</link> -при значении параметра <value>ketama_points</value> равным 160. -</para> - -</directive> - - -<directive name="ip_hash"> -<syntax/> -<default/> -<context>upstream</context> - -<para> -Задаёт для группы метод балансировки нагрузки, при котором запросы -распределяются по серверам на основе IP-адресов клиентов. -В качестве ключа для хэширования используются первые три -октета IPv4-адреса клиента или IPv6-адрес клиента целиком. -Метод гарантирует, что запросы одного и того же клиента -будут всегда передаваться на один и тот же сервер. -Если же этот сервер будет считаться недоступным, -то запросы этого клиента будут передаваться на другой сервер. -С большой долей вероятности это также будет один и тот же сервер. -<note> -IPv6-адреса поддерживаются начиная с версий 1.3.2 и 1.2.2. -</note> -</para> - -<para> -Если один из серверов нужно убрать на некоторое время, то для сохранения -текущего хэширования IP-адресов клиентов этот сервер нужно пометить -параметром <literal>down</literal>. -</para> - -<para> -Пример: -<example> -upstream backend { - ip_hash; - - server backend1.example.com; - server backend2.example.com; - server backend3.example.com <emphasis>down</emphasis>; - server backend4.example.com; -} -</example> -</para> - -<para> -<note> -До версий 1.3.1 и 1.2.2 для серверов, использующих метод балансировки нагрузки -<literal>ip_hash</literal>, нельзя было задать вес. -</note> -</para> - -</directive> - - -<directive name="keepalive"> -<syntax><value>соединения</value></syntax> -<default/> -<context>upstream</context> -<appeared-in>1.1.4</appeared-in> - -<para> -Задействует кэш соединений для группы серверов. -</para> - -<para> -Параметр <value>соединения</value> устанавливает максимальное число -неактивных постоянных соединений с серверами группы, которые будут -сохраняться в кэше каждого рабочего процесса. -При превышении этого числа наиболее давно не используемые соединения -закрываются. -<note> -Следует особо отметить, что директива <literal>keepalive</literal> -не ограничивает общее число соединений с серверами группы, которые -рабочие процессы nginx могут открыть. -Параметр <value>соединения</value> следует устанавливать достаточно -консервативно, чтобы серверы группы по-прежнему могли обрабатывать -новые входящие соединения. -</note> -</para> - -<para> -Пример конфигурации группы серверов memcached с постоянными соединениями: -<example> -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; - } - -} -</example> -</para> - -<para> -Для HTTP директиву -<link doc="ngx_http_proxy_module.xml" id="proxy_http_version"/> -следует установить в “<literal>1.1</literal>”, -а поле заголовка <header>Connection</header> — очистить: -<example> -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 ""; - ... - } -} -</example> -</para> - -<para> -<note> -Хоть это и не рекомендуется, но также возможно использование постоянных -соединений с HTTP/1.0, путём передачи поля заголовка -<header>Connection: Keep-Alive</header> серверу группы. -</note> -</para> - -<para> -Для работы постоянных соединений с FastCGI-серверами потребуется -включить директиву -<link doc="ngx_http_fastcgi_module.xml" id="fastcgi_keep_conn"/>: -<example> -upstream fastcgi_backend { - server 127.0.0.1:9000; - - keepalive 8; -} - -server { - ... - - location /fastcgi/ { - fastcgi_pass fastcgi_backend; - fastcgi_keep_conn on; - ... - } -} -</example> -</para> - -<para> -<note> -При использовании методов балансировки нагрузки, отличных -от стандартного round-robin, следует активировать их до -директивы <literal>keepalive</literal>. -</note> - -<note> -Протоколы SCGI и uwsgi не определяют семантику постоянных соединений. -</note> -</para> - -</directive> - - -<directive name="ntlm"> -<syntax/> -<default/> -<context>upstream</context> -<appeared-in>1.9.2</appeared-in> - -<para> -Позволяет проксировать запросы с -<link url="https://en.wikipedia.org/wiki/Integrated_Windows_Authentication">проверкой -подлинности NTLM</link>. -Соединение с сервером группы привязывается к клиентскому соединению -как только клиент отправляет запрос, в заголовке которого есть поле -<header>Authorization</header> со значением, -начинающимся с “<literal>Negotiate</literal>” или “<literal>NTLM</literal>”. -Последующие запросы клиента будут проксироваться через это же соединение -с сервером группы, -сохраняя контекст аутентификации. -</para> - -<para> -Для работы проверки подлинности NTLM -необходимо разрешить постоянные соединения с серверами группы. -Директиву <link doc="ngx_http_proxy_module.xml" id="proxy_http_version"/> -следует установить в “<literal>1.1</literal>”, -а поле заголовка <header>Connection</header> — очистить: -<example> -upstream http_backend { - server 127.0.0.1:8080; - - ntlm; -} - -server { - ... - - location /http/ { - proxy_pass http://http_backend; - proxy_http_version 1.1; - proxy_set_header Connection ""; - ... - } -} -</example> -</para> - -<para> -<note> -При использовании методов балансировки нагрузки, отличных -от стандартного round-robin, следует активировать их до -директивы <literal>ntlm</literal>. -</note> -</para> - -<para> -<note> -Эта директива доступна как часть -<commercial_version>коммерческой подписки</commercial_version>. -</note> -</para> - -</directive> - - -<directive name="least_conn"> -<syntax/> -<default/> -<context>upstream</context> -<appeared-in>1.3.1</appeared-in> -<appeared-in>1.2.2</appeared-in> - -<para> -Задаёт для группы метод балансировки нагрузки, при котором запрос -передаётся серверу с наименьшим числом активных соединений, -с учётом весов серверов. -Если подходит сразу несколько серверов, они выбираются циклически -(в режиме round-robin) с учётом их весов. -</para> - -</directive> - - -<directive name="least_time"> -<syntax> - <literal>header</literal> | - <literal>last_byte</literal> - [<literal>inflight</literal>]</syntax> -<default/> -<context>upstream</context> -<appeared-in>1.7.10</appeared-in> - -<para> -Задаёт для группы метод балансировки нагрузки, при котором запрос -передаётся серверу с наименьшими средним временем ответа и -числом активных соединений с учётом весов серверов. -Если подходит сразу несколько серверов, то они выбираются циклически -(в режиме round-robin) с учётом их весов. -</para> - -<para> -Если указан параметр <literal>header</literal>, -то учитывается время получения -<link id="var_upstream_header_time">заголовка ответа</link>. -Если указан параметр <literal>last_byte</literal>, то учитывается -время получения <link id="var_upstream_response_time">всего ответа</link>. -Если указан параметр <literal>inflight</literal> (1.11.6), -то также учитываются незавершённые запросы. -<note> -До версии 1.11.6 незавершённые запросы учитывались по умолчанию. -</note> -</para> - -<para> -<note> -Эта директива доступна как часть -<commercial_version>коммерческой подписки</commercial_version>. -</note> -</para> - -</directive> - - <directive name="health_check"> <syntax>[<value>параметры</value>]</syntax> <default/> @@ -755,7 +66,8 @@ server { <para> Активирует периодические проверки работоспособности серверов в -<link id="upstream">группе</link>, указанной в содержащем location. +<link doc="ngx_http_upstream_module.xml" id="upstream">группе</link>, +указанной в содержащем location. </para> <para> @@ -830,7 +142,8 @@ server { <tag-desc> задаёт порт, используемый при подключении к серверу для проверки его работоспособности (1.9.7). -По умолчанию совпадает с портом <link id="server">сервера</link>. +По умолчанию совпадает с портом +<link doc="ngx_http_upstream_module.xml" id="server">сервера</link>. </tag-desc> </list> @@ -884,7 +197,8 @@ http { </para> <para> -Группа должна находиться в <link id="zone">зоне разделяемой памяти</link>. +Группа должна находиться в +<link doc="ngx_http_upstream_module.xml" id="zone">зоне разделяемой памяти</link>. </para> <para> @@ -900,13 +214,6 @@ http { </note> </para> -<para> -<note> -Эта директива доступна как часть -<commercial_version>коммерческой подписки</commercial_version>. -</note> -</para> - </directive> @@ -1036,390 +343,8 @@ match server_ok { </para> -<para> -<note> -Эта директива доступна как часть -<commercial_version>коммерческой подписки</commercial_version>. -</note> -</para> - -</directive> - - -<directive name="queue"> -<syntax> -<value>число</value> -[<literal>timeout</literal>=<value>время</value>]</syntax> -<default/> -<context>upstream</context> -<appeared-in>1.5.12</appeared-in> - -<para> -Если при обработке запроса невозможно сразу выбрать сервер группы, то -запрос будет помещён в очередь. -Директива задаёт максимальное число запросов, которые могут одновременно -находиться в очереди. -Если очередь переполнена -или за время, задаваемое параметром <literal>timeout</literal>, -так и не удастся выбрать сервер для передачи ему запроса, -клиенту будет возвращена ошибка -<http-status code="502" text="Bad Gateway"/>. -</para> - -<para> -По умолчанию параметр <literal>timeout</literal> равен 60 секундам. -</para> - -<para> -<note> -При использовании методов балансировки нагрузки, отличных -от стандартного round-robin, следует активировать их до -директивы <literal>queue</literal>. -</note> - -<note> -Эта директива доступна как часть -<commercial_version>коммерческой подписки</commercial_version>. -</note> -</para> - -</directive> - - -<directive name="sticky"> -<syntax> - <literal>cookie</literal> <value>имя</value> - [<literal>expires=</literal><value>время</value>] - [<literal>domain=</literal><value>домен</value>] - [<literal>httponly</literal>] - [<literal>secure</literal>] - [<literal>path=</literal><value>путь</value>]</syntax> -<syntax> - <literal>route</literal> <value>переменная</value> ...</syntax> -<syntax> - <literal>learn</literal> - <literal>create=</literal><value>$переменная</value> - <literal>lookup=</literal><value>$переменная</value> - <literal>zone=</literal><value>имя</value>:<value>размер</value> - [<literal>timeout=</literal><value>время</value>]</syntax> -<default/> -<context>upstream</context> -<appeared-in>1.5.7</appeared-in> - -<para> -Включает режим привязки сеансов, в котором запросы клиента -будут передаваться на один и тот же сервер группы. -Доступны три метода: -<list type="tag"> -<tag-name id="sticky_cookie"><literal>cookie</literal></tag-name> -<tag-desc> - -<para> -При использовании метода <literal>cookie</literal> информация о -назначенном сервере передаётся в HTTP-куке: -<example> -upstream backend { - server backend1.example.com; - server backend2.example.com; - - sticky cookie srv_id expires=1h domain=.example.com path=/; -} -</example> -</para> - -<para> -Запрос от клиента, ещё не привязанного к определённому серверу, -передаётся на сервер, выбранный согласно настроенному методу балансировки. -Дальнейшие запросы от этого клиента передаются на тот же сервер. -Если назначенный сервер не может обработать запрос, выбирается новый -сервер как если бы клиент не имел привязки к серверу. -</para> - -<para> -Первый параметр задаёт имя куки, которую необходимо установить или проверить. -Дополнительные параметры могут быть следующими: -<list type="tag"> - -<tag-name><literal>expires=</literal><value>время</value></tag-name> -<tag-desc> -Задаёт <value>время</value>, в течение которого браузеру необходимо хранить куку. -Специальное значение <literal>max</literal> устанавливает срок хранения куки до -31 декабря 2037 года 23:55:55 GMT. -Если параметр не указан, то время действия куки ограничивается сессией браузера. -</tag-desc> - -<tag-name><literal>domain=</literal><value>домен</value></tag-name> -<tag-desc> -Задаёт <value>домен</value>, для которого устанавливается кука. -В значении параметра можно использовать переменные (1.11.5). -</tag-desc> - -<tag-name><literal>httponly</literal></tag-name> -<tag-desc> -Добавляет атрибут <literal>HttpOnly</literal> к куке (1.7.11). -</tag-desc> - -<tag-name><literal>secure</literal></tag-name> -<tag-desc> -Добавляет атрибут <literal>Secure</literal> к куке (1.7.11). -</tag-desc> - -<tag-name><literal>path=</literal><value>путь</value></tag-name> -<tag-desc> -Задаёт <value>путь</value>, для которого устанавливается кука. -</tag-desc> - -</list> -Если пропущен тот или иной параметр, то соответствующего поля в куке не будет. -</para> -</tag-desc> - -<tag-name id="sticky_route"><literal>route</literal></tag-name> -<tag-desc> - -<para> -При использовании метода <literal>route</literal> проксируемый сервер назначает -клиенту маршрут по получении первого запроса. -Все последующие запросы от этого клиента будут содержать информацию о -маршруте в куке или URI. -Эта информация сравнивается с параметром “<literal>route</literal>” директивы -<link id="server"/> для идентификации сервера, на который -следует проксировать запрос. -Если параметр “<literal>route</literal>” не задан, то именем маршрута -будет являться MD5-хэш IP-адреса и порта -(или пути UNIX-сокета) в шестнадцатеричном виде. -Если назначенный сервер не может обработать запрос, выбирается новый сервер -согласно настроенному методу балансировки как если бы в запросе не было -информации о маршруте. -</para> - -<para> -Параметры метода <literal>route</literal> задают переменные, которые -могут содержать информацию о маршруте. -Первая непустая переменная используется для поиска соответствующего сервера. -</para> - -<para> -Пример: -<example> -map $cookie_jsessionid $route_cookie { - ~.+\.(?P<route>\w+)$ $route; -} - -map $request_uri $route_uri { - ~jsessionid=.+\.(?P<route>\w+)$ $route; -} - -upstream backend { - server backend1.example.com route=a; - server backend2.example.com route=b; - - sticky route $route_cookie $route_uri; -} -</example> -В этом примере маршрут берётся из куки “<literal>JSESSIONID</literal>”, -если она присутствует в запросе. -В противном случае используется маршрут из URI. -</para> - -</tag-desc> - -<tag-name id="sticky_learn"><literal>learn</literal></tag-name> -<tag-desc> -<para> -При использовании метода <literal>learn</literal> (1.7.1) nginx -анализирует ответы от вышестоящего сервера и запоминает -начатые им сессии, которые обычно передаются в HTTP-куке. -<example> -upstream backend { - server backend1.example.com:8080; - server backend2.example.com:8081; - - sticky learn - create=$upstream_cookie_examplecookie - lookup=$cookie_examplecookie - zone=client_sessions:1m; -} -</example> - -В примере выше сервер группы создаёт сессию путём установки -куки “<literal>EXAMPLECOOKIE</literal>” в своём ответе. -Последующие запросы с этой кукой будут передаваться на этот же сервер. -Если сервер не может обработать запрос, выбирается новый -сервер как если бы клиент не имел привязки к серверу. -</para> - -<para> -Параметры <literal>create</literal> и <literal>lookup</literal> -задают переменные, в которых соответственно указывается способ -создания новых и поиска существующих сессий. -Оба параметра могут быть указаны больше одного раза -(в этом случае используется первая непустая переменная). -</para> - -<para> -Сессии хранятся в зоне разделяемой памяти, <value>имя</value> и -<value>размер</value> которой задаются параметром <literal>zone</literal>. -Зоны размером в 1 мегабайт достаточно для хранения около 8 тысяч сессий -на 64-битной платформе. -Сессии, к которым не было обращений в течение времени, заданного параметром -<literal>timeout</literal>, удаляются из зоны. -По умолчанию <literal>timeout</literal> равен 10 минутам. -</para> - -</tag-desc> -</list> -</para> - -<para> -<note> -Эта директива доступна как часть -<commercial_version>коммерческой подписки</commercial_version>. -</note> -</para> - -</directive> - - -<directive name="sticky_cookie_insert"> -<syntax><value>имя</value> -[<literal>expires=</literal><value>время</value>] -[<literal>domain=</literal><value>домен</value>] -[<literal>path=</literal><value>путь</value>]</syntax> -<default/> -<context>upstream</context> - -<para> -Эта директива устарела начиная с версии 1.5.7. -Вместо неё следует использовать аналогичную директиву -<link id="sticky"/> с изменённым синтаксисом: -<note> -<literal>sticky cookie</literal> <value>имя</value> -[<literal>expires=</literal><value>время</value>] -[<literal>domain=</literal><value>домен</value>] -[<literal>path=</literal><value>путь</value>]; -</note> -</para> - </directive> </section> - -<section id="variables" name="Встроенные переменные"> - -<para> -Модуль <literal>ngx_http_upstream_module</literal> -поддерживает следующие встроенные переменные: -<list type="tag"> - -<tag-name id="var_upstream_addr"><var>$upstream_addr</var></tag-name> -<tag-desc> -хранит IP-адрес и порт или путь к UNIX-сокету сервера группы. -Если при обработке запроса были сделаны обращения к нескольким серверам, -то их адреса разделяются запятой, например, -“<literal>192.168.1.1:80, 192.168.1.2:80, unix:/tmp/sock</literal>”. -Если произошло внутреннее перенаправление от одной группы серверов на другую -с помощью -<header>X-Accel-Redirect</header> или -<link doc="ngx_http_core_module.xml" id="error_page"/>, -то адреса, соответствующие разным группам серверов, разделяются двоеточием, -например, -“<literal>192.168.1.1:80, 192.168.1.2:80, unix:/tmp/sock : 192.168.10.1:80, 192.168.10.2:80</literal>”. -</tag-desc> - -<tag-name id="var_upstream_bytes_received"><var>$upstream_bytes_received</var></tag-name> -<tag-desc> -число байт, полученных от сервера группы (1.11.4). -Значения нескольких соединений -разделяются запятыми и двоеточиями подобно адресам в переменной -<link id="var_upstream_addr">$upstream_addr</link>. -</tag-desc> - -<tag-name id="var_upstream_cache_status"><var>$upstream_cache_status</var> -</tag-name> -<tag-desc> -хранит статус доступа к кэшу ответов (0.8.3). -Статус может быть одним из “<literal>MISS</literal>”, -“<literal>BYPASS</literal>”, “<literal>EXPIRED</literal>”, -“<literal>STALE</literal>”, “<literal>UPDATING</literal>”, -“<literal>REVALIDATED</literal>” или “<literal>HIT</literal>”. -</tag-desc> - -<tag-name id="var_upstream_connect_time"><var>$upstream_connect_time</var> -</tag-name> -<tag-desc> -хранит время, затраченное на установление соединения с сервером группы (1.9.1); -время хранится в секундах с точностью до миллисекунд. -В случае SSL, включает в себя время, потраченное на handshake. -Времена нескольких соединений -разделяются запятыми и двоеточиями подобно адресам в переменной -<link id="var_upstream_addr">$upstream_addr</link>. -</tag-desc> - -<tag-name id="var_upstream_cookie_"><var>$upstream_cookie_</var><value>имя</value> -</tag-name> -<tag-desc> -кука с указанным <value>именем</value>, переданная сервером группы -в поле <header>Set-Cookie</header> заголовка ответа (1.7.1). -Необходимо иметь в виду, что куки запоминаются только из ответа -последнего сервера. -</tag-desc> - -<tag-name id="var_upstream_header_time"><var>$upstream_header_time</var> -</tag-name> -<tag-desc> -хранит время, -затраченное на получение заголовка ответа от сервера группы (1.7.10); -время хранится в секундах с точностью до миллисекунд. -Времена нескольких ответов -разделяются запятыми и двоеточиями подобно адресам в переменной -<link id="var_upstream_addr">$upstream_addr</link>. -</tag-desc> - -<tag-name id="var_upstream_http_"><var>$upstream_http_</var><value>имя</value></tag-name> -<tag-desc> -хранят поля заголовка ответа сервера. -Например, поле заголовка ответа <header>Server</header> -доступно в переменной <var>$upstream_http_server</var>. -Правила преобразования имён полей заголовка ответа в имена переменных -такие же, как для переменных с префиксом -“<link doc="ngx_http_core_module.xml" id="var_http_">$http_</link>”. -Необходимо иметь в виду, что поля заголовка запоминаются только из ответа -последнего сервера. -</tag-desc> - -<tag-name id="var_upstream_response_length"><var>$upstream_response_length</var> -</tag-name> -<tag-desc> -хранит длину ответа, полученного от сервера группы (0.7.27); -длина хранится в байтах. -Длины нескольких ответов -разделяются запятыми и двоеточиями подобно адресам в переменной -<link id="var_upstream_addr">$upstream_addr</link>. -</tag-desc> - -<tag-name id="var_upstream_response_time"><var>$upstream_response_time</var> -</tag-name> -<tag-desc> -хранит время, затраченное на получение ответа от сервера группы; -время хранится в секундах с точностью до миллисекунд. -Времена нескольких ответов -разделяются запятыми и двоеточиями подобно адресам в переменной -<link id="var_upstream_addr">$upstream_addr</link>. -</tag-desc> - -<tag-name id="var_upstream_status"><var>$upstream_status</var></tag-name> -<tag-desc> -хранит статус ответа, полученного от сервера группы. -Статусы нескольких ответов -разделяются запятыми и двоеточиями подобно адресам в переменной -<link id="var_upstream_addr">$upstream_addr</link>. -</tag-desc> - -</list> -</para> - -</section> - </module>