Mercurial > hg > nginx-site

changeset 2230:283b1e67eaa6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated docs for the upcoming NGINX Plus release.
author Ruslan Ermilov <ru@nginx.com>
date Thu, 30 Aug 2018 22:53:18 +0300
parents f134633cff5c
children cda9e349cc22
files xml/en/docs/http/ngx_http_keyval_module.xml xml/en/docs/http/ngx_http_limit_req_module.xml xml/en/docs/http/ngx_http_status_module.xml xml/en/docs/http/ngx_http_upstream_conf_module.xml xml/en/docs/http/ngx_http_upstream_module.xml xml/en/docs/stream/ngx_stream_keyval_module.xml xml/en/docs/stream/ngx_stream_upstream_module.xml xml/en/docs/stream/ngx_stream_zone_sync_module.xml xml/ru/docs/http/ngx_http_limit_req_module.xml xml/ru/docs/http/ngx_http_status_module.xml xml/ru/docs/http/ngx_http_upstream_conf_module.xml xml/ru/docs/http/ngx_http_upstream_module.xml xml/ru/docs/stream/ngx_stream_upstream_module.xml
diffstat 13 files changed, 160 insertions(+), 50 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_keyval_module.xml
+++ b/xml/en/docs/http/ngx_http_keyval_module.xml
@@ -9,7 +9,7 @@
 <module name="Module ngx_http_keyval_module"
         link="/en/docs/http/ngx_http_keyval_module.html"
         lang="en"
-        rev="2">
+        rev="3">
 
 <section id="summary">
 
@@ -79,7 +79,9 @@ specified by the <literal>zone</literal>
 <directive name="keyval_zone">
 <syntax>
     <literal>zone</literal>=<value>name</value>:<value>size</value>
-    [<literal>state</literal>=<value>file</value>]</syntax>
+    [<literal>state</literal>=<value>file</value>]
+    [<literal>timeout</literal>=<value>time</value>]
+    [<literal>sync</literal>]</syntax>
 <default/>
 <context>http</context>
 
@@ -90,12 +92,25 @@ Key-value pairs are managed by the
 <link doc="ngx_http_api_module.xml" id="http_keyvals_">API</link>.
 </para>
 
-<para>
+<para id="keyval_state">
 The optional <literal>state</literal> parameter specifies a <value>file</value>
 that keeps the current state of the key-value database in the JSON format
 and makes it persistent across nginx restarts.
 </para>
 
+<para id="keyval_timeout">
+The optional <literal>timeout</literal> parameter (1.15.0) sets
+the time after which key-value pairs are removed from the zone.
+</para>
+
+<para id="keyval_sync">
+The optional <literal>sync</literal> parameter (1.15.0) enables
+<link doc="../stream/ngx_stream_zone_sync_module.xml" id="zone_sync">synchronization</link>
+of the shared memory zone.
+The synchronization requires the
+<link id="keyval_timeout">timeout</link> parameter to be set.
+</para>
+
 </directive>
 
 </section>
--- a/xml/en/docs/http/ngx_http_limit_req_module.xml
+++ b/xml/en/docs/http/ngx_http_limit_req_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_limit_req_module"
         link="/en/docs/http/ngx_http_limit_req_module.html"
         lang="en"
-        rev="8">
+        rev="9">
 
 <section id="summary">
 
@@ -163,7 +163,8 @@ Sets the status code to return in respon
 <syntax>
     <value>key</value>
     <literal>zone</literal>=<value>name</value>:<value>size</value>
-    <literal>rate</literal>=<value>rate</value></syntax>
+    <literal>rate</literal>=<value>rate</value>
+    [<literal>sync</literal>]</syntax>
 <default/>
 <context>http</context>
 
