Mercurial > hg > nginx-site
diff xml/en/docs/http/ngx_http_status_module.xml @ 1450:f5b5eefc43cb
Updated commercial docs for the upcoming release.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Thu, 09 Apr 2015 19:18:54 +0300 |
parents | f1e14d87d833 |
children | d876f94135ac |
line wrap: on
line diff
--- 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="4"> + rev="6"> <section id="summary"> @@ -32,40 +32,58 @@ This module is available as part of our <para> <example> -upstream <emphasis>backend</emphasis> { - <emphasis>zone</emphasis> upstream_backend 64k; +http { + upstream <emphasis>backend</emphasis> { + <emphasis>zone</emphasis> http_backend 64k; + + server backend1.example.com weight=5; + server backend2.example.com; + } + + proxy_cache_path /data/nginx/cache_backend keys_zone=<emphasis>cache_backend</emphasis>:10m; + + server { + server_name backend.example.com; + + location / { + proxy_pass http://backend; + proxy_cache cache_backend; - server backend1.example.com weight=5; - server backend2.example.com; + health_check; + } + + <emphasis>status_zone server_backend;</emphasis> + } + + server { + listen 127.0.0.1; + + location /upstream_conf { + upstream_conf; + } + + location /status { + status; + } + + location = /status.html { + } + } } -proxy_cache_path /data/nginx/cache_backend keys_zone=<emphasis>cache_backend</emphasis>:10m; - -server { - server_name backend.example.com; +stream { + upstream <emphasis>backend</emphasis> { + <emphasis>zone</emphasis> stream_backend 64k; - location / { - proxy_pass http://backend; - proxy_cache cache_backend; - - health_check; + server backend1.example.com:12345 weight=5; + server backend2.example.com:12345; } - <emphasis>status_zone server_backend;</emphasis> -} - -server { - listen 127.0.0.1; - - location /upstream_conf { - upstream_conf; - } - - location /status { - status; - } - - location = /status.html { + server { + listen 127.0.0.1:12345; + proxy_pass backend; + <emphasis>status_zone server_backend;</emphasis> + health_check; } } </example> @@ -81,6 +99,11 @@ http://127.0.0.1/status/upstreams http://127.0.0.1/status/upstreams/backend http://127.0.0.1/status/upstreams/backend/1 http://127.0.0.1/status/upstreams/backend/1/weight +http://127.0.0.1/status/stream +http://127.0.0.1/status/stream/upstreams +http://127.0.0.1/status/stream/upstreams/backend +http://127.0.0.1/status/stream/upstreams/backend/1 +http://127.0.0.1/status/stream/upstreams/backend/1/weight </example> </para> @@ -138,9 +161,11 @@ then “<literal>ngx_status_jsonp_callback</literal>” is used. <para> Enables collection of virtual -<link doc="ngx_http_core_module.xml" id="server"/> -status information in the specified <value>zone</value>. -Several virtual servers may share the same zone. +<link doc="ngx_http_core_module.xml" id="server">http</link> +or +<link doc="../stream/ngx_stream_core_module.xml" id="server">stream</link> +(1.7.11) server status information in the specified <value>zone</value>. +Several servers may share the same zone. </para> </directive> @@ -157,7 +182,7 @@ The following status information is prov <tag-name id="version"><literal>version</literal></tag-name> <tag-desc> Version of the provided data set. -The current version is 4. +The current version is 5. </tag-desc> <tag-name><literal>nginx_version</literal></tag-name> @@ -170,6 +195,12 @@ Version of nginx. The address of the server that accepted status request. </tag-desc> +<tag-name id="generation"><literal>generation</literal></tag-name> +<tag-desc> +The total number of configuration +<link doc="../control.xml" id="reconfiguration">reloads</link>. +</tag-desc> + <tag-name id="load_timestamp"><literal>load_timestamp</literal></tag-name> <tag-desc> Time of the last reload of configuration, in milliseconds since Epoch. @@ -180,6 +211,19 @@ Time of the last reload of configuration Current time in milliseconds since Epoch. </tag-desc> +<tag-name id="processes"><literal>processes</literal></tag-name> +<tag-desc> +<list type="tag"> + +<tag-name id="respawned"><literal>respawned</literal></tag-name> +<tag-desc> +The total number of abnormally terminated and respawned +child processes. +</tag-desc> + +</list> +</tag-desc> + <tag-name><literal>connections</literal></tag-name> <tag-desc> <list type="tag"> @@ -330,11 +374,13 @@ or The current number of active connections. </tag-desc> +<!-- <tag-name><literal>keepalive</literal></tag-name> <tag-desc> The current number of 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> @@ -451,6 +497,26 @@ The time (in milliseconds since Epoch) when the server was last selected to process a request (1.7.5). </tag-desc> +<tag-name id="header_time"><literal>header_time</literal></tag-name> +<tag-desc> +The average time to get the +<link doc="ngx_http_upstream_module.xml" id="var_upstream_header_time">response +header</link> from the server (1.7.10). +The field is available when using the +<link doc="ngx_http_upstream_module.xml" id="least_time"/> +load balancing method. +</tag-desc> + +<tag-name id="response_time"><literal>response_time</literal></tag-name> +<tag-desc> +The average time to get the +<link doc="ngx_http_upstream_module.xml" id="var_upstream_response_time">full +response</link> from the server (1.7.10). +The field is available when using the +<link doc="ngx_http_upstream_module.xml" id="least_time"/> +load balancing method. +</tag-desc> + </list> </tag-desc> @@ -537,6 +603,206 @@ The total number of bytes written to the </list> </tag-desc> +<tag-name id="stream"><literal>stream</literal></tag-name> +<tag-desc> + +<list type="tag"> +<tag-name><literal>server_zones</literal></tag-name> +<tag-desc> +For each <link id="status_zone"/>: +<list type="tag"> + +<tag-name><literal>processing</literal></tag-name> +<tag-desc> +The number of +client connections that are currently being processed. +</tag-desc> + +<tag-name><literal>connections</literal></tag-name> +<tag-desc> +The total number of +connections accepted from clients. +</tag-desc> + +<tag-name><literal>received</literal></tag-name> +<tag-desc> +The total number of bytes received from clients. +</tag-desc> + +<tag-name><literal>sent</literal></tag-name> +<tag-desc> +The total number of bytes sent to clients. +</tag-desc> + +</list> +</tag-desc> + +<tag-name><literal>upstreams</literal></tag-name> +<tag-desc> +For each +<link doc="../stream/ngx_stream_upstream_module.xml" id="server"/> +in the +<link doc="../stream/ngx_stream_upstream_module.xml" id="zone">dynamically +configurable</link> +<link doc="../stream/ngx_stream_upstream_module.xml" id="upstream">group</link>, +the following data are provided: +<list type="tag"> + +<tag-name><literal>id</literal></tag-name> +<tag-desc> +The ID of the server. +</tag-desc> + +<tag-name><literal>server</literal></tag-name> +<tag-desc> +An +<link doc="../stream/ngx_stream_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 +<link doc="../stream/ngx_stream_upstream_module.xml" id="backup"/> +server. +</tag-desc> + +<tag-name><literal>weight</literal></tag-name> +<tag-desc> +<link doc="../stream/ngx_stream_upstream_module.xml" id="weight">Weight</link> +of the server. +</tag-desc> + +<tag-name><literal>state</literal></tag-name> +<tag-desc> +Current state, which may be one of +“<literal>up</literal>”, +“<literal>down</literal>”, +“<literal>unavail</literal>”, +or +“<literal>unhealthy</literal>”. +</tag-desc> + +<tag-name><literal>active</literal></tag-name> +<tag-desc> +The current number of connections. +</tag-desc> + +<tag-name><literal>connections</literal></tag-name> +<tag-desc> +The total number of +client connections forwarded to this server. +</tag-desc> + +<tag-name><literal>connect_time</literal></tag-name> +<tag-desc> +The average time to connect to the upstream server. +The field is available when using the +<link doc="../stream/ngx_stream_upstream_module.xml" id="least_time"/> +load balancing method. +</tag-desc> + +<tag-name><literal>first_byte_time</literal></tag-name> +<tag-desc> +The average time to receive the first byte of data. +The field is available when using the +<link doc="../stream/ngx_stream_upstream_module.xml" id="least_time"/> +load balancing method. +</tag-desc> + +<tag-name><literal>response_time</literal></tag-name> +<tag-desc> +The average time to receive the last byte of data. +The field is available when using the +<link doc="../stream/ngx_stream_upstream_module.xml" id="least_time"/> +load balancing method. +</tag-desc> + +<tag-name><literal>sent</literal></tag-name> +<tag-desc> +The total number of bytes sent to this server. +</tag-desc> + +<tag-name><literal>received</literal></tag-name> +<tag-desc> +The total number of bytes received from this server. +</tag-desc> + +<tag-name><literal>fails</literal></tag-name> +<tag-desc> +The total number of +unsuccessful attempts to communicate with the server. +</tag-desc> + +<tag-name><literal>unavail</literal></tag-name> +<tag-desc> +How many times +the server became unavailable for client connections +(state “<literal>unavail</literal>”) +due to the number of unsuccessful attempts reaching the +<link doc="../stream/ngx_stream_upstream_module.xml" id="max_fails"/> +threshold. +</tag-desc> + +<tag-name><literal>health_checks</literal></tag-name> +<tag-desc> +<list type="tag"> + +<tag-name><literal>checks</literal></tag-name> +<tag-desc> +The total number of +<link doc="../stream/ngx_stream_upstream_module.xml" id="health_check">health check</link> +requests made. +</tag-desc> + +<tag-name><literal>fails</literal></tag-name> +<tag-desc> +The number of failed health checks. +</tag-desc> + +<tag-name><literal>unhealthy</literal></tag-name> +<tag-desc> +How many times +the server became unhealthy (state “<literal>unhealthy</literal>”). +</tag-desc> + +<tag-name><literal>last_passed</literal></tag-name> +<tag-desc> +Boolean indicating +if the last health check request was successful and passed +<link doc="../stream/ngx_stream_upstream_module.xml" id="match">tests</link>. +</tag-desc> + +</list> +</tag-desc> + +<tag-name><literal>downtime</literal></tag-name> +<tag-desc> +Total time +the server was in the “<literal>unavail</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>”. +</tag-desc> + +<tag-name><literal>selected</literal></tag-name> +<tag-desc> +The time (in milliseconds since Epoch) +when the server was last selected to process a connection. +</tag-desc> + +</list> +</tag-desc> + +</list> +</tag-desc> + </list> </para> @@ -548,6 +814,36 @@ The total number of bytes written to the <list type="bullet"> <listitem> +The <literal>keepalive</literal> field of an upstream server +was removed in <link id="version"/> 5. +</listitem> + +<listitem> +The <link id="stream">stream</link> status data +were added in <link id="version"/> 5. +</listitem> + +<listitem> +The +<link id="generation"/> field +was added in <link id="version"/> 5. +</listitem> + +<listitem> +The +<link id="respawned"/> field in +<link id="processes"/> +was added in <link id="version"/> 5. +</listitem> + +<listitem> +The +<link id="header_time"/> and <link id="response_time"/> fields in +<link id="upstreams"/> +were added in <link id="version"/> 5. +</listitem> + +<listitem> The <link id="selected"/> field in <link id="upstreams"/>