Mercurial > hg > nginx-site
changeset 1925:a58b35cc0823
Updated docs for the upcoming NGINX Plus release.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Wed, 08 Mar 2017 18:05:46 +0300 |
parents | 237a10fb98d2 |
children | 88228d493640 |
files | xml/en/docs/http/ngx_http_auth_jwt_module.xml xml/en/docs/http/ngx_http_status_module.xml xml/en/docs/http/ngx_http_upstream_module.xml xml/en/docs/stream/ngx_stream_upstream_module.xml xml/ru/docs/http/ngx_http_auth_jwt_module.xml xml/ru/docs/http/ngx_http_status_module.xml xml/ru/docs/http/ngx_http_upstream_module.xml xml/ru/docs/stream/ngx_stream_upstream_module.xml |
diffstat | 8 files changed, 515 insertions(+), 192 deletions(-) [+] |
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_auth_jwt_module.xml Mon Mar 06 17:01:22 2017 +0300 +++ b/xml/en/docs/http/ngx_http_auth_jwt_module.xml Wed Mar 08 18:05:46 2017 +0300 @@ -9,7 +9,7 @@ <module name="Module ngx_http_auth_jwt_module" link="/en/docs/http/ngx_http_auth_jwt_module.html" lang="en" - rev="2"> + rev="3"> <section id="summary"> @@ -99,6 +99,34 @@ </directive> +<directive name="auth_jwt_header_set"> +<syntax><value>$variable</value> <value>name</value></syntax> +<default/> +<context>http</context> +<appeared-in>1.11.10</appeared-in> + +<para> +Sets the <value>variable</value> to the given +JOSE header parameter <value>name</value>. +</para> + +</directive> + + +<directive name="auth_jwt_claim_set"> +<syntax><value>$variable</value> <value>name</value></syntax> +<default/> +<context>http</context> +<appeared-in>1.11.10</appeared-in> + +<para> +Sets the <value>variable</value> to the given +JWT claim parameter <value>name</value>. +</para> + +</directive> + + <directive name="auth_jwt_key_file"> <syntax><value>file</value></syntax> <default/> @@ -122,84 +150,21 @@ <para> The <literal>ngx_http_auth_jwt_module</literal> module -supports embedded variables. +supports embedded variables: </para> <para> -Variables that return -<link url="https://tools.ietf.org/html/rfc7519#section-4">JWT claims</link>: - <list type="tag" compact="yes"> -<tag-name id="var_jwt_claim_aud"><var>$jwt_claim_aud</var></tag-name> -<tag-desc> -audience -</tag-desc> - -<tag-name id="var_jwt_claim_email"><var>$jwt_claim_email</var></tag-name> -<tag-desc> -email -</tag-desc> - -<tag-name id="var_jwt_claim_exp"><var>$jwt_claim_exp</var></tag-name> +<tag-name id="var_jwt_header_"><var>$jwt_header_</var><value>name</value></tag-name> <tag-desc> -expiration time -</tag-desc> - -<tag-name id="var_jwt_claim_iat"><var>$jwt_claim_iat</var></tag-name> -<tag-desc> -issued at -</tag-desc> - -<tag-name id="var_jwt_claim_iss"><var>$jwt_claim_iss</var></tag-name> -<tag-desc> -issuer -</tag-desc> - -<tag-name id="var_jwt_claim_jti"><var>$jwt_claim_jti</var></tag-name> -<tag-desc> -JWT ID +returns the value of a specified +<link url="https://tools.ietf.org/html/rfc7515#section-4">JOSE header</link> </tag-desc> -<tag-name id="var_jwt_claim_nbf"><var>$jwt_claim_nbf</var></tag-name> -<tag-desc> -not-before -</tag-desc> - -<tag-name id="var_jwt_claim_sub"><var>$jwt_claim_sub</var></tag-name> -<tag-desc> -subject -</tag-desc> -</list> -</para> - -<para> -Variables that return parameters of -<link url="https://tools.ietf.org/html/rfc7515#section-4">JOSE header</link>: - -<list type="tag" compact="yes"> -<tag-name id="var_jwt_header_alg"><var>$jwt_header_alg</var></tag-name> +<tag-name id="var_jwt_claim_"><var>$jwt_claim_</var><value>name</value></tag-name> <tag-desc> -algorithm -</tag-desc> - -<tag-name id="var_jwt_header_cty"><var>$jwt_header_cty</var></tag-name> -<tag-desc> -content type -</tag-desc> - -<tag-name id="var_jwt_header_enc"><var>$jwt_header_enc</var></tag-name> -<tag-desc> -encryption algorithm -</tag-desc> - -<tag-name id="var_jwt_header_kid"><var>$jwt_header_kid</var></tag-name> -<tag-desc> -key ID -</tag-desc> - -<tag-name id="var_jwt_header_typ"><var>$jwt_header_typ</var></tag-name> -<tag-desc> -type +returns the value of a specified +<link url="https://tools.ietf.org/html/rfc7519#section-4">JWT claim</link> </tag-desc> </list>
--- a/xml/en/docs/http/ngx_http_status_module.xml Mon Mar 06 17:01:22 2017 +0300 +++ b/xml/en/docs/http/ngx_http_status_module.xml Wed Mar 08 18:05:46 2017 +0300 @@ -9,7 +9,7 @@ <module name="Module ngx_http_status_module" link="/en/docs/http/ngx_http_status_module.html" lang="en" - rev="12"> + rev="13"> <section id="summary"> @@ -184,7 +184,7 @@ <tag-name id="version"><literal>version</literal></tag-name> <tag-desc> Version of the provided data set. -The current version is 7. +The current version is 8. </tag-desc> <tag-name><literal>nginx_version</literal></tag-name> @@ -192,6 +192,11 @@ Version of nginx. </tag-desc> +<tag-name id="nginx_build"><literal>nginx_build</literal></tag-name> +<tag-desc> +Name of nginx build. +</tag-desc> + <tag-name><literal>address</literal></tag-name> <tag-desc> The address of the server that accepted status request. @@ -218,6 +223,12 @@ The ID of the worker process that handled status request. </tag-desc> +<tag-name id="ppid"><literal>ppid</literal></tag-name> +<tag-desc> +The ID of the master process that started +the <link id="pid">worker process</link>. +</tag-desc> + <tag-name id="processes"><literal>processes</literal></tag-name> <tag-desc> <list type="tag"> @@ -356,6 +367,60 @@ </list> </tag-desc> +<tag-name id="slabs"><literal>slabs</literal></tag-name> +<tag-desc> +For each shared memory zone that uses slab allocator: +<list type="tag"> + +<tag-name><literal>pages</literal></tag-name> +<tag-desc> +<list type="tag"> + +<tag-name><literal>used</literal></tag-name> +<tag-desc> +The current number of used memory pages. +</tag-desc> + +<tag-name><literal>free</literal></tag-name> +<tag-desc> +The current number of free memory pages. +</tag-desc> + +</list> +</tag-desc> + +<tag-name><literal>slots</literal></tag-name> +<tag-desc> +For each memory slot size (8, 16, 32, 64, 128, etc.) +the following data are provided: +<list type="tag"> + +<tag-name><literal>used</literal></tag-name> +<tag-desc> +The current number of used memory slots. +</tag-desc> + +<tag-name><literal>free</literal></tag-name> +<tag-desc> +The current number of free memory slots. +</tag-desc> + +<tag-name><literal>reqs</literal></tag-name> +<tag-desc> +The total number of attempts to allocate memory of specified size. +</tag-desc> + +<tag-name><literal>fails</literal></tag-name> +<tag-desc> +The number of unsuccessful attempts to allocate memory of specified size. +</tag-desc> + +</list> +</tag-desc> + +</list> +</tag-desc> + <tag-name id="upstreams"><literal>upstreams</literal></tag-name> <tag-desc> For each @@ -384,6 +449,20 @@ of the server. </tag-desc> +<tag-name id="name"><literal>name</literal></tag-name> +<tag-desc> +The name of the server specified in the +<link doc="ngx_http_upstream_module.xml" id="server"/> +directive. +</tag-desc> + +<tag-name id="service"><literal>service</literal></tag-name> +<tag-desc> +The <link doc="ngx_http_upstream_module.xml" id="service"/> +parameter value of the +<link doc="ngx_http_upstream_module.xml" id="server"/> directive. +</tag-desc> + <tag-name><literal>backup</literal></tag-name> <tag-desc> A boolean value indicating whether the server is a @@ -404,6 +483,7 @@ “<literal>draining</literal>”, “<literal>down</literal>”, “<literal>unavail</literal>”, +“<literal>checking</literal>”, or “<literal>unhealthy</literal>”. </tag-desc> @@ -510,16 +590,16 @@ <tag-name><literal>downtime</literal></tag-name> <tag-desc> Total time -the server was in the “<literal>unavail</literal>” -and “<literal>unhealthy</literal>” states. +the server was in the “<literal>unavail</literal>”, +“<literal>checking</literal>”, and “<literal>unhealthy</literal>” states. </tag-desc> <tag-name><literal>downstart</literal></tag-name> <tag-desc> The time (in milliseconds since Epoch) when the server became -“<literal>unavail</literal>” -or “<literal>unhealthy</literal>”. +“<literal>unavail</literal>”, +“<literal>checking</literal>”, or “<literal>unhealthy</literal>”. </tag-desc> <tag-name id="selected"><literal>selected</literal></tag-name> @@ -563,6 +643,13 @@ from the group but still processing active client requests. </tag-desc> +<tag-name id="zone"><literal>zone</literal></tag-name> +<tag-desc> +The name of the shared memory +<link doc="ngx_http_upstream_module.xml" id="zone"/> +that keeps the group’s configuration and run-time state. +</tag-desc> + <tag-name id="queue"><literal>queue</literal></tag-name> <tag-desc> For the requests <link doc="ngx_http_upstream_module.xml" id="queue"/>, @@ -735,7 +822,7 @@ </list> </tag-desc> -<tag-name><literal>upstreams</literal></tag-name> +<tag-name id="stream_upstreams"><literal>upstreams</literal></tag-name> <tag-desc> For each <link doc="../stream/ngx_stream_upstream_module.xml" id="zone">dynamically @@ -763,6 +850,20 @@ of the server. </tag-desc> + +<tag-name id="stream_name"><literal>name</literal></tag-name> +<tag-desc> +The name of the server specified in the +<link doc="../stream/ngx_stream_upstream_module.xml" id="server"/> directive. +</tag-desc> + +<tag-name id="stream_service"><literal>service</literal></tag-name> +<tag-desc> +The <link doc="../stream/ngx_stream_upstream_module.xml" id="service"/> +parameter value of the +<link doc="../stream/ngx_stream_upstream_module.xml" id="server"/> directive. +</tag-desc> + <tag-name><literal>backup</literal></tag-name> <tag-desc> A boolean value indicating whether the server is a @@ -782,6 +883,7 @@ “<literal>up</literal>”, “<literal>down</literal>”, “<literal>unavail</literal>”, +“<literal>checking</literal>”, or “<literal>unhealthy</literal>”. </tag-desc> @@ -882,16 +984,16 @@ <tag-name><literal>downtime</literal></tag-name> <tag-desc> Total time -the server was in the “<literal>unavail</literal>” -and “<literal>unhealthy</literal>” states. +the server was in the “<literal>unavail</literal>”, +“<literal>checking</literal>”, and “<literal>unhealthy</literal>” states. </tag-desc> <tag-name><literal>downstart</literal></tag-name> <tag-desc> The time (in milliseconds since Epoch) when the server became -“<literal>unavail</literal>” -or “<literal>unhealthy</literal>”. +“<literal>unavail</literal>”, +“<literal>checking</literal>”, or “<literal>unhealthy</literal>”. </tag-desc> <tag-name><literal>selected</literal></tag-name> @@ -903,6 +1005,19 @@ </list> </tag-desc> +<tag-name><literal>zombies</literal></tag-name> +<tag-desc> +The current number of servers removed +from the group but still processing active client connections. +</tag-desc> + +<tag-name><literal>zone</literal></tag-name> +<tag-desc> +The name of the shared memory +<link doc="../stream/ngx_stream_upstream_module.xml" id="zone"/> +that keeps the group’s configuration and run-time state. +</tag-desc> + </list> </tag-desc> @@ -921,6 +1036,39 @@ <listitem> The +<link id="zone"/> field in +<link id="upstreams">http</link> and <link id="stream_upstreams">stream</link> +upstreams +was added in <link id="version"/> 8. +</listitem> + +<listitem> +The <link id="slabs"/> status data +were added in <link id="version"/> 8. +</listitem> + +<listitem> +The +<link id="state">checking</link> state +was added in <link id="version"/> 8. +</listitem> + +<listitem> +The +<link id="name"/> and <link id="service"/> fields in +<link id="upstreams">http</link> and <link id="stream_upstreams">stream</link> +upstreams +were added in <link id="version"/> 8. +</listitem> + +<listitem> +The +<link id="nginx_build"/> and <link id="ppid"/> fields +were added in <link id="version"/> 8. +</listitem> + +<listitem> +The <link id="sessions"/> status data and the <link id="stream_discarded">discarded</link> field in stream <link id="stream_server_zones">server_zones</link>
--- a/xml/en/docs/http/ngx_http_upstream_module.xml Mon Mar 06 17:01:22 2017 +0300 +++ b/xml/en/docs/http/ngx_http_upstream_module.xml Wed Mar 08 18:05:46 2017 +0300 @@ -10,7 +10,7 @@ <module name="Module ngx_http_upstream_module" link="/en/docs/http/ngx_http_upstream_module.html" lang="en" - rev="58"> + rev="59"> <section id="summary"> @@ -701,7 +701,10 @@ <directive name="least_time"> -<syntax><literal>header</literal> | <literal>last_byte</literal></syntax> +<syntax> + <literal>header</literal> | + <literal>last_byte</literal> + [<literal>inflight</literal>]</syntax> <default/> <context>upstream</context> <appeared-in>1.7.10</appeared-in> @@ -721,6 +724,11 @@ If the <literal>last_byte</literal> parameter is specified, time to receive the <link id="var_upstream_response_time">full response</link> is used. +If the <literal>inflight</literal> parameter is specified (1.11.6), +incomplete requests are also taken into account. +<note> +Prior to version 1.11.6, incomplete requests were taken into account by default. +</note> </para> <para> @@ -790,6 +798,16 @@ by default, “<literal>/</literal>”. </tag-desc> +<tag-name id="health_check_mandatory"> +<literal>mandatory</literal> +</tag-name> +<tag-desc> +sets the initial “checking” state for a server +until the first health check is completed (1.11.7). +If the parameter is not specified, +the server will be initially considered healthy. +</tag-desc> + <tag-name id="hc_match"> <literal>match</literal>=<value>name</value> </tag-name> @@ -825,7 +843,8 @@ proxied server responds with the status code other than 2xx or 3xx, the health check will fail, and the server will be considered unhealthy. -Client requests are not passed to unhealthy servers. +Client requests are not passed to unhealthy servers +and servers in the “checking” state. </para> <para> @@ -1045,6 +1064,12 @@ <para> <note> +When using load balancer methods other than the default +round-robin method, it is necessary to activate them before +the <literal>queue</literal> directive. +</note> + +<note> This directive is available as part of our <commercial_version>commercial subscription</commercial_version>. </note>
--- a/xml/en/docs/stream/ngx_stream_upstream_module.xml Mon Mar 06 17:01:22 2017 +0300 +++ b/xml/en/docs/stream/ngx_stream_upstream_module.xml Wed Mar 08 18:05:46 2017 +0300 @@ -9,7 +9,7 @@ <module name="Module ngx_stream_upstream_module" link="/en/docs/stream/ngx_stream_upstream_module.html" lang="en" - rev="23"> + rev="24"> <section id="summary"> @@ -451,9 +451,11 @@ <directive name="least_time"> -<syntax><literal>connect</literal> | - <literal>first_byte</literal> | - <literal>last_byte</literal></syntax> +<syntax> + <literal>connect</literal> | + <literal>first_byte</literal> | + <literal>last_byte</literal> + [<literal>inflight</literal>]</syntax> <default/> <context>upstream</context> @@ -472,6 +474,12 @@ time to receive the first byte of data is used. If the <literal>last_byte</literal> is specified, time to receive the last byte of data is used. +If the <literal>inflight</literal> parameter is specified (1.11.6), +incomplete connections are also taken into account. +<note> +Prior to version 1.11.6, +incomplete connections were taken into account by default. +</note> </para> <para> @@ -533,14 +541,33 @@ by default, 1. </tag-desc> +<tag-name id="health_check_mandatory"> +<literal>mandatory</literal> +</tag-name> +<tag-desc> +sets the initial “checking” state for a server +until the first health check is completed (1.11.7). +If the parameter is not specified, +the server will be initially considered healthy. +</tag-desc> + <tag-name id="hc_match"> <literal>match</literal>=<value>name</value> </tag-name> <tag-desc> specifies the <literal>match</literal> block configuring the tests that a successful connection should pass in order for a health check to pass. -By default, -only the ability to establish a TCP connection with the server is checked. +By default, for TCP, only the ability +to establish a TCP connection with the server is checked. +For <link id="health_check_udp">UDP</link>, the absence of +ICMP “<literal>Destination Unreachable</literal>” message is expected +in reply to the sent string “<literal>nginx health check</literal>”. +<note> +Prior to version 1.11.7, by default, UDP health check +required a <link id="hc_match">match</link> block with the +<link id="match_send">send</link> and <link id="match_expect">expect</link> +parameters. +</note> </tag-desc> <tag-name id="health_check_port"> @@ -557,10 +584,7 @@ </tag-name> <tag-desc> specifies that the <literal>UDP</literal> protocol should be used for -health checks instead of the default <literal>TCP</literal> protocol (1.9.13); -requires a <link id="hc_match">match</link> block with the -<link id="match_send">send</link> and <link id="match_expect">expect</link> -parameters. +health checks instead of the default <literal>TCP</literal> protocol (1.9.13). </tag-desc> </list> @@ -579,7 +603,8 @@ When a connection to the server cannot be established, the health check will fail, and the server will be considered unhealthy. -Client connections are not passed to unhealthy servers. +Client connections are not passed to unhealthy servers +and servers in the “checking” state. </para> <para>
--- a/xml/ru/docs/http/ngx_http_auth_jwt_module.xml Mon Mar 06 17:01:22 2017 +0300 +++ b/xml/ru/docs/http/ngx_http_auth_jwt_module.xml Wed Mar 08 18:05:46 2017 +0300 @@ -9,7 +9,7 @@ <module name="Модуль ngx_http_auth_jwt_module" link="/ru/docs/http/ngx_http_auth_jwt_module.html" lang="ru" - rev="2"> + rev="3"> <section id="summary"> @@ -97,6 +97,34 @@ </directive> +<directive name="auth_jwt_header_set"> +<syntax><value>$переменная</value> <value>имя</value></syntax> +<default/> +<context>http</context> +<appeared-in>1.11.10</appeared-in> + +<para> +Устанавливает <value>переменную</value> в заданное +<value>имя</value> параметра заголовка JOSE. +</para> + +</directive> + + +<directive name="auth_jwt_claim_set"> +<syntax><value>$переменная</value> <value>имя</value></syntax> +<default/> +<context>http</context> +<appeared-in>1.11.10</appeared-in> + +<para> +Устанавливает <value>переменную</value> в заданное +<value>имя</value> параметра JWT claim. +</para> + +</directive> + + <directive name="auth_jwt_key_file"> <syntax><value>файл</value></syntax> <default/> @@ -120,84 +148,21 @@ <para> Модуль <literal>ngx_http_auth_jwt_module</literal> -поддерживает встроенные переменные. +поддерживает встроенные переменные: </para> <para> -Переменные, возвращающие -<link url="https://tools.ietf.org/html/rfc7519#section-4">JWT claims</link>: - <list type="tag" compact="yes"> -<tag-name id="var_jwt_claim_aud"><var>$jwt_claim_aud</var></tag-name> -<tag-desc> -audience (аудитория) -</tag-desc> - -<tag-name id="var_jwt_claim_email"><var>$jwt_claim_email</var></tag-name> -<tag-desc> -email -</tag-desc> - -<tag-name id="var_jwt_claim_exp"><var>$jwt_claim_exp</var></tag-name> +<tag-name id="var_jwt_header_"><var>$jwt_header_</var><value>имя</value></tag-name> <tag-desc> -expiration time (время окончания действия) -</tag-desc> - -<tag-name id="var_jwt_claim_iat"><var>$jwt_claim_iat</var></tag-name> -<tag-desc> -issued at (когда выдан) -</tag-desc> - -<tag-name id="var_jwt_claim_iss"><var>$jwt_claim_iss</var></tag-name> -<tag-desc> -issuer (издатель) -</tag-desc> - -<tag-name id="var_jwt_claim_jti"><var>$jwt_claim_jti</var></tag-name> -<tag-desc> -JWT ID (идентификатор JWT) +возвращает значение указанного +<link url="https://tools.ietf.org/html/rfc7515#section-4">заголовка JOSE</link> </tag-desc> -<tag-name id="var_jwt_claim_nbf"><var>$jwt_claim_nbf</var></tag-name> -<tag-desc> -not-before (не ранее, чем) -</tag-desc> - -<tag-name id="var_jwt_claim_sub"><var>$jwt_claim_sub</var></tag-name> -<tag-desc> -subject (субъект) -</tag-desc> -</list> -</para> - -<para> -Переменные, возвращающие параметры -<link url="https://tools.ietf.org/html/rfc7515#section-4">заголовка JOSE</link>: - -<list type="tag" compact="yes"> -<tag-name id="var_jwt_header_alg"><var>$jwt_header_alg</var></tag-name> +<tag-name id="var_jwt_claim_"><var>$jwt_claim_</var><value>имя</value></tag-name> <tag-desc> -algorithm (алгоритм) -</tag-desc> - -<tag-name id="var_jwt_header_cty"><var>$jwt_header_cty</var></tag-name> -<tag-desc> -content type (тип содержимого) -</tag-desc> - -<tag-name id="var_jwt_header_enc"><var>$jwt_header_enc</var></tag-name> -<tag-desc> -encryption algorithm (алгоритм шифрования) -</tag-desc> - -<tag-name id="var_jwt_header_kid"><var>$jwt_header_kid</var></tag-name> -<tag-desc> -key ID (идентификатор ключа) -</tag-desc> - -<tag-name id="var_jwt_header_typ"><var>$jwt_header_typ</var></tag-name> -<tag-desc> -type (тип) +возвращает значение указанной +<link url="https://tools.ietf.org/html/rfc7519#section-4">JWT claim</link> </tag-desc> </list>
--- a/xml/ru/docs/http/ngx_http_status_module.xml Mon Mar 06 17:01:22 2017 +0300 +++ b/xml/ru/docs/http/ngx_http_status_module.xml Wed Mar 08 18:05:46 2017 +0300 @@ -9,7 +9,7 @@ <module name="Модуль ngx_http_status_module" link="/ru/docs/http/ngx_http_status_module.html" lang="ru" - rev="12"> + rev="13"> <section id="summary"> @@ -187,7 +187,7 @@ <tag-name id="version"><literal>version</literal></tag-name> <tag-desc> Версия предоставляемого набора данных. -Текущей является версия 7. +Текущей является версия 8. </tag-desc> <tag-name><literal>nginx_version</literal></tag-name> @@ -195,6 +195,11 @@ Версия nginx. </tag-desc> +<tag-name id="nginx_build"><literal>nginx_build</literal></tag-name> +<tag-desc> +Название сборки nginx. +</tag-desc> + <tag-name><literal>address</literal></tag-name> <tag-desc> Адрес сервера, принявшего запрос на получение информации о состоянии. @@ -223,6 +228,12 @@ обработавшего запрос на получение информации о состоянии. </tag-desc> +<tag-name id="ppid"><literal>ppid</literal></tag-name> +<tag-desc> +Идентификатор главного процесса, +запустившего <link id="pid">рабочий процесс</link>. +</tag-desc> + <tag-name id="processes"><literal>processes</literal></tag-name> <tag-desc> <list type="tag"> @@ -362,6 +373,60 @@ </list> </tag-desc> +<tag-name id="slabs"><literal>slabs</literal></tag-name> +<tag-desc> +Для каждой зоны разделяемой памяти, в которой используется распределение slab: +<list type="tag"> + +<tag-name><literal>pages</literal></tag-name> +<tag-desc> +<list type="tag"> + +<tag-name><literal>used</literal></tag-name> +<tag-desc> +Текущее число занятых страниц памяти. +</tag-desc> + +<tag-name><literal>free</literal></tag-name> +<tag-desc> +Текущее число свободных страниц памяти. +</tag-desc> + +</list> +</tag-desc> + +<tag-name><literal>slots</literal></tag-name> +<tag-desc> +Для каждого размера слота памяти (8, 16, 32, 64, 128 и т.д.) +доступны следующие данные: +<list type="tag"> + +<tag-name><literal>used</literal></tag-name> +<tag-desc> +Текущее число занятых слотов памяти. +</tag-desc> + +<tag-name><literal>free</literal></tag-name> +<tag-desc> +Текущее число свободных слотов памяти. +</tag-desc> + +<tag-name><literal>reqs</literal></tag-name> +<tag-desc> +Суммарное число попыток выделения памяти указанного размера. +</tag-desc> + +<tag-name><literal>fails</literal></tag-name> +<tag-desc> +Число неудачных попыток выделения памяти указанного размера. +</tag-desc> + +</list> +</tag-desc> + +</list> +</tag-desc> + <tag-name id="upstreams"><literal>upstreams</literal></tag-name> <tag-desc> Для каждой @@ -389,6 +454,19 @@ сервера. </tag-desc> +<tag-name id="name"><literal>name</literal></tag-name> +<tag-desc> +Имя сервера, указанное в директиве +<link doc="ngx_http_upstream_module.xml" id="server"/>. +</tag-desc> + +<tag-name id="service"><literal>service</literal></tag-name> +<tag-desc> +Значение параметра +<link doc="ngx_http_upstream_module.xml" id="service"/> +директивы <link doc="ngx_http_upstream_module.xml" id="server"/>. +</tag-desc> + <tag-name><literal>backup</literal></tag-name> <tag-desc> Логическое значение, означающее, является ли сервер @@ -407,7 +485,8 @@ “<literal>up</literal>”, “<literal>draining</literal>”, “<literal>down</literal>”, -“<literal>unavail</literal>” +“<literal>unavail</literal>”, +“<literal>checking</literal>” или “<literal>unhealthy</literal>”. </tag-desc> @@ -513,16 +592,16 @@ <tag-name><literal>downtime</literal></tag-name> <tag-desc> Суммарное время, -когда сервер находился в состояниях “<literal>unavail</literal>” -и “<literal>unhealthy</literal>”. +когда сервер находился в состояниях “<literal>unavail</literal>”, +“<literal>checking</literal>” и “<literal>unhealthy</literal>”. </tag-desc> <tag-name><literal>downstart</literal></tag-name> <tag-desc> Время (в миллисекундах с начала эпохи), когда сервер стал -“<literal>unavail</literal>” -или “<literal>unhealthy</literal>”. +“<literal>unavail</literal>”, +“<literal>checking</literal>” или “<literal>unhealthy</literal>”. </tag-desc> <tag-name id="selected"><literal>selected</literal></tag-name> @@ -564,6 +643,13 @@ из группы, но всё ещё обрабатывающих активные клиентские запросы. </tag-desc> +<tag-name id="zone"><literal>zone</literal></tag-name> +<tag-desc> +Имя <link doc="ngx_http_upstream_module.xml" id="zone">зоны</link> +разделяемой памяти, +в которой хранятся конфигурация группы и её рабочее состояние. +</tag-desc> + <tag-name id="queue"><literal>queue</literal></tag-name> <tag-desc> Для <link doc="ngx_http_upstream_module.xml" id="queue">очереди</link> запросов @@ -739,7 +825,7 @@ </list> </tag-desc> -<tag-name><literal>upstreams</literal></tag-name> +<tag-name id="stream_upstreams"><literal>upstreams</literal></tag-name> <tag-desc> Для каждого <link doc="../stream/ngx_stream_upstream_module.xml" id="server">сервера</link> @@ -761,6 +847,19 @@ сервера. </tag-desc> +<tag-name id="stream_name"><literal>name</literal></tag-name> +<tag-desc> +Имя сервера, указанное в директиве +<link doc="../stream/ngx_stream_upstream_module.xml" id="server"/>. +</tag-desc> + +<tag-name id="stream_service"><literal>service</literal></tag-name> +<tag-desc> +Значение параметра +<link doc="ngx_http_upstream_module.xml" id="service"/> +директивы <link doc="ngx_http_upstream_module.xml" id="server"/>. +</tag-desc> + <tag-name><literal>backup</literal></tag-name> <tag-desc> Логическое значение, означающее, является ли сервер @@ -778,7 +877,8 @@ Текущее состояние, которое может быть одним из “<literal>up</literal>”, “<literal>down</literal>”, -“<literal>unavail</literal>” +“<literal>unavail</literal>”, +“<literal>checking</literal>” или “<literal>unhealthy</literal>”. </tag-desc> @@ -875,16 +975,16 @@ <tag-name><literal>downtime</literal></tag-name> <tag-desc> Суммарное время, -когда сервер находился в состояниях “<literal>unavail</literal>” -и “<literal>unhealthy</literal>”. +когда сервер находился в состояниях “<literal>unavail</literal>”, +“<literal>checking</literal>” и “<literal>unhealthy</literal>”. </tag-desc> <tag-name><literal>downstart</literal></tag-name> <tag-desc> Время (в миллисекундах с начала эпохи), когда сервер стал -“<literal>unavail</literal>” -или “<literal>unhealthy</literal>”. +“<literal>unavail</literal>”, +“<literal>checking</literal>” или “<literal>unhealthy</literal>”. </tag-desc> <tag-name><literal>selected</literal></tag-name> @@ -896,6 +996,19 @@ </list> </tag-desc> +<tag-name><literal>zombies</literal></tag-name> +<tag-desc> +Текущее число серверов, удалённых +из группы, но всё ещё обрабатывающих активные клиентские соединения. +</tag-desc> + +<tag-name><literal>zone</literal></tag-name> +<tag-desc> +Имя <link doc="../stream/ngx_stream_upstream_module.xml" id="zone">зоны</link> +разделяемой памяти, +в которой хранятся конфигурация группы и её рабочее состояние. +</tag-desc> + </list> </tag-desc> @@ -910,6 +1023,37 @@ <list type="bullet"> <listitem> +Поле <link id="zone"/> в +<link id="upstreams">http</link> и <link id="stream_upstreams">stream</link> +upstreams +было добавлено в <link id="version">версии</link> 8. +</listitem> + +<listitem> +Поля <link id="slabs"/> +были добавлены в <link id="version">версии</link> 8. +</listitem> + +<listitem> +Состояние +<link id="state">checking</link> +было добавлено в <link id="version">версии</link> 8. +</listitem> + +<listitem> +Поля +<link id="name"/> и <link id="service"/> в +<link id="upstreams">http</link> и <link id="stream_upstreams">stream</link> +upstreams +были добавлены в <link id="version">версии</link> 8. +</listitem> + +<listitem> +Поля <link id="nginx_build"/> и <link id="ppid"/> +были добавлены в <link id="version">версии</link> 8. +</listitem> + +<listitem> Поля <link id="sessions"/> и поле <link id="stream_discarded">discarded</link> в stream <link id="stream_server_zones">server_zones</link>
--- a/xml/ru/docs/http/ngx_http_upstream_module.xml Mon Mar 06 17:01:22 2017 +0300 +++ b/xml/ru/docs/http/ngx_http_upstream_module.xml Wed Mar 08 18:05:46 2017 +0300 @@ -10,7 +10,7 @@ <module name="Модуль ngx_http_upstream_module" link="/ru/docs/http/ngx_http_upstream_module.html" lang="ru" - rev="58"> + rev="59"> <section id="summary"> @@ -709,7 +709,10 @@ <directive name="least_time"> -<syntax><literal>header</literal> | <literal>last_byte</literal></syntax> +<syntax> + <literal>header</literal> | + <literal>last_byte</literal> + [<literal>inflight</literal>]</syntax> <default/> <context>upstream</context> <appeared-in>1.7.10</appeared-in> @@ -728,6 +731,11 @@ <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> @@ -797,6 +805,16 @@ по умолчанию “<literal>/</literal>”. </tag-desc> +<tag-name id="health_check_mandatory"> +<literal>mandatory</literal> +</tag-name> +<tag-desc> +устанавливает исходное состояние “checking” для сервера +до завершения первой проверки работоспособности (1.11.7). +Если параметр не указан, +то исходно сервер будет считаться работоспособным. +</tag-desc> + <tag-name id="hc_match"> <literal>match</literal>=<value>имя</value> </tag-name> @@ -832,7 +850,8 @@ код ответа проксируемого сервера не равен 2xx или 3xx, проверка считается неуспешной и сервер признаётся неработоспособным. -На неработоспособные серверы клиентские запросы передаваться не будут. +На неработоспособные серверы и серверы в состоянии “checking” +клиентские запросы передаваться не будут. </para> <para> @@ -1053,6 +1072,12 @@ <para> <note> +При использовании методов балансировки нагрузки, отличных +от стандартного round-robin, следует активировать их до +директивы <literal>queue</literal>. +</note> + +<note> Эта директива доступна как часть <commercial_version>коммерческой подписки</commercial_version>. </note>
--- a/xml/ru/docs/stream/ngx_stream_upstream_module.xml Mon Mar 06 17:01:22 2017 +0300 +++ b/xml/ru/docs/stream/ngx_stream_upstream_module.xml Wed Mar 08 18:05:46 2017 +0300 @@ -9,7 +9,7 @@ <module name="Модуль ngx_stream_upstream_module" link="/ru/docs/stream/ngx_stream_upstream_module.html" lang="ru" - rev="23"> + rev="24"> <section id="summary"> @@ -451,9 +451,11 @@ <directive name="least_time"> -<syntax><literal>connect</literal> | - <literal>first_byte</literal> | - <literal>last_byte</literal></syntax> +<syntax> + <literal>connect</literal> | + <literal>first_byte</literal> | + <literal>last_byte</literal> + [<literal>inflight</literal>]</syntax> <default/> <context>upstream</context> @@ -472,6 +474,12 @@ то учитывается время получения первого байта данных. Если указан параметр <literal>last_byte</literal>, то учитывается время получения ответа. +Если указан параметр <literal>inflight</literal> (1.11.6), +то также учитываются незавершённые соединения. +<note> +До версии 1.11.6 +незавершённые соединения учитывались по умолчанию. +</note> </para> <para> @@ -533,13 +541,32 @@ по умолчанию 1. </tag-desc> +<tag-name id="health_check_mandatory"> +<literal>mandatory</literal> +</tag-name> +<tag-desc> +устанавливает исходное состояние “checking” для сервера +до завершения первой проверки работоспособности (1.11.7). +Если параметр не указан, +то исходно сервер будет считаться работоспособным. +</tag-desc> + <tag-name id="hc_match"> <literal>match</literal>=<value>имя</value> </tag-name> <tag-desc> указывает на блок <literal>match</literal> с условиями, которым должно удовлетворять соединение, чтобы результат проверки считался успешным. -По умолчанию проверяется лишь возможность установки TCP-соединения с сервером. +По умолчанию для TCP проверяется +лишь возможность установки TCP-соединения с сервером, +для <link id="health_check_udp">UDP</link> проверяется отсутствие +сообщения ICMP “<literal>Destination Unreachable</literal>” +в ответ на отправленную строку “<literal>nginx health check</literal>”. +<note> +До версии 1.11.7 по умолчанию для UDP +требовалось наличие блока <link id="hc_match">match</link> с параметрами +<link id="match_send">send</link> и <link id="match_expect">expect</link>. +</note> </tag-desc> <tag-name id="health_check_port"> @@ -557,9 +584,7 @@ <tag-desc> указывает, что для проверки работоспособности будет использоваться протокол <literal>UDP</literal> -вместо протокола <literal>TCP</literal>, используемого по умолчанию (1.9.13); -требует наличия блока <link id="hc_match">match</link> с параметрами -<link id="match_send">send</link> и <link id="match_expect">expect</link>. +вместо протокола <literal>TCP</literal>, используемого по умолчанию (1.9.13). </tag-desc> </list> @@ -578,7 +603,8 @@ Если соединение с сервером не может быть установлено, проверка считается неуспешной и сервер признаётся неработоспособным. -На неработоспособные серверы клиентские соединения передаваться не будут. +На неработоспособные серверы и серверы в состоянии “checking” +клиентские соединения передаваться не будут. </para> <para>