@@ -213,6 +214,16 @@ it is specified in request per minute (r
 For example, half-request per second is 30r/m.
 </para>
 
+<para id="limit_req_zone_sync">
+The <literal>sync</literal> parameter (1.15.3) enables
+<link doc="../stream/ngx_stream_zone_sync_module.xml" id="zone_sync">synchronization</link>
+of the shared memory zone.
+<note>
+The <literal>sync</literal> parameter is available as part of our
+<commercial_version>commercial subscription</commercial_version>.
+</note>
+</para>
+
 </directive>
 
 </section>
--- a/xml/en/docs/http/ngx_http_status_module.xml
+++ b/xml/en/docs/http/ngx_http_status_module.xml
@@ -9,7 +9,7 @@
 <module name="Module ngx_http_status_module"
         link="/en/docs/http/ngx_http_status_module.html"
         lang="en"
-        rev="17">
+        rev="18">
 
 <section id="summary">
 
@@ -17,16 +17,12 @@
 The <literal>ngx_http_status_module</literal> module provides
 access to various status information.
 <note>
-This module was superseded by the
+This module was available as part of our
+<commercial_version>commercial subscription</commercial_version>
+until 1.13.10.
+It was superseded by the
 <link doc="ngx_http_api_module.xml">ngx_http_api_module</link> module
-in 1.13.0.
-</note>
-</para>
-
-<para>
-<note>
-This module is available as part of our
-<commercial_version>commercial subscription</commercial_version>.
+in 1.13.3.
 </note>
 </para>
 
--- a/xml/en/docs/http/ngx_http_upstream_conf_module.xml
+++ b/xml/en/docs/http/ngx_http_upstream_conf_module.xml
@@ -9,7 +9,7 @@
 <module name="Module ngx_http_upstream_conf_module"
         link="/en/docs/http/ngx_http_upstream_conf_module.html"
         lang="en"
-        rev="5">
+        rev="6">
 
 <section id="summary">
 
@@ -23,14 +23,13 @@ or
 <link doc="../stream/ngx_stream_upstream_module.xml" id="zone">stream</link>
 server group must reside in the shared memory.
 <note>
-This module was superseded by the
+This module was available as part of our
+<commercial_version>commercial subscription</commercial_version>
+until 1.13.10.
+It was superseded by the
 <link doc="ngx_http_api_module.xml">ngx_http_api_module</link> module
 in 1.13.3.
 </note>
-<note>
-This module is available as part of our
-<commercial_version>commercial subscription</commercial_version>.
-</note>
 </para>
 
 </section>
--- a/xml/en/docs/http/ngx_http_upstream_module.xml
+++ b/xml/en/docs/http/ngx_http_upstream_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_upstream_module"
         link="/en/docs/http/ngx_http_upstream_module.html"
         lang="en"
-        rev="75">
+        rev="76">
 
 <section id="summary">
 
@@ -856,6 +856,19 @@ which passes a request to a server
 with the least number of active connections.
 </para>
 
+<para id="random_least_time">
+The <literal>least_time</literal> method passes a request to a server
+with the least average response time and least number of active connections.
+If <literal>least_time=header</literal> is specified, the time to receive the
+<link id="var_upstream_header_time">response header</link> is used.
+If <literal>least_time=last_byte</literal> is specified, the time to receive the
+<link id="var_upstream_response_time">full response</link> is used.
+<note>
+The <literal>least_time</literal> method is available as a part of our
+<commercial_version>commercial subscription</commercial_version>.
+</note>
+</para>
+
 </directive>
 
 
--- a/xml/en/docs/stream/ngx_stream_keyval_module.xml
+++ b/xml/en/docs/stream/ngx_stream_keyval_module.xml
@@ -9,7 +9,7 @@
 <module name="Module ngx_stream_keyval_module"
         link="/en/docs/stream/ngx_stream_keyval_module.html"
         lang="en"
-        rev="2">
+        rev="3">
 
 <section id="summary">
 
@@ -85,7 +85,9 @@ specified by the <literal>zone</literal>
 <directive name="keyval_zone">
 <syntax>
     <literal>zone</literal>=<value>name</value>:<value>size</value>
-    [<literal>state</literal>=<value>file</value>]</syntax>
+    [<literal>state</literal>=<value>file</value>]
+    [<literal>timeout</literal>=<value>time</value>]
+    [<literal>sync</literal>]</syntax>
 <default/>
 <context>stream</context>
 
@@ -96,12 +98,25 @@ Key-value pairs are managed by the
 <link doc="../http/ngx_http_api_module.xml" id="stream_keyvals_">API</link>.
 </para>
 
-<para>
+<para id="keyval_state">
 The optional <literal>state</literal> parameter specifies a <value>file</value>
 that keeps the current state of the key-value database in the JSON format
 and makes it persistent across nginx restarts.
 </para>
 
+<para id="keyval_timeout">
+The optional <literal>timeout</literal> parameter (1.15.0) sets
+the time after which key-value pairs are removed from the zone.
+</para>
+
+<para id="keyval_sync">
+The optional <literal>sync</literal> parameter (1.15.0) enables
+<link doc="ngx_stream_zone_sync_module.xml" id="zone_sync">synchronization</link>
+of the shared memory zone.
+The synchronization requires the
+<link id="keyval_timeout">timeout</link> parameter to be set.
+</para>
+
 </directive>
 
 </section>
--- a/xml/en/docs/stream/ngx_stream_upstream_module.xml
+++ b/xml/en/docs/stream/ngx_stream_upstream_module.xml
@@ -9,7 +9,7 @@
 <module name="Module ngx_stream_upstream_module"
         link="/en/docs/stream/ngx_stream_upstream_module.html"
         lang="en"
-        rev="31">
+        rev="32">
 
 <section id="summary">
 
@@ -525,6 +525,25 @@ which passes a connection to a server
 with the least number of active connections.
 </para>
 
+<para id="random_least_time">
+The <literal>least_time</literal> method passes a connection to a server
+with the least average time and least number of active connections.
+If <literal>least_time=connect</literal> parameter is specified,
+time to
+<link id="var_upstream_connect_time">connect</link>
+to the upstream server is used.
+If <literal>least_time=first_byte</literal> parameter is specified,
+time to receive the
+<link id="var_upstream_first_byte_time">first byte</link> of data is used.
+If <literal>least_time=last_byte</literal> is specified,
+time to receive the
+<link id="var_upstream_session_time">last byte</link> of data is used.
+<note>
+The <literal>least_time</literal> method is available as a part of our
+<commercial_version>commercial subscription</commercial_version>.
+</note>
+</para>
+
 </directive>
 
 </section>
--- a/xml/en/docs/stream/ngx_stream_zone_sync_module.xml
+++ b/xml/en/docs/stream/ngx_stream_zone_sync_module.xml
@@ -9,7 +9,7 @@
 <module name="Module ngx_stream_zone_sync_module"
         link="/en/docs/stream/ngx_stream_zone_sync_module.html"
         lang="en"
-        rev="2">
+        rev="3">
 
 <section id="summary">
 
@@ -20,9 +20,13 @@ provides the necessary support for synch
 between nodes of a cluster.
 To enable synchronization for a particular zone, a corresponding module
 must support this feature.
-Currently, it is possible to synchronize
+Currently, it is possible to synchronize HTTP
 <link doc="../http/ngx_http_upstream_module.xml" id="sticky">sticky</link>
-sessions.
+sessions, information about
+<link doc="../http/ngx_http_limit_req_module.xml">excessive HTTP requests</link>,
+and key-value pairs both in
+<link doc="../http/ngx_http_keyval_module.xml">http</link>
+and <link doc="../stream/ngx_stream_keyval_module.xml">stream</link>.
 </para>
 
 <para>
--- a/xml/ru/docs/http/ngx_http_limit_req_module.xml
+++ b/xml/ru/docs/http/ngx_http_limit_req_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_limit_req_module"
         link="/ru/docs/http/ngx_http_limit_req_module.html"
         lang="ru"
-        rev="8">
+        rev="9">
 
 <section id="summary">
 
@@ -160,7 +160,8 @@ server {
 <syntax>
     <value>ключ</value>
     <literal>zone</literal>=<value>название</value>:<value>размер</value>
-    <literal>rate</literal>=<value>скорость</value></syntax>
+    <literal>rate</literal>=<value>скорость</value>
+    [<literal>sync</literal>]</syntax>
 <default/>
 <context>http</context>
 
@@ -210,6 +211,16 @@ 64 байтам на 32-битных платформах и 128 байтам на 64-битных платформах.
 ползапроса в секунду — это 30r/m.
 </para>
 
+<para id="limit_req_zone_sync">
+Параметр <literal>sync</literal> (1.15.3) разрешает
+<link doc="../stream/ngx_stream_zone_sync_module.xml" id="zone_sync">синхронизацию</link>
+данной зоны разделяемой памяти.
+<note>
+Параметр <literal>sync</literal> доступен как часть
+<commercial_version>коммерческой подписки</commercial_version>.
+</note>
+</para>
+
 </directive>
 
 </section>
--- a/xml/ru/docs/http/ngx_http_status_module.xml
+++ b/xml/ru/docs/http/ngx_http_status_module.xml
@@ -9,7 +9,7 @@
 <module name="Модуль ngx_http_status_module"
         link="/ru/docs/http/ngx_http_status_module.html"
         lang="ru"
-        rev="17">
+        rev="18">
 
 <section id="summary">
 
@@ -17,16 +17,12 @@
 Модуль <literal>ngx_http_status_module</literal> предоставляет
 доступ к информации о состоянии сервера.
 <note>
-Этот модуль был заменён модулем
+Этот модуль был доступен как часть
+<commercial_version>коммерческой подписки</commercial_version>
+до версии 1.13.10.
+Модуль был заменён модулем
 <link doc="ngx_http_api_module.xml">ngx_http_api_module</link>
-в версии 1.13.0.
-</note>
-</para>
-
-<para>
-<note>
-Модуль доступен как часть
-<commercial_version>коммерческой подписки</commercial_version>.
+в версии 1.13.3.
 </note>
 </para>
 
--- a/xml/ru/docs/http/ngx_http_upstream_conf_module.xml
+++ b/xml/ru/docs/http/ngx_http_upstream_conf_module.xml
@@ -9,7 +9,7 @@
 <module name="Модуль ngx_http_upstream_conf_module"
         link="/ru/docs/http/ngx_http_upstream_conf_module.html"
         lang="ru"
-        rev="5">
+        rev="6">
 
 <section id="summary">
 
@@ -23,14 +23,13 @@
 <link doc="../stream/ngx_stream_upstream_module.xml" id="zone">stream</link>
 должна находиться в разделяемой памяти.
 <note>
-Этот модуль был заменён модулем
+Этот модуль был доступен как часть
+<commercial_version>коммерческой подписки</commercial_version>
+до версии 1.13.10.
+Модуль был заменён модулем
 <link doc="ngx_http_api_module.xml">ngx_http_api_module</link>
 в версии 1.13.3.
 </note>
-<note>
-Модуль доступен как часть
-<commercial_version>коммерческой подписки</commercial_version>.
-</note>
 </para>
 
 </section>
--- a/xml/ru/docs/http/ngx_http_upstream_module.xml
+++ b/xml/ru/docs/http/ngx_http_upstream_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_upstream_module"
         link="/ru/docs/http/ngx_http_upstream_module.html"
         lang="ru"
-        rev="75">
+        rev="76">
 
 <section id="summary">
 
@@ -864,6 +864,19 @@ server {
 с наименьшим количеством активных соединений.
 </para>
 
+<para id="random_least_time">
+Если указан метод <literal>least_time</literal>, то запрос передаётся серверу
+с наименьшими средним временем ответа и числом активных соединений.
+Если указан <literal>least_time=header</literal>, то учитывается
+время получения <link id="var_upstream_header_time">заголовка ответа</link>.
+Если указан <literal>least_time=last_byte</literal>, то учитывается
+время получения <link id="var_upstream_response_time">всего ответа</link>.
+<note>
+Метод <literal>least_time</literal> доступен как часть
+<commercial_version>коммерческой подписки</commercial_version>.
+</note>
+</para>
+
 </directive>
 
 
--- a/xml/ru/docs/stream/ngx_stream_upstream_module.xml
+++ b/xml/ru/docs/stream/ngx_stream_upstream_module.xml
@@ -9,7 +9,7 @@
 <module name="Модуль ngx_stream_upstream_module"
         link="/ru/docs/stream/ngx_stream_upstream_module.html"
         lang="ru"
-        rev="31">
+        rev="32">
 
 <section id="summary">
 
@@ -483,7 +483,7 @@ hash $remote_addr;
 <link id="var_upstream_first_byte_time">первого байта</link> данных.
 Если указан параметр <literal>last_byte</literal>,
 то учитывается время получения
-<link id="var_upstream_session_time">ответа</link>.
+<link id="var_upstream_session_time">последнего байта</link> данных.
 Если указан параметр <literal>inflight</literal> (1.11.6),
 то также учитываются незавершённые соединения.
 <note>
@@ -525,6 +525,25 @@ hash $remote_addr;
 с наименьшим количеством активных соединений.
 </para>
 
+<para id="random_least_time">
+Если указан метод <literal>least_time</literal>, то соединение передаётся
+серверу
+с наименьшими средним временем ответа и числом активных соединений.
+Если указан <literal>least_time=connect</literal>,
+то учитывается время
+<link id="var_upstream_connect_time">соединения</link> с сервером группы.
+Если указан <literal>least_time=first_byte</literal>,
+то учитывается время получения
+<link id="var_upstream_first_byte_time">первого байта</link> данных.
+Если указан <literal>least_time=last_byte</literal>,
+то учитывается время получения
+<link id="var_upstream_session_time">последнего байта</link> данных.
+<note>
+Метод <literal>least_time</literal> доступен как часть
+<commercial_version>коммерческой подписки</commercial_version>.
+</note>
+</para>
+
 </directive>
 
 </section>