nginx-site: xml/en/docs/http/ngx_http_status

annotate xml/en/docs/http/ngx_http_status_module.xml @ 1120:99ae1c12c99e

Status: documented "revalidated" cache status field.

author	Sergey Kandaurov <pluknet@nginx.com>
date	Mon, 13 Jan 2014 21:10:23 +0400
parents	379cb572a7ec
children	1594ed379f1f

rev	line source
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1 <?xml version="1.0"?>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3 <!--
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	4 Copyright (C) Nginx, Inc.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	5 -->
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	6
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	8
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	9 <module name="Module ngx_http_status_module"
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	10 link="/en/docs/http/ngx_http_status_module.html"
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	11 lang="en"
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	12 rev="1">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	13
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	14 <section id="summary">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	15
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	16 <para>
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 965 diff changeset	17 The <literal>ngx_http_status_module</literal> module provides
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	18 access to various status information.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	19 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	20
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	21 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	22 <note>
1088 379cb572a7ec Paraphrased sentences that mention "commercial subscription". Ruslan Ermilov <ru@nginx.com> parents: 1027 diff changeset	23 This module is available as part of our <commercial_version/>.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	24 </note>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	25 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	26
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	27 </section>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	28
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	29
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	30 <section id="example" name="Example Configuration">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	31
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	32 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	33 <example>
1027 dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	34 server {
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	35 location = /status {
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	36 status;
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	37 }
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	38
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	39 status_zone example_server;
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	40 }
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	41 </example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	42 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	43
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	44 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	45 The simple monitoring page is shipped with this distribution,
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	46 accessible as “<literal>/status.html</literal>” in the default configuration.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	47 It requires the location “<literal>/status</literal>” to be configured
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	48 as shown above.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	49 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	50
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	51 </section>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	52
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	53
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	54 <section id="directives" name="Directives">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	55
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	56 <directive name="status">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	57 <syntax/>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	58 <default/>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	59 <context>location</context>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	60
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	61 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	62 The status information will be accessible from the surrounding location.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	63 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	64
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	65 </directive>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	66
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	67
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	68 <directive name="status_format">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	69 <syntax><literal>json</literal></syntax>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	70 <syntax><literal>jsonp</literal> [<value>callback</value>]</syntax>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	71 <default>json</default>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	72 <context>http</context>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	73 <context>server</context>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	74 <context>location</context>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	75
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	76 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	77 By default, status information is output in the JSON format.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	78 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	79
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	80 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	81 Alternatively, data may be output as JSONP.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	82 The <value>callback</value> parameter specifies the name of a callback function.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	83 The value can contain variables.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	84 If parameter is omitted, or the computed value is an empty string,
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	85 then “<literal>ngx_status_jsonp_callback</literal>” is used.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	86 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	87
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	88 </directive>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	89
1027 dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	90
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	91 <directive name="status_zone">
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	92 <syntax><value>zone</value></syntax>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	93 <default/>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	94 <context>server</context>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	95
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	96 <para>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	97 Enables collection of virtual
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	98 <link doc="ngx_http_core_module.xml" id="server"/>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	99 status information in the specified <value>zone</value>.
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	100 Several virtual servers may share the same zone.
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	101 </para>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	102
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	103 </directive>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	104
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	105 </section>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	106
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	107
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	108 <section id="data" name="Data">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	109
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	110 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	111 The following status information is provided:
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	112 <list type="tag">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	113
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	114 <tag-name><literal>version</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	115 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	116 Version of the provided data set.
1027 dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	117 The current version is 2.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	118 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	119
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	120 <tag-name><literal>nginx_version</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	121 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	122 Version of nginx.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	123 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	124
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	125 <tag-name><literal>address</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	126 <tag-desc>
1027 dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	127 The address of the server that accepted status request.
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	128 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	129
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	130 <tag-name><literal>load_timestamp</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	131 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	132 Time of the last reload of configuration, in milliseconds since Epoch.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	133 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	134
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	135 <tag-name><literal>timestamp</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	136 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	137 Current time in milliseconds since Epoch.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	138 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	139
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	140 <tag-name><literal>connections</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	141 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	142 <list type="tag">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	143
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	144 <tag-name><literal>accepted</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	145 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	146 The total number of accepted client connections.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	147 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	148
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	149 <tag-name><literal>dropped</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	150 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	151 The total number of dropped client connections.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	152 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	153
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	154 <tag-name><literal>active</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	155 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	156 The current number of active client connections.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	157 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	158
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	159 <tag-name><literal>idle</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	160 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	161 The current number of idle client connections.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	162 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	163
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	164 </list>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	165 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	166
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	167 <tag-name><literal>requests</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	168 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	169 <list type="tag">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	170
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	171 <tag-name><literal>total</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	172 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	173 The total number of client requests.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	174 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	175
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	176 <tag-name><literal>current</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	177 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	178 The current number of client requests.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	179 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	180
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	181 </list>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	182 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	183
1027 dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	184 <tag-name><literal>server_zones</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	185 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	186 For each <link id="status_zone"/>:
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	187 <list type="tag">
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	188
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	189 <tag-name><literal>processing</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	190 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	191 The number of
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	192 client requests that are currently being processed.
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	193 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	194
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	195 <tag-name><literal>requests</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	196 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	197 The total number of
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	198 client requests received from clients.
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	199 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	200
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	201 <tag-name><literal>responses</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	202 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	203 <list type="tag">
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	204
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	205 <tag-name><literal>total</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	206 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	207 The total number of
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	208 responses sent to clients.
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	209 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	210
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	211 <tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	212 <literal>1xx</literal>,
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	213 <literal>2xx</literal>,
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	214 <literal>3xx</literal>,
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	215 <literal>4xx</literal>,
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	216 <literal>5xx</literal>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	217 </tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	218 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	219 The number of responses with status codes 1xx, 2xx, 3xx, 4xx, and 5xx.
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	220 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	221
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	222 </list>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	223 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	224
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	225 <tag-name><literal>received</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	226 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	227 The total number of bytes received from clients.
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	228 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	229
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	230 <tag-name><literal>sent</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	231 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	232 The total number of bytes sent to clients.
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	233 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	234
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	235 </list>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	236 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	237
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	238 <tag-name><literal>upstreams</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	239 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	240 For each
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	241 <link doc="ngx_http_upstream_module.xml" id="server"/>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	242 in the
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	243 <link doc="ngx_http_upstream_module.xml" id="zone">dynamically
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	244 configurable</link>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	245 <link doc="ngx_http_upstream_module.xml" id="upstream">group</link>,
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	246 the following data are provided:
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	247 <list type="tag">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	248
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	249 <tag-name><literal>server</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	250 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	251 An address of the
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	252 <link doc="ngx_http_upstream_module.xml" id="server"/>.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	253 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	254
967 81717ad0a9c9 Status: documented "backup" field. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	255 <tag-name><literal>backup</literal></tag-name>
81717ad0a9c9 Status: documented "backup" field. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	256 <tag-desc>
1027 dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	257 A boolean value indicating whether the “cache loader” process is still loading
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	258 data from disk into the cache.
967 81717ad0a9c9 Status: documented "backup" field. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	259 </tag-desc>
81717ad0a9c9 Status: documented "backup" field. Andrei Belov <defan@nginx.com> parents: 966 diff changeset	260
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	261 <tag-name><literal>weight</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	262 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	263 Weight of the
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	264 <link doc="ngx_http_upstream_module.xml" id="server"/>.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	265 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	266
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	267 <tag-name><literal>state</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	268 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	269 Current state, which may be one of
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	270 “<literal>up</literal>”,
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	271 “<literal>down</literal>”,
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	272 “<literal>unavail</literal>”,
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	273 or
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	274 “<literal>unhealthy</literal>”.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	275 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	276
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	277 <tag-name><literal>active</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	278 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	279 The current number of active connections.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	280 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	281
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	282 <tag-name><literal>keepalive</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	283 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	284 The current number of
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	285 idle <link doc="ngx_http_upstream_module.xml" id="keepalive"/> connections.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	286 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	287
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	288 <tag-name><literal>requests</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	289 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	290 The total number of
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	291 client requests forwarded to this server.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	292 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	293
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	294 <tag-name><literal>responses</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	295 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	296 <list type="tag">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	297
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	298 <tag-name><literal>total</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	299 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	300 The total number of
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	301 responses obtained from this server.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	302 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	303
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	304 <tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	305 <literal>1xx</literal>,
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	306 <literal>2xx</literal>,
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	307 <literal>3xx</literal>,
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	308 <literal>4xx</literal>,
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	309 <literal>5xx</literal>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	310 </tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	311 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	312 The number of responses with status codes 1xx, 2xx, 3xx, 4xx, and 5xx.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	313 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	314
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	315 </list>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	316 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	317
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	318 <tag-name><literal>sent</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	319 <tag-desc>
1027 dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	320 The total number of bytes sent to this server.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	321 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	322
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	323 <tag-name><literal>received</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	324 <tag-desc>
1027 dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	325 The total number of bytes received from this server.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	326 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	327
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	328 <tag-name><literal>fails</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	329 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	330 The total number of
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	331 unsuccessful attempts to communicate with the server.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	332 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	333
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	334 <tag-name><literal>unavail</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	335 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	336 How many times
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	337 the server became unavailable for client requests
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	338 (state “<literal>unavail</literal>”)
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	339 due to the number of unsuccessful attempts reaching
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	340 the <literal>max_fails</literal> threshold.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	341 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	342
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	343 <tag-name><literal>health_checks</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	344 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	345 <list type="tag">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	346
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	347 <tag-name><literal>checks</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	348 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	349 The total number of
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	350 <link doc="ngx_http_upstream_module.xml" id="health_check">health check</link>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	351 requests made.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	352 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	353
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	354 <tag-name><literal>fails</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	355 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	356 The number of failed health checks.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	357 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	358
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	359 <tag-name><literal>unhealthy</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	360 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	361 How many times
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	362 the server became unhealthy (state “<literal>unhealthy</literal>”).
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	363 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	364
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	365 <tag-name><literal>last_passed</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	366 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	367 Boolean indicating
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	368 if the last health check request was successful and passed
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	369 <link doc="ngx_http_upstream_module.xml" id="match">tests</link>.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	370 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	371
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	372 </list>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	373 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	374
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	375 <tag-name><literal>downtime</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	376 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	377 Total time
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	378 the server was in the “<literal>unavail</literal>”
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	379 and “<literal>unhealthy</literal>” states.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	380 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	381
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	382 <tag-name><literal>downstart</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	383 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	384 The time (in milliseconds since Epoch)
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	385 when the server became
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	386 “<literal>unavail</literal>”
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	387 or “<literal>unhealthy</literal>”.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	388 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	389
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	390 </list>
965 fadccc156188 Status: fixed indentation. Andrei Belov <defan@nginx.com> parents: 953 diff changeset	391 </tag-desc>
fadccc156188 Status: fixed indentation. Andrei Belov <defan@nginx.com> parents: 953 diff changeset	392
1027 dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	393 <tag-name><literal>caches</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	394 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	395 For each cache (configured by
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	396 <link doc="ngx_http_proxy_module.xml" id="proxy_cache_path"/> and the likes):
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	397 <list type="tag">
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	398
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	399 <tag-name><literal>size</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	400 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	401 The current size of the cache.
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	402 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	403
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	404 <tag-name><literal>max_size</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	405 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	406 The limit on the maximum size of the cache specified in the configuration.
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	407 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	408
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	409 <tag-name><literal>cold</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	410 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	411 Boolean indicating if “cache loader” is still loading data into the cache.
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	412 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	413
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	414 <tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	415 <literal>hits</literal>,
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	416 <literal>stale</literal>,
1120 99ae1c12c99e Status: documented "revalidated" cache status field. Sergey Kandaurov <pluknet@nginx.com> parents: 1088 diff changeset	417 <literal>updating</literal>,
99ae1c12c99e Status: documented "revalidated" cache status field. Sergey Kandaurov <pluknet@nginx.com> parents: 1088 diff changeset	418 <literal>revalidated</literal>
1027 dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	419 </tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	420 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	421 <list type="tag">
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	422
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	423 <tag-name><literal>responses</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	424 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	425 The total number of responses read from the cache (hits, or stale responses
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	426 due to <link doc="ngx_http_proxy_module.xml" id="proxy_cache_use_stale"/>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	427 and the likes).
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	428 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	429
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	430 <tag-name><literal>bytes</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	431 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	432 The total number of bytes read from the cache.
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	433 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	434
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	435 </list>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	436 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	437
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	438 <tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	439 <literal>miss</literal>,
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	440 <literal>expired</literal>,
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	441 <literal>bypass</literal>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	442 </tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	443 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	444 <list type="tag">
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	445
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	446 <tag-name><literal>responses</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	447 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	448 The total number of responses not taken from the cache (misses, expires, or
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	449 bypasses due to
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	450 <link doc="ngx_http_proxy_module.xml" id="proxy_cache_bypass"/>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	451 and the likes).
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	452 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	453
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	454 <tag-name><literal>bytes</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	455 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	456 The total number of bytes read from the proxied server.
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	457 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	458
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	459 <tag-name><literal>responses_written</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	460 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	461 The total number of responses written to the cache.
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	462 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	463
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	464 <tag-name><literal>bytes_written</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	465 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	466 The total number of bytes written to the cache.
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	467 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	468
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	469 </list>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	470 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	471
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	472 </list>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	473 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp. Ruslan Ermilov <ru@nginx.com> parents: 967 diff changeset	474
965 fadccc156188 Status: fixed indentation. Andrei Belov <defan@nginx.com> parents: 953 diff changeset	475 </list>
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	476 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	477
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	478 </section>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	479
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	480 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/http/ngx_http_status_module.xml @ 1120:99ae1c12c99e