annotate xml/en/docs/http/ngx_http_status_module.xml @ 1493:9faa78768252

Documented the "reuseport" option of the "listen" directive.
author Yaroslav Zhuravlev <yar@nginx.com>
date Mon, 25 May 2015 20:48:34 +0300
parents f5b5eefc43cb
children d876f94135ac
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"
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
12 rev="6">
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>
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
35 http {
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
36 upstream <emphasis>backend</emphasis> {
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
37 <emphasis>zone</emphasis> http_backend 64k;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
38
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
39 server backend1.example.com weight=5;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
40 server backend2.example.com;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
41 }
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
42
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
43 proxy_cache_path /data/nginx/cache_backend keys_zone=<emphasis>cache_backend</emphasis>:10m;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
44
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
45 server {
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
46 server_name backend.example.com;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
47
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
48 location / {
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
49 proxy_pass http://backend;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
50 proxy_cache cache_backend;
1258
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
51
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
52 health_check;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
53 }
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
54
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
55 <emphasis>status_zone server_backend;</emphasis>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
56 }
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
57
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
58 server {
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
59 listen 127.0.0.1;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
60
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
61 location /upstream_conf {
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
62 upstream_conf;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
63 }
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
64
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
65 location /status {
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
66 status;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
67 }
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
68
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
69 location = /status.html {
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
70 }
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
71 }
1258
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
72 }
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
73
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
74 stream {
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
75 upstream <emphasis>backend</emphasis> {
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
76 <emphasis>zone</emphasis> stream_backend 64k;
1258
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
77
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
78 server backend1.example.com:12345 weight=5;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
79 server backend2.example.com:12345;
1258
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
80 }
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
81
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
82 server {
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
83 listen 127.0.0.1:12345;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
84 proxy_pass backend;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
85 <emphasis>status_zone server_backend;</emphasis>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
86 health_check;
1258
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
87 }
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
88 }
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
89 </example>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
90 </para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
91
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
92 <para>
1258
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
93 Examples of status requests with this configuration:
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
94 <example>
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
95 http://127.0.0.1/status
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
96 http://127.0.0.1/status/nginx_version
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
97 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
98 http://127.0.0.1/status/upstreams
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
99 http://127.0.0.1/status/upstreams/backend
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
100 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
101 http://127.0.0.1/status/upstreams/backend/1/weight
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
102 http://127.0.0.1/status/stream
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
103 http://127.0.0.1/status/stream/upstreams
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
104 http://127.0.0.1/status/stream/upstreams/backend
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
105 http://127.0.0.1/status/stream/upstreams/backend/1
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
106 http://127.0.0.1/status/stream/upstreams/backend/1/weight
1258
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
107 </example>
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
108 </para>
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
109
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
110 <para>
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
111 The simple monitoring page is shipped with this distribution,
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
112 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
113 It requires the locations “<literal>/status</literal>” and
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
114 “<literal>/status.html</literal>” to be configured as shown above.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
115 </para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
116
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
117 </section>
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
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
120 <section id="directives" name="Directives">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
121
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
122 <directive name="status">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
123 <syntax/>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
124 <default/>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
125 <context>location</context>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
126
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
127 <para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
128 The status information will be accessible from the surrounding location.
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
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
133
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
134 <directive name="status_format">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
135 <syntax><literal>json</literal></syntax>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
136 <syntax><literal>jsonp</literal> [<value>callback</value>]</syntax>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
137 <default>json</default>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
138 <context>http</context>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
139 <context>server</context>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
140 <context>location</context>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
141
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
142 <para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
143 By default, status information is output in the JSON format.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
144 </para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
145
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
146 <para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
147 Alternatively, data may be output as JSONP.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
148 The <value>callback</value> parameter specifies the name of a callback function.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
149 The value can contain variables.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
150 If parameter is omitted, or the computed value is an empty string,
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
151 then “<literal>ngx_status_jsonp_callback</literal>” is used.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
152 </para>
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 </directive>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
155
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
156
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
157 <directive name="status_zone">
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
158 <syntax><value>zone</value></syntax>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
159 <default/>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
160 <context>server</context>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
161
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
162 <para>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
163 Enables collection of virtual
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
164 <link doc="ngx_http_core_module.xml" id="server">http</link>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
165 or
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
166 <link doc="../stream/ngx_stream_core_module.xml" id="server">stream</link>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
167 (1.7.11) server status information in the specified <value>zone</value>.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
168 Several servers may share the same zone.
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
169 </para>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
170
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
171 </directive>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
172
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
173 </section>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
174
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 <section id="data" name="Data">
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 <para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
179 The following status information is provided:
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
180 <list type="tag">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
181
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
182 <tag-name id="version"><literal>version</literal></tag-name>
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
183 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
184 Version of the provided data set.
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
185 The current version is 5.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
186 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
187
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
188 <tag-name><literal>nginx_version</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
189 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
190 Version of nginx.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
191 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
192
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
193 <tag-name><literal>address</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
194 <tag-desc>
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
195 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
196 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
197
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
198 <tag-name id="generation"><literal>generation</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
199 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
200 The total number of configuration
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
201 <link doc="../control.xml" id="reconfiguration">reloads</link>.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
202 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
203
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
204 <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
205 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
206 Time of the last reload of configuration, in milliseconds since Epoch.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
207 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
208
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
209 <tag-name><literal>timestamp</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
210 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
211 Current time in milliseconds since Epoch.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
212 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
213
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
214 <tag-name id="processes"><literal>processes</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
215 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
216 <list type="tag">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
217
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
218 <tag-name id="respawned"><literal>respawned</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
219 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
220 The total number of abnormally terminated and respawned
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
221 child processes.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
222 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
223
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
224 </list>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
225 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
226
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
227 <tag-name><literal>connections</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
228 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
229 <list type="tag">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
230
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
231 <tag-name><literal>accepted</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
232 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
233 The total number of accepted client connections.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
234 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
235
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
236 <tag-name><literal>dropped</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
237 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
238 The total number of dropped client connections.
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
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
241 <tag-name><literal>active</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
242 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
243 The current number of active client connections.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
244 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
245
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
246 <tag-name><literal>idle</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
247 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
248 The current number of idle client connections.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
249 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
250
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
251 </list>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
252 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
253
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
254 <tag-name><literal>requests</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
255 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
256 <list type="tag">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
257
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
258 <tag-name><literal>total</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
259 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
260 The total number of client requests.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
261 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
262
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
263 <tag-name><literal>current</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
264 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
265 The current number of client requests.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
266 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
267
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
268 </list>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
269 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
270
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
271 <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
272 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
273 For each <link id="status_zone"/>:
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
274 <list type="tag">
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
275
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
276 <tag-name><literal>processing</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
277 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
278 The number of
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
279 client requests that are currently being processed.
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
280 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
281
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
282 <tag-name><literal>requests</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
283 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
284 The total number of
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
285 client requests received from clients.
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
286 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
287
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
288 <tag-name><literal>responses</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
289 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
290 <list type="tag">
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
291
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
292 <tag-name><literal>total</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
293 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
294 The total number of
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
295 responses sent to clients.
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
296 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
297
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
298 <tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
299 <literal>1xx</literal>,
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
300 <literal>2xx</literal>,
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
301 <literal>3xx</literal>,
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
302 <literal>4xx</literal>,
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
303 <literal>5xx</literal>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
304 </tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
305 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
306 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
307 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
308
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
309 </list>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
310 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
311
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
312 <tag-name><literal>received</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
313 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
314 The total number of bytes received from clients.
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
315 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
316
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
317 <tag-name><literal>sent</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
318 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
319 The total number of bytes sent to clients.
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
320 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
321
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
322 </list>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
323 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
324
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
325 <tag-name id="upstreams"><literal>upstreams</literal></tag-name>
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 For each
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
328 <link doc="ngx_http_upstream_module.xml" id="server"/>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
329 in the
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
330 <link doc="ngx_http_upstream_module.xml" id="zone">dynamically
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
331 configurable</link>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
332 <link doc="ngx_http_upstream_module.xml" id="upstream">group</link>,
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
333 the following data are provided:
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
334 <list type="tag">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
335
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
336 <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
337 <tag-desc>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
338 The ID of the server.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
339 </tag-desc>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
340
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
341 <tag-name><literal>server</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
342 <tag-desc>
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
343 An
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
344 <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
345 of the server.
953
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
967
81717ad0a9c9 Status: documented "backup" field.
Andrei Belov <defan@nginx.com>
parents: 966
diff changeset
348 <tag-name><literal>backup</literal></tag-name>
81717ad0a9c9 Status: documented "backup" field.
Andrei Belov <defan@nginx.com>
parents: 966
diff changeset
349 <tag-desc>
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
350 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
351 <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
352 server.
967
81717ad0a9c9 Status: documented "backup" field.
Andrei Belov <defan@nginx.com>
parents: 966
diff changeset
353 </tag-desc>
81717ad0a9c9 Status: documented "backup" field.
Andrei Belov <defan@nginx.com>
parents: 966
diff changeset
354
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
355 <tag-name><literal>weight</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
356 <tag-desc>
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
357 <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
358 of the server.
953
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
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
361 <tag-name id="state"><literal>state</literal></tag-name>
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
362 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
363 Current state, which may be one of
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
364 “<literal>up</literal>”,
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
365 “<literal>draining</literal>”,
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
366 “<literal>down</literal>”,
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
367 “<literal>unavail</literal>”,
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
368 or
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
369 “<literal>unhealthy</literal>”.
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 <tag-name><literal>active</literal></tag-name>
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 The current number of active connections.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
375 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
376
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
377 <!--
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
378 <tag-name><literal>keepalive</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
379 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
380 The current number of
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
381 idle <link doc="ngx_http_upstream_module.xml" id="keepalive"/> connections.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
382 </tag-desc>
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
383 -->
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
384
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
385 <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
386 <tag-desc>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
387 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
388 for the server.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
389 </tag-desc>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
390
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
391 <tag-name><literal>requests</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 The total number of
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
394 client requests forwarded to this server.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
395 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
396
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
397 <tag-name><literal>responses</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
398 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
399 <list type="tag">
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>total</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 The total number of
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
404 responses obtained from this server.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
405 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
406
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
407 <tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
408 <literal>1xx</literal>,
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
409 <literal>2xx</literal>,
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
410 <literal>3xx</literal>,
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
411 <literal>4xx</literal>,
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
412 <literal>5xx</literal>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
413 </tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
414 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
415 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
416 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
417
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
418 </list>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
419 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
420
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
421 <tag-name><literal>sent</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
422 <tag-desc>
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
423 The total number of bytes sent to this server.
953
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
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
426 <tag-name><literal>received</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
427 <tag-desc>
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
428 The total number of bytes received from this server.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
429 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
430
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
431 <tag-name><literal>fails</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
432 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
433 The total number of
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
434 unsuccessful attempts to communicate with the server.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
435 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
436
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
437 <tag-name><literal>unavail</literal></tag-name>
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 How many times
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
440 the server became unavailable for client requests
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
441 (state “<literal>unavail</literal>”)
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
442 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
443 <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
444 threshold.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
445 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
446
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
447 <tag-name><literal>health_checks</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
448 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
449 <list type="tag">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
450
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
451 <tag-name><literal>checks</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
452 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
453 The total number of
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
454 <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
455 requests made.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
456 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
457
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
458 <tag-name><literal>fails</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
459 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
460 The number of failed health checks.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
461 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
462
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
463 <tag-name><literal>unhealthy</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
464 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
465 How many times
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
466 the server became unhealthy (state “<literal>unhealthy</literal>”).
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
467 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
468
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
469 <tag-name><literal>last_passed</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
470 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
471 Boolean indicating
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
472 if the last health check request was successful and passed
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
473 <link doc="ngx_http_upstream_module.xml" id="match">tests</link>.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
474 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
475
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
476 </list>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
477 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
478
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
479 <tag-name><literal>downtime</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
480 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
481 Total time
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
482 the server was in the “<literal>unavail</literal>”
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
483 and “<literal>unhealthy</literal>” states.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
484 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
485
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
486 <tag-name><literal>downstart</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
487 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
488 The time (in milliseconds since Epoch)
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
489 when the server became
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
490 “<literal>unavail</literal>”
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
491 or “<literal>unhealthy</literal>”.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
492 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
493
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
494 <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
495 <tag-desc>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
496 The time (in milliseconds since Epoch)
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
497 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
498 </tag-desc>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
499
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
500 <tag-name id="header_time"><literal>header_time</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
501 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
502 The average time to get the
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
503 <link doc="ngx_http_upstream_module.xml" id="var_upstream_header_time">response
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
504 header</link> from the server (1.7.10).
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
505 The field is available when using the
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
506 <link doc="ngx_http_upstream_module.xml" id="least_time"/>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
507 load balancing method.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
508 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
509
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
510 <tag-name id="response_time"><literal>response_time</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
511 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
512 The average time to get the
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
513 <link doc="ngx_http_upstream_module.xml" id="var_upstream_response_time">full
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
514 response</link> from the server (1.7.10).
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
515 The field is available when using the
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
516 <link doc="ngx_http_upstream_module.xml" id="least_time"/>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
517 load balancing method.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
518 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
519
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
520 </list>
965
fadccc156188 Status: fixed indentation.
Andrei Belov <defan@nginx.com>
parents: 953
diff changeset
521 </tag-desc>
fadccc156188 Status: fixed indentation.
Andrei Belov <defan@nginx.com>
parents: 953
diff changeset
522
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
523 <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
524 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
525 For each cache (configured by
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
526 <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
527 <list type="tag">
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>size</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 current size of 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 <tag-name><literal>max_size</literal></tag-name>
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 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
537 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
538
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
539 <tag-name><literal>cold</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
540 <tag-desc>
1198
59099cb4b16f Status: fixed "backup" description broken in dd64ce140de2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1128
diff changeset
541 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
542 data from disk into the cache.
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
543 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
544
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
545 <tag-name>
1284
d3548b46b87f Typo fixed.
Andrei Belov <defan@nginx.com>
parents: 1258
diff changeset
546 <literal>hit</literal>,
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
547 <literal>stale</literal>,
1120
99ae1c12c99e Status: documented "revalidated" cache status field.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1088
diff changeset
548 <literal>updating</literal>,
99ae1c12c99e Status: documented "revalidated" cache status field.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1088
diff changeset
549 <literal>revalidated</literal>
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
550 </tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
551 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
552 <list type="tag">
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
553
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
554 <tag-name><literal>responses</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
555 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
556 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
557 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
558 and the likes).
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
559 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
560
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
561 <tag-name><literal>bytes</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
562 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
563 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
564 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
565
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
566 </list>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
567 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
568
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
569 <tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
570 <literal>miss</literal>,
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
571 <literal>expired</literal>,
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
572 <literal>bypass</literal>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
573 </tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
574 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
575 <list type="tag">
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
576
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
577 <tag-name><literal>responses</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
578 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
579 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
580 bypasses due to
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
581 <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
582 and the likes).
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
583 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
584
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
585 <tag-name><literal>bytes</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
586 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
587 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
588 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
589
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
590 <tag-name><literal>responses_written</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
591 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
592 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
593 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
594
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
595 <tag-name><literal>bytes_written</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
596 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
597 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
598 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
599
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
600 </list>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
601 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
602
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
603 </list>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
604 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
605
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
606 <tag-name id="stream"><literal>stream</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
607 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
608
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
609 <list type="tag">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
610 <tag-name><literal>server_zones</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
611 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
612 For each <link id="status_zone"/>:
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
613 <list type="tag">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
614
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
615 <tag-name><literal>processing</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
616 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
617 The number of
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
618 client connections that are currently being processed.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
619 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
620
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
621 <tag-name><literal>connections</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
622 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
623 The total number of
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
624 connections accepted from clients.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
625 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
626
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
627 <tag-name><literal>received</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
628 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
629 The total number of bytes received from clients.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
630 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
631
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
632 <tag-name><literal>sent</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
633 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
634 The total number of bytes sent to clients.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
635 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
636
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
637 </list>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
638 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
639
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
640 <tag-name><literal>upstreams</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
641 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
642 For each
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
643 <link doc="../stream/ngx_stream_upstream_module.xml" id="server"/>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
644 in the
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
645 <link doc="../stream/ngx_stream_upstream_module.xml" id="zone">dynamically
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
646 configurable</link>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
647 <link doc="../stream/ngx_stream_upstream_module.xml" id="upstream">group</link>,
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
648 the following data are provided:
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
649 <list type="tag">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
650
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
651 <tag-name><literal>id</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
652 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
653 The ID of the server.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
654 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
655
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
656 <tag-name><literal>server</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
657 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
658 An
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
659 <link doc="../stream/ngx_stream_upstream_module.xml" id="server">address</link>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
660 of the server.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
661 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
662
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
663 <tag-name><literal>backup</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
664 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
665 A boolean value indicating whether the server is a
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
666 <link doc="../stream/ngx_stream_upstream_module.xml" id="backup"/>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
667 server.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
668 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
669
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
670 <tag-name><literal>weight</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
671 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
672 <link doc="../stream/ngx_stream_upstream_module.xml" id="weight">Weight</link>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
673 of the server.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
674 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
675
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
676 <tag-name><literal>state</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
677 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
678 Current state, which may be one of
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
679 “<literal>up</literal>”,
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
680 “<literal>down</literal>”,
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
681 “<literal>unavail</literal>”,
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
682 or
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
683 “<literal>unhealthy</literal>”.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
684 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
685
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
686 <tag-name><literal>active</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
687 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
688 The current number of connections.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
689 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
690
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
691 <tag-name><literal>connections</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
692 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
693 The total number of
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
694 client connections forwarded to this server.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
695 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
696
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
697 <tag-name><literal>connect_time</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
698 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
699 The average time to connect to the upstream server.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
700 The field is available when using the
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
701 <link doc="../stream/ngx_stream_upstream_module.xml" id="least_time"/>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
702 load balancing method.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
703 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
704
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
705 <tag-name><literal>first_byte_time</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
706 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
707 The average time to receive the first byte of data.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
708 The field is available when using the
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
709 <link doc="../stream/ngx_stream_upstream_module.xml" id="least_time"/>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
710 load balancing method.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
711 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
712
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
713 <tag-name><literal>response_time</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
714 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
715 The average time to receive the last byte of data.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
716 The field is available when using the
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
717 <link doc="../stream/ngx_stream_upstream_module.xml" id="least_time"/>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
718 load balancing method.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
719 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
720
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
721 <tag-name><literal>sent</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
722 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
723 The total number of bytes sent to this server.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
724 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
725
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
726 <tag-name><literal>received</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
727 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
728 The total number of bytes received from this server.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
729 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
730
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
731 <tag-name><literal>fails</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
732 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
733 The total number of
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
734 unsuccessful attempts to communicate with the server.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
735 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
736
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
737 <tag-name><literal>unavail</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
738 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
739 How many times
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
740 the server became unavailable for client connections
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
741 (state “<literal>unavail</literal>”)
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
742 due to the number of unsuccessful attempts reaching the
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
743 <link doc="../stream/ngx_stream_upstream_module.xml" id="max_fails"/>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
744 threshold.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
745 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
746
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
747 <tag-name><literal>health_checks</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
748 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
749 <list type="tag">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
750
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
751 <tag-name><literal>checks</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
752 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
753 The total number of
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
754 <link doc="../stream/ngx_stream_upstream_module.xml" id="health_check">health check</link>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
755 requests made.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
756 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
757
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
758 <tag-name><literal>fails</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
759 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
760 The number of failed health checks.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
761 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
762
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
763 <tag-name><literal>unhealthy</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
764 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
765 How many times
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
766 the server became unhealthy (state “<literal>unhealthy</literal>”).
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
767 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
768
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
769 <tag-name><literal>last_passed</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
770 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
771 Boolean indicating
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
772 if the last health check request was successful and passed
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
773 <link doc="../stream/ngx_stream_upstream_module.xml" id="match">tests</link>.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
774 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
775
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
776 </list>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
777 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
778
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
779 <tag-name><literal>downtime</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
780 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
781 Total time
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
782 the server was in the “<literal>unavail</literal>”
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
783 and “<literal>unhealthy</literal>” states.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
784 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
785
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
786 <tag-name><literal>downstart</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
787 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
788 The time (in milliseconds since Epoch)
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
789 when the server became
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
790 “<literal>unavail</literal>”
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
791 or “<literal>unhealthy</literal>”.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
792 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
793
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
794 <tag-name><literal>selected</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
795 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
796 The time (in milliseconds since Epoch)
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
797 when the server was last selected to process a connection.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
798 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
799
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
800 </list>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
801 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
802
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
803 </list>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
804 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
805
965
fadccc156188 Status: fixed indentation.
Andrei Belov <defan@nginx.com>
parents: 953
diff changeset
806 </list>
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
807 </para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
808
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
809 </section>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
810
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
811 <section id="compatibility" name="Compatibility">
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
812
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
813 <para>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
814 <list type="bullet">
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
815
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
816 <listitem>
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
817 The <literal>keepalive</literal> field of an upstream server
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
818 was removed in <link id="version"/> 5.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
819 </listitem>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
820
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
821 <listitem>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
822 The <link id="stream">stream</link> status data
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
823 were added in <link id="version"/> 5.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
824 </listitem>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
825
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
826 <listitem>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
827 The
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
828 <link id="generation"/> field
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
829 was added in <link id="version"/> 5.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
830 </listitem>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
831
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
832 <listitem>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
833 The
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
834 <link id="respawned"/> field in
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
835 <link id="processes"/>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
836 was added in <link id="version"/> 5.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
837 </listitem>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
838
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
839 <listitem>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
840 The
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
841 <link id="header_time"/> and <link id="response_time"/> fields in
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
842 <link id="upstreams"/>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
843 were added in <link id="version"/> 5.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
844 </listitem>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
845
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
846 <listitem>
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
847 The
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
848 <link id="selected"/> field in
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
849 <link id="upstreams"/>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
850 was added in <link id="version"/> 4.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
851 </listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
852
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
853 <listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
854 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
855 <link id="upstreams"/>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
856 was added in <link id="version"/> 4.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
857 </listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
858
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
859 <listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
860 The
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
861 <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
862 <link id="upstreams"/>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
863 were added in <link id="version"/> 3.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
864 </listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
865
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
866 <listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
867 The <literal>revalidated</literal> field in
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
868 <link id="caches"/>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
869 was added in <link id="version"/> 3.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
870 </listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
871
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
872 <listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
873 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
874 and <link id="load_timestamp"/> status data
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
875 were added in <link id="version"/> 2.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
876 </listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
877
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
878 </list>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
879 </para>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
880
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
881 </section>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
882
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
883 </module>