# HG changeset patch # User Ruslan Ermilov # Date 1488985546 -10800 # Node ID a58b35cc08237e64acb8a9a2af5bdd0c23b5f16c # Parent 237a10fb98d26c7ebf6c521dc8aa76c045ff19d4 Updated docs for the upcoming NGINX Plus release. diff -r 237a10fb98d2 -r a58b35cc0823 xml/en/docs/http/ngx_http_auth_jwt_module.xml --- 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 @@ + rev="3">
@@ -99,6 +99,34 @@ + +$variable name + +http +1.11.10 + + +Sets the variable to the given +JOSE header parameter name. + + + + + + +$variable name + +http +1.11.10 + + +Sets the variable to the given +JWT claim parameter name. + + + + + file @@ -122,84 +150,21 @@ The ngx_http_auth_jwt_module module -supports embedded variables. +supports embedded variables: -Variables that return -JWT claims: - -$jwt_claim_aud - -audience - - -$jwt_claim_email - -email - - -$jwt_claim_exp +$jwt_header_name -expiration time - - -$jwt_claim_iat - -issued at - - -$jwt_claim_iss - -issuer - - -$jwt_claim_jti - -JWT ID +returns the value of a specified +JOSE header -$jwt_claim_nbf - -not-before - - -$jwt_claim_sub - -subject - - - - - -Variables that return parameters of -JOSE header: - - -$jwt_header_alg +$jwt_claim_name -algorithm - - -$jwt_header_cty - -content type - - -$jwt_header_enc - -encryption algorithm - - -$jwt_header_kid - -key ID - - -$jwt_header_typ - -type +returns the value of a specified +JWT claim diff -r 237a10fb98d2 -r a58b35cc0823 xml/en/docs/http/ngx_http_status_module.xml --- 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 @@ + rev="13">
@@ -184,7 +184,7 @@ version Version of the provided data set. -The current version is 7. +The current version is 8. nginx_version @@ -192,6 +192,11 @@ Version of nginx. +nginx_build + +Name of nginx build. + + address The address of the server that accepted status request. @@ -218,6 +223,12 @@ The ID of the worker process that handled status request. +ppid + +The ID of the master process that started +the worker process. + + processes @@ -356,6 +367,60 @@ +slabs + +For each shared memory zone that uses slab allocator: + + +pages + + + +used + +The current number of used memory pages. + + +free + +The current number of free memory pages. + + + + + +slots + +For each memory slot size (8, 16, 32, 64, 128, etc.) +the following data are provided: + + +used + +The current number of used memory slots. + + +free + +The current number of free memory slots. + + +reqs + +The total number of attempts to allocate memory of specified size. + + +fails + +The number of unsuccessful attempts to allocate memory of specified size. + + + + + + + + upstreams For each @@ -384,6 +449,20 @@ of the server. +name + +The name of the server specified in the + +directive. + + +service + +The +parameter value of the + directive. + + backup A boolean value indicating whether the server is a @@ -404,6 +483,7 @@ “draining”, “down”, “unavail”, +“checking”, or “unhealthy”. @@ -510,16 +590,16 @@ downtime Total time -the server was in the “unavail” -and “unhealthy” states. +the server was in the “unavail”, +“checking”, and “unhealthy” states. downstart The time (in milliseconds since Epoch) when the server became -“unavail” -or “unhealthy”. +“unavail”, +“checking”, or “unhealthy”. selected @@ -563,6 +643,13 @@ from the group but still processing active client requests. +zone + +The name of the shared memory + +that keeps the group’s configuration and run-time state. + + queue For the requests , @@ -735,7 +822,7 @@ -upstreams +upstreams For each dynamically @@ -763,6 +850,20 @@ of the server. + +name + +The name of the server specified in the + directive. + + +service + +The +parameter value of the + directive. + + backup A boolean value indicating whether the server is a @@ -782,6 +883,7 @@ “up”, “down”, “unavail”, +“checking”, or “unhealthy”. @@ -882,16 +984,16 @@ downtime Total time -the server was in the “unavail” -and “unhealthy” states. +the server was in the “unavail”, +“checking”, and “unhealthy” states. downstart The time (in milliseconds since Epoch) when the server became -“unavail” -or “unhealthy”. +“unavail”, +“checking”, or “unhealthy”. selected @@ -903,6 +1005,19 @@ +zombies + +The current number of servers removed +from the group but still processing active client connections. + + +zone + +The name of the shared memory + +that keeps the group’s configuration and run-time state. + + @@ -921,6 +1036,39 @@ The + field in +http and stream +upstreams +was added in 8. + + + +The status data +were added in 8. + + + +The +checking state +was added in 8. + + + +The + and fields in +http and stream +upstreams +were added in 8. + + + +The + and fields +were added in 8. + + + +The status data and the discarded field in stream server_zones diff -r 237a10fb98d2 -r a58b35cc0823 xml/en/docs/http/ngx_http_upstream_module.xml --- 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 @@ + rev="59">
@@ -701,7 +701,10 @@ -header | last_byte + + header | + last_byte + [inflight] upstream 1.7.10 @@ -721,6 +724,11 @@ If the last_byte parameter is specified, time to receive the full response is used. +If the inflight parameter is specified (1.11.6), +incomplete requests are also taken into account. + +Prior to version 1.11.6, incomplete requests were taken into account by default. + @@ -790,6 +798,16 @@ by default, “/”. + +mandatory + + +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. + + match=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. @@ -1045,6 +1064,12 @@ +When using load balancer methods other than the default +round-robin method, it is necessary to activate them before +the queue directive. + + + This directive is available as part of our commercial subscription. diff -r 237a10fb98d2 -r a58b35cc0823 xml/en/docs/stream/ngx_stream_upstream_module.xml --- 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 @@ + rev="24">
@@ -451,9 +451,11 @@ -connect | - first_byte | - last_byte + + connect | + first_byte | + last_byte + [inflight] upstream @@ -472,6 +474,12 @@ time to receive the first byte of data is used. If the last_byte is specified, time to receive the last byte of data is used. +If the inflight parameter is specified (1.11.6), +incomplete connections are also taken into account. + +Prior to version 1.11.6, +incomplete connections were taken into account by default. + @@ -533,14 +541,33 @@ by default, 1. + +mandatory + + +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. + + match=name specifies the match 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 UDP, the absence of +ICMP “Destination Unreachable” message is expected +in reply to the sent string “nginx health check”. + +Prior to version 1.11.7, by default, UDP health check +required a match block with the +send and expect +parameters. + @@ -557,10 +584,7 @@ specifies that the UDP protocol should be used for -health checks instead of the default TCP protocol (1.9.13); -requires a match block with the -send and expect -parameters. +health checks instead of the default TCP protocol (1.9.13). @@ -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. diff -r 237a10fb98d2 -r a58b35cc0823 xml/ru/docs/http/ngx_http_auth_jwt_module.xml --- 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 @@ + rev="3">
@@ -97,6 +97,34 @@ + +$переменная имя + +http +1.11.10 + + +Устанавливает переменную в заданное +имя параметра заголовка JOSE. + + + + + + +$переменная имя + +http +1.11.10 + + +Устанавливает переменную в заданное +имя параметра JWT claim. + + + + + файл @@ -120,84 +148,21 @@ Модуль ngx_http_auth_jwt_module -поддерживает встроенные переменные. +поддерживает встроенные переменные: -Переменные, возвращающие -JWT claims: - -$jwt_claim_aud - -audience (аудитория) - - -$jwt_claim_email - -email - - -$jwt_claim_exp +$jwt_header_имя -expiration time (время окончания действия) - - -$jwt_claim_iat - -issued at (когда выдан) - - -$jwt_claim_iss - -issuer (издатель) - - -$jwt_claim_jti - -JWT ID (идентификатор JWT) +возвращает значение указанного +заголовка JOSE -$jwt_claim_nbf - -not-before (не ранее, чем) - - -$jwt_claim_sub - -subject (субъект) - - - - - -Переменные, возвращающие параметры -заголовка JOSE: - - -$jwt_header_alg +$jwt_claim_имя -algorithm (алгоритм) - - -$jwt_header_cty - -content type (тип содержимого) - - -$jwt_header_enc - -encryption algorithm (алгоритм шифрования) - - -$jwt_header_kid - -key ID (идентификатор ключа) - - -$jwt_header_typ - -type (тип) +возвращает значение указанной +JWT claim diff -r 237a10fb98d2 -r a58b35cc0823 xml/ru/docs/http/ngx_http_status_module.xml --- 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 @@ + rev="13">
@@ -187,7 +187,7 @@ version Версия предоставляемого набора данных. -Текущей является версия 7. +Текущей является версия 8. nginx_version @@ -195,6 +195,11 @@ Версия nginx. +nginx_build + +Название сборки nginx. + + address Адрес сервера, принявшего запрос на получение информации о состоянии. @@ -223,6 +228,12 @@ обработавшего запрос на получение информации о состоянии. +ppid + +Идентификатор главного процесса, +запустившего рабочий процесс. + + processes @@ -362,6 +373,60 @@ +slabs + +Для каждой зоны разделяемой памяти, в которой используется распределение slab: + + +pages + + + +used + +Текущее число занятых страниц памяти. + + +free + +Текущее число свободных страниц памяти. + + + + + +slots + +Для каждого размера слота памяти (8, 16, 32, 64, 128 и т.д.) +доступны следующие данные: + + +used + +Текущее число занятых слотов памяти. + + +free + +Текущее число свободных слотов памяти. + + +reqs + +Суммарное число попыток выделения памяти указанного размера. + + +fails + +Число неудачных попыток выделения памяти указанного размера. + + + + + + + + upstreams Для каждой @@ -389,6 +454,19 @@ сервера. +name + +Имя сервера, указанное в директиве +. + + +service + +Значение параметра + +директивы . + + backup Логическое значение, означающее, является ли сервер @@ -407,7 +485,8 @@ “up”, “draining”, “down”, -“unavail” +“unavail”, +“checking” или “unhealthy”. @@ -513,16 +592,16 @@ downtime Суммарное время, -когда сервер находился в состояниях “unavail” -и “unhealthy”. +когда сервер находился в состояниях “unavail”, +“checking” и “unhealthy”. downstart Время (в миллисекундах с начала эпохи), когда сервер стал -“unavail” -или “unhealthy”. +“unavail”, +“checking” или “unhealthy”. selected @@ -564,6 +643,13 @@ из группы, но всё ещё обрабатывающих активные клиентские запросы. +zone + +Имя зоны +разделяемой памяти, +в которой хранятся конфигурация группы и её рабочее состояние. + + queue Для очереди запросов @@ -739,7 +825,7 @@ -upstreams +upstreams Для каждого сервера @@ -761,6 +847,19 @@ сервера. +name + +Имя сервера, указанное в директиве +. + + +service + +Значение параметра + +директивы . + + backup Логическое значение, означающее, является ли сервер @@ -778,7 +877,8 @@ Текущее состояние, которое может быть одним из “up”, “down”, -“unavail” +“unavail”, +“checking” или “unhealthy”. @@ -875,16 +975,16 @@ downtime Суммарное время, -когда сервер находился в состояниях “unavail” -и “unhealthy”. +когда сервер находился в состояниях “unavail”, +“checking” и “unhealthy”. downstart Время (в миллисекундах с начала эпохи), когда сервер стал -“unavail” -или “unhealthy”. +“unavail”, +“checking” или “unhealthy”. selected @@ -896,6 +996,19 @@ +zombies + +Текущее число серверов, удалённых +из группы, но всё ещё обрабатывающих активные клиентские соединения. + + +zone + +Имя зоны +разделяемой памяти, +в которой хранятся конфигурация группы и её рабочее состояние. + + @@ -910,6 +1023,37 @@ +Поле в +http и stream +upstreams +было добавлено в версии 8. + + + +Поля +были добавлены в версии 8. + + + +Состояние +checking +было добавлено в версии 8. + + + +Поля + и в +http и stream +upstreams +были добавлены в версии 8. + + + +Поля и +были добавлены в версии 8. + + + Поля и поле discarded в stream server_zones diff -r 237a10fb98d2 -r a58b35cc0823 xml/ru/docs/http/ngx_http_upstream_module.xml --- 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 @@ + rev="59">
@@ -709,7 +709,10 @@ -header | last_byte + + header | + last_byte + [inflight] upstream 1.7.10 @@ -728,6 +731,11 @@ заголовка ответа. Если указан параметр last_byte, то учитывается время получения всего ответа. +Если указан параметр inflight (1.11.6), +то также учитываются незавершённые запросы. + +До версии 1.11.6 незавершённые запросы учитывались по умолчанию. + @@ -797,6 +805,16 @@ по умолчанию “/”. + +mandatory + + +устанавливает исходное состояние “checking” для сервера +до завершения первой проверки работоспособности (1.11.7). +Если параметр не указан, +то исходно сервер будет считаться работоспособным. + + match=имя @@ -832,7 +850,8 @@ код ответа проксируемого сервера не равен 2xx или 3xx, проверка считается неуспешной и сервер признаётся неработоспособным. -На неработоспособные серверы клиентские запросы передаваться не будут. +На неработоспособные серверы и серверы в состоянии “checking” +клиентские запросы передаваться не будут. @@ -1053,6 +1072,12 @@ +При использовании методов балансировки нагрузки, отличных +от стандартного round-robin, следует активировать их до +директивы queue. + + + Эта директива доступна как часть коммерческой подписки. diff -r 237a10fb98d2 -r a58b35cc0823 xml/ru/docs/stream/ngx_stream_upstream_module.xml --- 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 @@ + rev="24">
@@ -451,9 +451,11 @@ -connect | - first_byte | - last_byte + + connect | + first_byte | + last_byte + [inflight] upstream @@ -472,6 +474,12 @@ то учитывается время получения первого байта данных. Если указан параметр last_byte, то учитывается время получения ответа. +Если указан параметр inflight (1.11.6), +то также учитываются незавершённые соединения. + +До версии 1.11.6 +незавершённые соединения учитывались по умолчанию. + @@ -533,13 +541,32 @@ по умолчанию 1. + +mandatory + + +устанавливает исходное состояние “checking” для сервера +до завершения первой проверки работоспособности (1.11.7). +Если параметр не указан, +то исходно сервер будет считаться работоспособным. + + match=имя указывает на блок match с условиями, которым должно удовлетворять соединение, чтобы результат проверки считался успешным. -По умолчанию проверяется лишь возможность установки TCP-соединения с сервером. +По умолчанию для TCP проверяется +лишь возможность установки TCP-соединения с сервером, +для UDP проверяется отсутствие +сообщения ICMP “Destination Unreachable” +в ответ на отправленную строку “nginx health check”. + +До версии 1.11.7 по умолчанию для UDP +требовалось наличие блока match с параметрами +send и expect. + @@ -557,9 +584,7 @@ указывает, что для проверки работоспособности будет использоваться протокол UDP -вместо протокола TCP, используемого по умолчанию (1.9.13); -требует наличия блока match с параметрами -send и expect. +вместо протокола TCP, используемого по умолчанию (1.9.13). @@ -578,7 +603,8 @@ Если соединение с сервером не может быть установлено, проверка считается неуспешной и сервер признаётся неработоспособным. -На неработоспособные серверы клиентские соединения передаваться не будут. +На неработоспособные серверы и серверы в состоянии “checking” +клиентские соединения передаваться не будут.