annotate 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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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"
1284
d3548b46b87f Typo fixed.
Andrei Belov <defan@nginx.com>
parents: 1258
diff changeset
12 rev="4">
953
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>
1128
1594ed379f1f De-i18n'ed <commercial_version/>.
Ruslan Ermilov <ru@nginx.com>
parents: 1120
diff changeset
23 This module is available as part of our
1594ed379f1f De-i18n'ed <commercial_version/>.
Ruslan Ermilov <ru@nginx.com>
parents: 1120
diff changeset
24 <commercial_version>commercial subscription</commercial_version>.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
25 </note>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
26 </para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
27
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
28 </section>
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
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
31 <section id="example" name="Example Configuration">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
32
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
33 <para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
34 <example>
1258
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
35 upstream <emphasis>backend</emphasis> {
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
36 <emphasis>zone</emphasis> upstream_backend 64k;
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
37
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
38 server backend1.example.com weight=5;
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
39 server backend2.example.com;
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
40 }
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
41
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
42 proxy_cache_path /data/nginx/cache_backend keys_zone=<emphasis>cache_backend</emphasis>:10m;
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
43
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
44 server {
1258
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
45 server_name backend.example.com;
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
46
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
47 location / {
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
48 proxy_pass http://backend;
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
49 proxy_cache cache_backend;
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
50
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
51 health_check;
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
52 }
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
53
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
54 <emphasis>status_zone server_backend;</emphasis>
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
55 }
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
56
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
57 server {
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
58 listen 127.0.0.1;
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
59
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
60 location /upstream_conf {
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
61 upstream_conf;
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
62 }
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
63
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
64 location /status {
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
65 status;
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
66 }
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
67
1258
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
68 location = /status.html {
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
69 }
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
70 }
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
71 </example>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
72 </para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
73
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
74 <para>
1258
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
75 Examples of status requests with this configuration:
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
76 <example>
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
77 http://127.0.0.1/status
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
78 http://127.0.0.1/status/nginx_version
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
79 http://127.0.0.1/status/caches/cache_backend
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
80 http://127.0.0.1/status/upstreams
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
81 http://127.0.0.1/status/upstreams/backend
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
82 http://127.0.0.1/status/upstreams/backend/1
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
83 http://127.0.0.1/status/upstreams/backend/1/weight
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
84 </example>
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
85 </para>
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
86
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
87 <para>
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
88 The simple monitoring page is shipped with this distribution,
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
89 accessible as “<literal>/status.html</literal>” in the default configuration.
1258
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
90 It requires the locations “<literal>/status</literal>” and
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
91 “<literal>/status.html</literal>” to be configured as shown above.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
92 </para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
93
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
94 </section>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
95
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
96
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
97 <section id="directives" name="Directives">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
98
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
99 <directive name="status">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
100 <syntax/>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
101 <default/>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
102 <context>location</context>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
103
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
104 <para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
105 The status information will be accessible from the surrounding location.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
106 </para>
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 </directive>
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
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
111 <directive name="status_format">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
112 <syntax><literal>json</literal></syntax>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
113 <syntax><literal>jsonp</literal> [<value>callback</value>]</syntax>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
114 <default>json</default>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
115 <context>http</context>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
116 <context>server</context>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
117 <context>location</context>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
118
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
119 <para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
120 By default, status information is output in the JSON format.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
121 </para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
122
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
123 <para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
124 Alternatively, data may be output as JSONP.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
125 The <value>callback</value> parameter specifies the name of a callback function.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
126 The value can contain variables.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
127 If parameter is omitted, or the computed value is an empty string,
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
128 then “<literal>ngx_status_jsonp_callback</literal>” is used.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
129 </para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
130
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
131 </directive>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
132
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
133
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
134 <directive name="status_zone">
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
135 <syntax><value>zone</value></syntax>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
136 <default/>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
137 <context>server</context>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
138
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
139 <para>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
140 Enables collection of virtual
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
141 <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
142 status information in the specified <value>zone</value>.
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
143 Several virtual servers may share the same zone.
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
144 </para>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
145
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
146 </directive>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
147
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
148 </section>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
149
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
150
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
151 <section id="data" name="Data">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
152
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
153 <para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
154 The following status information is provided:
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
155 <list type="tag">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
156
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
157 <tag-name id="version"><literal>version</literal></tag-name>
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
158 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
159 Version of the provided data set.
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
160 The current version is 4.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
161 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
162
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
163 <tag-name><literal>nginx_version</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
164 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
165 Version of nginx.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
166 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
167
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
168 <tag-name><literal>address</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
169 <tag-desc>
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
170 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
171 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
172
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
173 <tag-name id="load_timestamp"><literal>load_timestamp</literal></tag-name>
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
174 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
175 Time of the last reload of configuration, in milliseconds since Epoch.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
176 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
177
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
178 <tag-name><literal>timestamp</literal></tag-name>
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 Current time in milliseconds since Epoch.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
181 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
182
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
183 <tag-name><literal>connections</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
184 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
185 <list type="tag">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
186
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
187 <tag-name><literal>accepted</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
188 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
189 The total number of accepted client connections.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
190 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
191
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
192 <tag-name><literal>dropped</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
193 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
194 The total number of dropped client connections.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
195 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
196
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
197 <tag-name><literal>active</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
198 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
199 The current number of active client connections.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
200 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
201
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
202 <tag-name><literal>idle</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
203 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
204 The current number of idle client connections.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
205 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
206
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
207 </list>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
208 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
209
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
210 <tag-name><literal>requests</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
211 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
212 <list type="tag">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
213
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
214 <tag-name><literal>total</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
215 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
216 The total number of client requests.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
217 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
218
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
219 <tag-name><literal>current</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
220 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
221 The current number of client requests.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
222 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
223
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
224 </list>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
225 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
226
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
227 <tag-name id="server_zones"><literal>server_zones</literal></tag-name>
1027
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 For each <link id="status_zone"/>:
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
230 <list type="tag">
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
231
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
232 <tag-name><literal>processing</literal></tag-name>
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 The number of
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
235 client requests that are currently being processed.
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
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
238 <tag-name><literal>requests</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
239 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
240 The total number of
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
241 client requests received from clients.
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
242 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
243
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
244 <tag-name><literal>responses</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
245 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
246 <list type="tag">
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
247
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
248 <tag-name><literal>total</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
249 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
250 The total number of
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
251 responses sent to clients.
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
252 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
253
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
254 <tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
255 <literal>1xx</literal>,
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
256 <literal>2xx</literal>,
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
257 <literal>3xx</literal>,
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
258 <literal>4xx</literal>,
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
259 <literal>5xx</literal>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
260 </tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
261 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
262 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
263 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
264
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
265 </list>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
266 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
267
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
268 <tag-name><literal>received</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
269 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
270 The total number of bytes received from clients.
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
271 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
272
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
273 <tag-name><literal>sent</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
274 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
275 The total number of bytes sent to clients.
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
276 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
277
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
278 </list>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
279 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
280
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
281 <tag-name id="upstreams"><literal>upstreams</literal></tag-name>
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
282 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
283 For each
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
284 <link doc="ngx_http_upstream_module.xml" id="server"/>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
285 in the
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
286 <link doc="ngx_http_upstream_module.xml" id="zone">dynamically
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
287 configurable</link>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
288 <link doc="ngx_http_upstream_module.xml" id="upstream">group</link>,
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
289 the following data are provided:
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
290 <list type="tag">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
291
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
292 <tag-name id="id"><literal>id</literal></tag-name>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
293 <tag-desc>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
294 The ID of the server.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
295 </tag-desc>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
296
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
297 <tag-name><literal>server</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
298 <tag-desc>
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
299 An
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
300 <link doc="ngx_http_upstream_module.xml" id="server">address</link>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
301 of the server.
953
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
967
81717ad0a9c9 Status: documented "backup" field.
Andrei Belov <defan@nginx.com>
parents: 966
diff changeset
304 <tag-name><literal>backup</literal></tag-name>
81717ad0a9c9 Status: documented "backup" field.
Andrei Belov <defan@nginx.com>
parents: 966
diff changeset
305 <tag-desc>
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
306 A boolean value indicating whether the server is a
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
307 <link doc="ngx_http_upstream_module.xml" id="backup"/>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
308 server.
967
81717ad0a9c9 Status: documented "backup" field.
Andrei Belov <defan@nginx.com>
parents: 966
diff changeset
309 </tag-desc>
81717ad0a9c9 Status: documented "backup" field.
Andrei Belov <defan@nginx.com>
parents: 966
diff changeset
310
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
311 <tag-name><literal>weight</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
312 <tag-desc>
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
313 <link doc="ngx_http_upstream_module.xml" id="weight">Weight</link>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
314 of the server.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
315 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
316
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
317 <tag-name id="state"><literal>state</literal></tag-name>
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
318 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
319 Current state, which may be one of
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
320 “<literal>up</literal>”,
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
321 “<literal>draining</literal>”,
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
322 “<literal>down</literal>”,
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
323 “<literal>unavail</literal>”,
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
324 or
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
325 “<literal>unhealthy</literal>”.
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>active</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 current number of active connections.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
331 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
332
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
333 <tag-name><literal>keepalive</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
334 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
335 The current number of
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
336 idle <link doc="ngx_http_upstream_module.xml" id="keepalive"/> connections.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
337 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
338
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
339 <tag-name id="max_conns"><literal>max_conns</literal></tag-name>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
340 <tag-desc>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
341 The <link doc="ngx_http_upstream_module.xml" id="max_conns"/> limit
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
342 for the server.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
343 </tag-desc>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
344
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
345 <tag-name><literal>requests</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
346 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
347 The total number of
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
348 client requests forwarded to this server.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
349 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
350
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
351 <tag-name><literal>responses</literal></tag-name>
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 <list type="tag">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
354
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
355 <tag-name><literal>total</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
356 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
357 The total number of
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
358 responses obtained from this server.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
359 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
360
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
361 <tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
362 <literal>1xx</literal>,
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
363 <literal>2xx</literal>,
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
364 <literal>3xx</literal>,
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
365 <literal>4xx</literal>,
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
366 <literal>5xx</literal>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
367 </tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
368 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
369 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
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>sent</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
376 <tag-desc>
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
377 The total number of bytes sent to this server.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
378 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
379
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
380 <tag-name><literal>received</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
381 <tag-desc>
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
382 The total number of bytes received from this server.
953
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
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
385 <tag-name><literal>fails</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
386 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
387 The total number of
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
388 unsuccessful attempts to communicate with the server.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
389 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
390
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
391 <tag-name><literal>unavail</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
392 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
393 How many times
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
394 the server became unavailable for client requests
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
395 (state “<literal>unavail</literal>”)
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
396 due to the number of unsuccessful attempts reaching the
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
397 <link doc="ngx_http_upstream_module.xml" id="max_fails"/>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
398 threshold.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
399 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
400
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
401 <tag-name><literal>health_checks</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
402 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
403 <list type="tag">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
404
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
405 <tag-name><literal>checks</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
406 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
407 The total number of
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
408 <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
409 requests made.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
410 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
411
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
412 <tag-name><literal>fails</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
413 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
414 The number of failed health checks.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
415 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
416
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
417 <tag-name><literal>unhealthy</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
418 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
419 How many times
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
420 the server became unhealthy (state “<literal>unhealthy</literal>”).
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
421 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
422
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
423 <tag-name><literal>last_passed</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
424 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
425 Boolean indicating
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
426 if the last health check request was successful and passed
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
427 <link doc="ngx_http_upstream_module.xml" id="match">tests</link>.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
428 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
429
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
430 </list>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
431 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
432
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
433 <tag-name><literal>downtime</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
434 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
435 Total time
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
436 the server was in the “<literal>unavail</literal>”
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
437 and “<literal>unhealthy</literal>” states.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
438 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
439
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
440 <tag-name><literal>downstart</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
441 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
442 The time (in milliseconds since Epoch)
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
443 when the server became
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
444 “<literal>unavail</literal>”
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
445 or “<literal>unhealthy</literal>”.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
446 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
447
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
448 <tag-name id="selected"><literal>selected</literal></tag-name>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
449 <tag-desc>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
450 The time (in milliseconds since Epoch)
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
451 when the server was last selected to process a request (1.7.5).
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
452 </tag-desc>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
453
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
454 </list>
965
fadccc156188 Status: fixed indentation.
Andrei Belov <defan@nginx.com>
parents: 953
diff changeset
455 </tag-desc>
fadccc156188 Status: fixed indentation.
Andrei Belov <defan@nginx.com>
parents: 953
diff changeset
456
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
457 <tag-name id="caches"><literal>caches</literal></tag-name>
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
458 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
459 For each cache (configured by
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
460 <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
461 <list type="tag">
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
462
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
463 <tag-name><literal>size</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
464 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
465 The current size of the cache.
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
466 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
467
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
468 <tag-name><literal>max_size</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
469 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
470 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
471 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
472
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
473 <tag-name><literal>cold</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
474 <tag-desc>
1198
59099cb4b16f Status: fixed "backup" description broken in dd64ce140de2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1128
diff changeset
475 A boolean value indicating whether the “cache loader” process is still loading
59099cb4b16f Status: fixed "backup" description broken in dd64ce140de2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1128
diff changeset
476 data from disk into the cache.
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
477 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
478
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
479 <tag-name>
1284
d3548b46b87f Typo fixed.
Andrei Belov <defan@nginx.com>
parents: 1258
diff changeset
480 <literal>hit</literal>,
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
481 <literal>stale</literal>,
1120
99ae1c12c99e Status: documented "revalidated" cache status field.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1088
diff changeset
482 <literal>updating</literal>,
99ae1c12c99e Status: documented "revalidated" cache status field.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1088
diff changeset
483 <literal>revalidated</literal>
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
484 </tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
485 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
486 <list type="tag">
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
487
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
488 <tag-name><literal>responses</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
489 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
490 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
491 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
492 and the likes).
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
493 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
494
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
495 <tag-name><literal>bytes</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
496 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
497 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
498 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
499
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
500 </list>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
501 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
502
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
503 <tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
504 <literal>miss</literal>,
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
505 <literal>expired</literal>,
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
506 <literal>bypass</literal>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
507 </tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
508 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
509 <list type="tag">
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
510
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
511 <tag-name><literal>responses</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
512 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
513 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
514 bypasses due to
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
515 <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
516 and the likes).
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
517 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
518
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
519 <tag-name><literal>bytes</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
520 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
521 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
522 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
523
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
524 <tag-name><literal>responses_written</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
525 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
526 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
527 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
528
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
529 <tag-name><literal>bytes_written</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
530 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
531 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
532 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
533
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
534 </list>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
535 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
536
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
537 </list>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
538 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
539
965
fadccc156188 Status: fixed indentation.
Andrei Belov <defan@nginx.com>
parents: 953
diff changeset
540 </list>
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
541 </para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
542
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
543 </section>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
544
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
545 <section id="compatibility" name="Compatibility">
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
546
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
547 <para>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
548 <list type="bullet">
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
549
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
550 <listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
551 The
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
552 <link id="selected"/> field in
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
553 <link id="upstreams"/>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
554 was added in <link id="version"/> 4.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
555 </listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
556
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
557 <listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
558 The <link id="state">draining</link> state in
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
559 <link id="upstreams"/>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
560 was added in <link id="version"/> 4.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
561 </listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
562
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
563 <listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
564 The
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
565 <link id="id"/> and <link id="max_conns"/> fields in
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
566 <link id="upstreams"/>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
567 were added in <link id="version"/> 3.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
568 </listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
569
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
570 <listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
571 The <literal>revalidated</literal> field in
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
572 <link id="caches"/>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
573 was added in <link id="version"/> 3.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
574 </listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
575
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
576 <listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
577 The <link id="server_zones"/>, <link id="caches"/>,
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
578 and <link id="load_timestamp"/> status data
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
579 were added in <link id="version"/> 2.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
580 </listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
581
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
582 </list>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
583 </para>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
584
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
585 </section>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
586
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
587 </module>