diff xml/en/docs/http/ngx_http_status_module.xml @ 1367:f1e14d87d833

Updated commercial docs for the upcoming release.
author Ruslan Ermilov <ru@nginx.com>
date Mon, 01 Dec 2014 13:40:25 +0300
parents d3548b46b87f
children f5b5eefc43cb
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_status_module.xml	Mon Nov 24 06:38:21 2014 +0000
+++ b/xml/en/docs/http/ngx_http_status_module.xml	Mon Dec 01 13:40:25 2014 +0300
@@ -154,10 +154,10 @@
 The following status information is provided:
 <list type="tag">
 
-<tag-name><literal>version</literal></tag-name>
+<tag-name id="version"><literal>version</literal></tag-name>
 <tag-desc>
 Version of the provided data set.
-The current version is 2.
+The current version is 4.
 </tag-desc>
 
 <tag-name><literal>nginx_version</literal></tag-name>
@@ -170,7 +170,7 @@
 The address of the server that accepted status request.
 </tag-desc>
 
-<tag-name><literal>load_timestamp</literal></tag-name>
+<tag-name id="load_timestamp"><literal>load_timestamp</literal></tag-name>
 <tag-desc>
 Time of the last reload of configuration, in milliseconds since Epoch.
 </tag-desc>
@@ -224,7 +224,7 @@
 </list>
 </tag-desc>
 
-<tag-name><literal>server_zones</literal></tag-name>
+<tag-name id="server_zones"><literal>server_zones</literal></tag-name>
 <tag-desc>
 For each <link id="status_zone"/>:
 <list type="tag">
@@ -278,7 +278,7 @@
 </list>
 </tag-desc>
 
-<tag-name><literal>upstreams</literal></tag-name>
+<tag-name id="upstreams"><literal>upstreams</literal></tag-name>
 <tag-desc>
 For each
 <link doc="ngx_http_upstream_module.xml" id="server"/>
@@ -289,27 +289,36 @@
 the following data are provided:
 <list type="tag">
 
+<tag-name id="id"><literal>id</literal></tag-name>
+<tag-desc>
+The ID of the server.
+</tag-desc>
+
 <tag-name><literal>server</literal></tag-name>
 <tag-desc>
-An address of the
-<link doc="ngx_http_upstream_module.xml" id="server"/>.
+An
+<link doc="ngx_http_upstream_module.xml" id="server">address</link>
+of the server.
 </tag-desc>
 
 <tag-name><literal>backup</literal></tag-name>
 <tag-desc>
-A boolean value indicating whether the server is a backup server.
+A boolean value indicating whether the server is a
+<link doc="ngx_http_upstream_module.xml" id="backup"/>
+server.
 </tag-desc>
 
 <tag-name><literal>weight</literal></tag-name>
 <tag-desc>
-Weight of the
-<link doc="ngx_http_upstream_module.xml" id="server"/>.
+<link doc="ngx_http_upstream_module.xml" id="weight">Weight</link>
+of the server.
 </tag-desc>
 
-<tag-name><literal>state</literal></tag-name>
+<tag-name id="state"><literal>state</literal></tag-name>
 <tag-desc>
 Current state, which may be one of
 “<literal>up</literal>”,
+“<literal>draining</literal>”,
 “<literal>down</literal>”,
 “<literal>unavail</literal>”,
 or
@@ -327,6 +336,12 @@
 idle <link doc="ngx_http_upstream_module.xml" id="keepalive"/> connections.
 </tag-desc>
 
+<tag-name id="max_conns"><literal>max_conns</literal></tag-name>
+<tag-desc>
+The <link doc="ngx_http_upstream_module.xml" id="max_conns"/> limit
+for the server.
+</tag-desc>
+
 <tag-name><literal>requests</literal></tag-name>
 <tag-desc>
 The total number of
@@ -378,8 +393,9 @@
 How many times
 the server became unavailable for client requests
 (state “<literal>unavail</literal>”)
-due to the number of unsuccessful attempts reaching
-the <literal>max_fails</literal> threshold.
+due to the number of unsuccessful attempts reaching the
+<link doc="ngx_http_upstream_module.xml" id="max_fails"/>
+threshold.
 </tag-desc>
 
 <tag-name><literal>health_checks</literal></tag-name>
@@ -429,10 +445,16 @@
 or “<literal>unhealthy</literal>”.
 </tag-desc>
 
+<tag-name id="selected"><literal>selected</literal></tag-name>
+<tag-desc>
+The time (in milliseconds since Epoch)
+when the server was last selected to process a request (1.7.5).
+</tag-desc>
+
 </list>
 </tag-desc>
 
-<tag-name><literal>caches</literal></tag-name>
+<tag-name id="caches"><literal>caches</literal></tag-name>
 <tag-desc>
 For each cache (configured by
 <link doc="ngx_http_proxy_module.xml" id="proxy_cache_path"/> and the likes):
@@ -520,4 +542,46 @@
 
 </section>
 
+<section id="compatibility" name="Compatibility">
+
+<para>
+<list type="bullet">
+
+<listitem>
+The
+<link id="selected"/> field in
+<link id="upstreams"/>
+was added in <link id="version"/> 4.
+</listitem>
+
+<listitem>
+The <link id="state">draining</link> state in
+<link id="upstreams"/>
+was added in <link id="version"/> 4.
+</listitem>
+
+<listitem>
+The
+<link id="id"/> and <link id="max_conns"/> fields in
+<link id="upstreams"/>
+were added in <link id="version"/> 3.
+</listitem>
+
+<listitem>
+The <literal>revalidated</literal> field in
+<link id="caches"/>
+was added in <link id="version"/> 3.
+</listitem>
+
+<listitem>
+The <link id="server_zones"/>, <link id="caches"/>,
+and <link id="load_timestamp"/> status data
+were added in <link id="version"/> 2.
+</listitem>
+
+</list>
+</para>
+
+</section>
+
 </module>