annotate xml/en/docs/http/ngx_http_status_module.xml @ 2028:5c55b7054b58

Updated docs for the upcoming NGINX Plus release.
author Ruslan Ermilov <ru@nginx.com>
date Sat, 26 Aug 2017 00:56:05 +0300
parents 6b6d0e844bf7
children 283b1e67eaa6
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"
2028
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1947
diff changeset
12 rev="17">
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.
2028
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1947
diff changeset
19 <note>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1947
diff changeset
20 This module was superseded by the
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1947
diff changeset
21 <link doc="ngx_http_api_module.xml">ngx_http_api_module</link> module
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1947
diff changeset
22 in 1.13.0.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1947
diff changeset
23 </note>
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
24 </para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
25
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 <note>
1128
1594ed379f1f De-i18n'ed <commercial_version/>.
Ruslan Ermilov <ru@nginx.com>
parents: 1120
diff changeset
28 This module is available as part of our
1594ed379f1f De-i18n'ed <commercial_version/>.
Ruslan Ermilov <ru@nginx.com>
parents: 1120
diff changeset
29 <commercial_version>commercial subscription</commercial_version>.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
30 </note>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
31 </para>
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 </section>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
34
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
35
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
36 <section id="example" name="Example Configuration">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
37
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
38 <para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
39 <example>
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
40 http {
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
41 upstream <emphasis>backend</emphasis> {
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
42 <emphasis>zone</emphasis> http_backend 64k;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
43
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
44 server backend1.example.com weight=5;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
45 server backend2.example.com;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
46 }
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 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
49
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
50 server {
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
51 server_name backend.example.com;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
52
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
53 location / {
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
54 proxy_pass http://backend;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
55 proxy_cache cache_backend;
1258
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
56
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
57 health_check;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
58 }
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
59
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
60 <emphasis>status_zone server_backend;</emphasis>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
61 }
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
62
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
63 server {
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
64 listen 127.0.0.1;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
65
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
66 location /upstream_conf {
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
67 upstream_conf;
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
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
70 location /status {
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
71 status;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
72 }
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
73
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
74 location = /status.html {
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
75 }
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
76 }
1258
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
77 }
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
78
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
79 stream {
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
80 upstream <emphasis>backend</emphasis> {
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
81 <emphasis>zone</emphasis> stream_backend 64k;
1258
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
82
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
83 server backend1.example.com:12345 weight=5;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
84 server backend2.example.com:12345;
1258
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
85 }
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
86
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
87 server {
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
88 listen 127.0.0.1:12345;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
89 proxy_pass backend;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
90 <emphasis>status_zone server_backend;</emphasis>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
91 health_check;
1258
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
92 }
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
93 }
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
94 </example>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
95 </para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
96
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
97 <para>
1258
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
98 Examples of status requests with this configuration:
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
99 <example>
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
100 http://127.0.0.1/status
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
101 http://127.0.0.1/status/nginx_version
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
102 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
103 http://127.0.0.1/status/upstreams
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
104 http://127.0.0.1/status/upstreams/backend
1617
69ff752dcb55 Corrected examples of status requests in the status module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1561
diff changeset
105 http://127.0.0.1/status/upstreams/backend/peers/1
69ff752dcb55 Corrected examples of status requests in the status module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1561
diff changeset
106 http://127.0.0.1/status/upstreams/backend/peers/1/weight
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
107 http://127.0.0.1/status/stream
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
108 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
109 http://127.0.0.1/status/stream/upstreams/backend
1617
69ff752dcb55 Corrected examples of status requests in the status module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1561
diff changeset
110 http://127.0.0.1/status/stream/upstreams/backend/peers/1
69ff752dcb55 Corrected examples of status requests in the status module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1561
diff changeset
111 http://127.0.0.1/status/stream/upstreams/backend/peers/1/weight
1258
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
112 </example>
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
113 </para>
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
114
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
115 <para>
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
116 The simple monitoring page is shipped with this distribution,
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
117 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
118 It requires the locations “<literal>/status</literal>” and
700487454cf2 Status: documented the query API implementation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1198
diff changeset
119 “<literal>/status.html</literal>” to be configured as shown above.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
120 </para>
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 </section>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
123
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
124
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
125 <section id="directives" name="Directives">
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 <directive name="status">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
128 <syntax/>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
129 <default/>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
130 <context>location</context>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
131
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
132 <para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
133 The status information will be accessible from the surrounding location.
1559
d876f94135ac Added info about limiting access to status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1450
diff changeset
134 Access to this location should be
d876f94135ac Added info about limiting access to status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1450
diff changeset
135 <link doc="ngx_http_core_module.xml" id="satisfy">limited</link>.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
136 </para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
137
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
138 </directive>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
139
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
140
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
141 <directive name="status_format">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
142 <syntax><literal>json</literal></syntax>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
143 <syntax><literal>jsonp</literal> [<value>callback</value>]</syntax>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
144 <default>json</default>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
145 <context>http</context>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
146 <context>server</context>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
147 <context>location</context>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
148
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
149 <para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
150 By default, status information is output in the JSON format.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
151 </para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
152
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
153 <para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
154 Alternatively, data may be output as JSONP.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
155 The <value>callback</value> parameter specifies the name of a callback function.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
156 The value can contain variables.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
157 If parameter is omitted, or the computed value is an empty string,
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
158 then “<literal>ngx_status_jsonp_callback</literal>” is used.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
159 </para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
160
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
161 </directive>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
162
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
163
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
164 <directive name="status_zone">
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
165 <syntax><value>zone</value></syntax>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
166 <default/>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
167 <context>server</context>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
168
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 Enables collection of virtual
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
171 <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
172 or
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
173 <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
174 (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
175 Several servers may share the same zone.
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
176 </para>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
177
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
178 </directive>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
179
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
180 </section>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
181
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
182
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
183 <section id="data" name="Data">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
184
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
185 <para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
186 The following status information is provided:
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
187 <list type="tag">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
188
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
189 <tag-name id="version"><literal>version</literal></tag-name>
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
190 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
191 Version of the provided data set.
1925
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
192 The current version is 8.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
193 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
194
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
195 <tag-name><literal>nginx_version</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
196 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
197 Version of nginx.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
198 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
199
1925
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
200 <tag-name id="nginx_build"><literal>nginx_build</literal></tag-name>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
201 <tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
202 Name of nginx build.
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
203 </tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
204
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
205 <tag-name><literal>address</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
206 <tag-desc>
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
207 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
208 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
209
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
210 <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
211 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
212 The total number of configuration
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
213 <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
214 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
215
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
216 <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
217 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
218 Time of the last reload of configuration, in milliseconds since Epoch.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
219 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
220
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
221 <tag-name><literal>timestamp</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
222 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
223 Current time in milliseconds since Epoch.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
224 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
225
1561
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
226 <tag-name id="pid"><literal>pid</literal></tag-name>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
227 <tag-desc>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
228 The ID of the worker process that handled status request.
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
229 </tag-desc>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
230
1925
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
231 <tag-name id="ppid"><literal>ppid</literal></tag-name>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
232 <tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
233 The ID of the master process that started
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
234 the <link id="pid">worker process</link>.
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
235 </tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
236
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
237 <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
238 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
239 <list type="tag">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
240
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
241 <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
242 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
243 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
244 child processes.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
245 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
246
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
247 </list>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
248 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
249
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
250 <tag-name><literal>connections</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
251 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
252 <list type="tag">
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>accepted</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 The total number of accepted client connections.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
257 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
258
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
259 <tag-name><literal>dropped</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
260 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
261 The total number of dropped client connections.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
262 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
263
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
264 <tag-name><literal>active</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
265 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
266 The current number of active client connections.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
267 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
268
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
269 <tag-name><literal>idle</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
270 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
271 The current number of idle client connections.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
272 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
273
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
274 </list>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
275 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
276
1561
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
277 <tag-name id="ssl"><literal>ssl</literal></tag-name>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
278 <tag-desc>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
279 <list type="tag">
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
280
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
281 <tag-name><literal>handshakes</literal></tag-name>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
282 <tag-desc>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
283 The total number of successful SSL handshakes.
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
284 </tag-desc>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
285
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
286 <tag-name><literal>handshakes_failed</literal></tag-name>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
287 <tag-desc>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
288 The total number of failed SSL handshakes.
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
289 </tag-desc>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
290
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
291 <tag-name><literal>session_reuses</literal></tag-name>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
292 <tag-desc>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
293 The total number of session reuses during SSL handshake.
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
294 </tag-desc>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
295
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
296 </list>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
297 </tag-desc>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
298
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
299 <tag-name><literal>requests</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
300 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
301 <list type="tag">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
302
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
303 <tag-name><literal>total</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
304 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
305 The total number of client requests.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
306 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
307
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
308 <tag-name><literal>current</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
309 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
310 The current number of client requests.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
311 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
312
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
313 </list>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
314 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
315
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
316 <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
317 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
318 For each <link id="status_zone"/>:
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
319 <list type="tag">
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
320
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
321 <tag-name><literal>processing</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
322 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
323 The number of
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
324 client requests that are currently being processed.
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
325 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
326
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
327 <tag-name><literal>requests</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
328 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
329 The total number of
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
330 client requests received from clients.
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
331 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
332
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
333 <tag-name><literal>responses</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
334 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
335 <list type="tag">
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
336
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
337 <tag-name><literal>total</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
338 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
339 The total number of
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
340 responses sent to clients.
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
341 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
342
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
343 <tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
344 <literal>1xx</literal>,
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
345 <literal>2xx</literal>,
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
346 <literal>3xx</literal>,
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
347 <literal>4xx</literal>,
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
348 <literal>5xx</literal>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
349 </tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
350 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
351 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
352 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
353
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
354 </list>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
355 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
356
1561
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
357 <tag-name id="discarded"><literal>discarded</literal></tag-name>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
358 <tag-desc>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
359 The total number of requests completed without sending a response.
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
360 </tag-desc>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
361
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
362 <tag-name><literal>received</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
363 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
364 The total number of bytes received from clients.
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
365 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
366
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
367 <tag-name><literal>sent</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
368 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
369 The total number of bytes sent to clients.
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
370 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
371
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
372 </list>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
373 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
374
1925
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
375 <tag-name id="slabs"><literal>slabs</literal></tag-name>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
376 <tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
377 For each shared memory zone that uses slab allocator:
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
378 <list type="tag">
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
379
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
380 <tag-name><literal>pages</literal></tag-name>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
381 <tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
382 <list type="tag">
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
383
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
384 <tag-name><literal>used</literal></tag-name>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
385 <tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
386 The current number of used memory pages.
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
387 </tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
388
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
389 <tag-name><literal>free</literal></tag-name>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
390 <tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
391 The current number of free memory pages.
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
392 </tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
393
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
394 </list>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
395 </tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
396
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
397 <tag-name><literal>slots</literal></tag-name>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
398 <tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
399 For each memory slot size (8, 16, 32, 64, 128, etc.)
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
400 the following data are provided:
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
401 <list type="tag">
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
402
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
403 <tag-name><literal>used</literal></tag-name>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
404 <tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
405 The current number of used memory slots.
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
406 </tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
407
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
408 <tag-name><literal>free</literal></tag-name>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
409 <tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
410 The current number of free memory slots.
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
411 </tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
412
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
413 <tag-name><literal>reqs</literal></tag-name>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
414 <tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
415 The total number of attempts to allocate memory of specified size.
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
416 </tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
417
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
418 <tag-name><literal>fails</literal></tag-name>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
419 <tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
420 The number of unsuccessful attempts to allocate memory of specified size.
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
421 </tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
422
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
423 </list>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
424 </tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
425
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
426 </list>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
427 </tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
428
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
429 <tag-name id="upstreams"><literal>upstreams</literal></tag-name>
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
430 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
431 For each
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
432 <link doc="ngx_http_upstream_module.xml" id="zone">dynamically
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
433 configurable</link>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
434 <link doc="ngx_http_upstream_module.xml" id="upstream">group</link>,
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
435 the following data are provided:
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
436 <list type="tag">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
437
1561
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
438 <tag-name id="peers"><literal>peers</literal></tag-name>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
439 <tag-desc>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
440 For each
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
441 <link doc="ngx_http_upstream_module.xml" id="server"/>,
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
442 the following data are provided:
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
443 <list type="tag">
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
444
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
445 <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
446 <tag-desc>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
447 The ID of the server.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
448 </tag-desc>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
449
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
450 <tag-name><literal>server</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
451 <tag-desc>
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
452 An
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
453 <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
454 of the server.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
455 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
456
1925
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
457 <tag-name id="name"><literal>name</literal></tag-name>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
458 <tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
459 The name of the server specified in the
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
460 <link doc="ngx_http_upstream_module.xml" id="server"/>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
461 directive.
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
462 </tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
463
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
464 <tag-name id="service"><literal>service</literal></tag-name>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
465 <tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
466 The <link doc="ngx_http_upstream_module.xml" id="service"/>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
467 parameter value of the
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
468 <link doc="ngx_http_upstream_module.xml" id="server"/> directive.
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
469 </tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
470
967
81717ad0a9c9 Status: documented "backup" field.
Andrei Belov <defan@nginx.com>
parents: 966
diff changeset
471 <tag-name><literal>backup</literal></tag-name>
81717ad0a9c9 Status: documented "backup" field.
Andrei Belov <defan@nginx.com>
parents: 966
diff changeset
472 <tag-desc>
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
473 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
474 <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
475 server.
967
81717ad0a9c9 Status: documented "backup" field.
Andrei Belov <defan@nginx.com>
parents: 966
diff changeset
476 </tag-desc>
81717ad0a9c9 Status: documented "backup" field.
Andrei Belov <defan@nginx.com>
parents: 966
diff changeset
477
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
478 <tag-name><literal>weight</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
479 <tag-desc>
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
480 <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
481 of the server.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
482 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
483
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
484 <tag-name id="state"><literal>state</literal></tag-name>
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
485 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
486 Current state, which may be one of
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
487 “<literal>up</literal>”,
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
488 “<literal>draining</literal>”,
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
489 “<literal>down</literal>”,
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
490 “<literal>unavail</literal>”,
1925
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
491 “<literal>checking</literal>”,
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
492 or
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
493 “<literal>unhealthy</literal>”.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
494 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
495
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
496 <tag-name><literal>active</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
497 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
498 The current number of active connections.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
499 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
500
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
501 <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
502 <tag-desc>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
503 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
504 for the server.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
505 </tag-desc>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
506
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
507 <tag-name><literal>requests</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
508 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
509 The total number of
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
510 client requests forwarded to this server.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
511 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
512
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
513 <tag-name><literal>responses</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
514 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
515 <list type="tag">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
516
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
517 <tag-name><literal>total</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
518 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
519 The total number of
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
520 responses obtained from this server.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
521 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
522
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
523 <tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
524 <literal>1xx</literal>,
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
525 <literal>2xx</literal>,
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
526 <literal>3xx</literal>,
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
527 <literal>4xx</literal>,
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
528 <literal>5xx</literal>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
529 </tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
530 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
531 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
532 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
533
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
534 </list>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
535 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
536
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
537 <tag-name><literal>sent</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
538 <tag-desc>
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
539 The total number of bytes sent to this server.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
540 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
541
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
542 <tag-name><literal>received</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
543 <tag-desc>
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
544 The total number of bytes received from this server.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
545 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
546
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
547 <tag-name><literal>fails</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
548 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
549 The total number of
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
550 unsuccessful attempts to communicate with the server.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
551 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
552
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
553 <tag-name><literal>unavail</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
554 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
555 How many times
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
556 the server became unavailable for client requests
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
557 (state “<literal>unavail</literal>”)
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
558 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
559 <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
560 threshold.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
561 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
562
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
563 <tag-name><literal>health_checks</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
564 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
565 <list type="tag">
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
566
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
567 <tag-name><literal>checks</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
568 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
569 The total number of
1945
88477c5d2751 Moved "health_check" and "match" to ngx_http_upstream_hc_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1943
diff changeset
570 <link doc="ngx_http_upstream_hc_module.xml" id="health_check">health check</link>
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
571 requests made.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
572 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
573
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
574 <tag-name><literal>fails</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
575 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
576 The number of failed health checks.
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
577 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
578
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
579 <tag-name><literal>unhealthy</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
580 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
581 How many times
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
582 the server became unhealthy (state “<literal>unhealthy</literal>”).
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
583 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
584
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
585 <tag-name><literal>last_passed</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
586 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
587 Boolean indicating
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
588 if the last health check request was successful and passed
1945
88477c5d2751 Moved "health_check" and "match" to ngx_http_upstream_hc_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1943
diff changeset
589 <link doc="ngx_http_upstream_hc_module.xml" id="match">tests</link>.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
590 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
591
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
592 </list>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
593 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
594
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
595 <tag-name><literal>downtime</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
596 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
597 Total time
1925
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
598 the server was in the “<literal>unavail</literal>”,
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
599 “<literal>checking</literal>”, and “<literal>unhealthy</literal>” states.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
600 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
601
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
602 <tag-name><literal>downstart</literal></tag-name>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
603 <tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
604 The time (in milliseconds since Epoch)
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
605 when the server became
1925
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
606 “<literal>unavail</literal>”,
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
607 “<literal>checking</literal>”, or “<literal>unhealthy</literal>”.
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
608 </tag-desc>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
609
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
610 <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
611 <tag-desc>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
612 The time (in milliseconds since Epoch)
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
613 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
614 </tag-desc>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
615
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
616 <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
617 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
618 The average time to get the
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
619 <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
620 header</link> from the server (1.7.10).
1943
96232cc8a0b7 Documented availability of some time metrics for all lb methods in status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1925
diff changeset
621 Prior to version 1.11.6,
96232cc8a0b7 Documented availability of some time metrics for all lb methods in status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1925
diff changeset
622 the field was available only when using the
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
623 <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
624 load balancing method.
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 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
628 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
629 The average time to get the
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
630 <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
631 response</link> from the server (1.7.10).
1943
96232cc8a0b7 Documented availability of some time metrics for all lb methods in status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1925
diff changeset
632 Prior to version 1.11.6,
96232cc8a0b7 Documented availability of some time metrics for all lb methods in status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1925
diff changeset
633 the field was available only when using the
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
634 <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
635 load balancing method.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
636 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
637
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
638 </list>
965
fadccc156188 Status: fixed indentation.
Andrei Belov <defan@nginx.com>
parents: 953
diff changeset
639 </tag-desc>
fadccc156188 Status: fixed indentation.
Andrei Belov <defan@nginx.com>
parents: 953
diff changeset
640
1561
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
641 <tag-name><literal>keepalive</literal></tag-name>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
642 <tag-desc>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
643 The current number of
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
644 idle <link doc="ngx_http_upstream_module.xml" id="keepalive"/> connections.
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
645 </tag-desc>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
646
1805
0c08e8861cfe Documented the "zombies" metrics in status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1617
diff changeset
647 <tag-name id="zombies"><literal>zombies</literal></tag-name>
0c08e8861cfe Documented the "zombies" metrics in status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1617
diff changeset
648 <tag-desc>
1814
7b83f37c806f Removed link from the "zombies" metric in status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1805
diff changeset
649 The current number of servers removed
1805
0c08e8861cfe Documented the "zombies" metrics in status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1617
diff changeset
650 from the group but still processing active client requests.
0c08e8861cfe Documented the "zombies" metrics in status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1617
diff changeset
651 </tag-desc>
0c08e8861cfe Documented the "zombies" metrics in status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1617
diff changeset
652
1925
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
653 <tag-name id="zone"><literal>zone</literal></tag-name>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
654 <tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
655 The name of the shared memory
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
656 <link doc="ngx_http_upstream_module.xml" id="zone"/>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
657 that keeps the group’s configuration and run-time state.
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
658 </tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
659
1561
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
660 <tag-name id="queue"><literal>queue</literal></tag-name>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
661 <tag-desc>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
662 For the requests <link doc="ngx_http_upstream_module.xml" id="queue"/>,
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
663 the following data are provided:
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
664 <list type="tag">
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
665
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
666 <tag-name><literal>size</literal></tag-name>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
667 <tag-desc>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
668 The current number of requests in the queue.
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
669 </tag-desc>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
670
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
671 <tag-name id="max_size"><literal>max_size</literal></tag-name>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
672 <tag-desc>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
673 The maximum number of requests that can be in the queue at the same time.
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
674 </tag-desc>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
675
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
676 <tag-name><literal>overflows</literal></tag-name>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
677 <tag-desc>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
678 The total number of requests rejected due to the queue overflow.
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
679 </tag-desc>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
680
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
681 </list>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
682 </tag-desc>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
683
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
684 </list>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
685 </tag-desc>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
686
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
687 <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
688 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
689 For each cache (configured by
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
690 <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
691 <list type="tag">
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
692
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
693 <tag-name><literal>size</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
694 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
695 The current size of the cache.
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
696 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
697
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
698 <tag-name><literal>max_size</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
699 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
700 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
701 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
702
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
703 <tag-name><literal>cold</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
704 <tag-desc>
1198
59099cb4b16f Status: fixed "backup" description broken in dd64ce140de2.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1128
diff changeset
705 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
706 data from disk into the cache.
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
707 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
708
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
709 <tag-name>
1284
d3548b46b87f Typo fixed.
Andrei Belov <defan@nginx.com>
parents: 1258
diff changeset
710 <literal>hit</literal>,
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
711 <literal>stale</literal>,
1120
99ae1c12c99e Status: documented "revalidated" cache status field.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1088
diff changeset
712 <literal>updating</literal>,
99ae1c12c99e Status: documented "revalidated" cache status field.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1088
diff changeset
713 <literal>revalidated</literal>
1027
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
714 </tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
715 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
716 <list type="tag">
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
717
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
718 <tag-name><literal>responses</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
719 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
720 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
721 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
722 and the likes).
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
723 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
724
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
725 <tag-name><literal>bytes</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
726 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
727 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
728 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
729
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
730 </list>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
731 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
732
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
733 <tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
734 <literal>miss</literal>,
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
735 <literal>expired</literal>,
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
736 <literal>bypass</literal>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
737 </tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
738 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
739 <list type="tag">
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
740
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
741 <tag-name><literal>responses</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
742 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
743 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
744 bypasses due to
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
745 <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
746 and the likes).
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
747 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
748
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
749 <tag-name><literal>bytes</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
750 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
751 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
752 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
753
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
754 <tag-name><literal>responses_written</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
755 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
756 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
757 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
758
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
759 <tag-name><literal>bytes_written</literal></tag-name>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
760 <tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
761 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
762 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
763
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
764 </list>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
765 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
766
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
767 </list>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
768 </tag-desc>
dd64ce140de2 Status: virtual servers, caches, load_timestamp.
Ruslan Ermilov <ru@nginx.com>
parents: 967
diff changeset
769
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
770 <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
771 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
772
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
773 <list type="tag">
1825
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
774 <tag-name id="stream_server_zones"><literal>server_zones</literal></tag-name>
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
775 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
776 For each <link id="status_zone"/>:
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
777 <list type="tag">
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>processing</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 The number of
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
782 client connections that are currently being processed.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
783 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
784
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
785 <tag-name><literal>connections</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
786 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
787 The total number of
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
788 connections accepted from clients.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
789 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
790
1825
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
791 <tag-name id="sessions"><literal>sessions</literal></tag-name>
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
792 <tag-desc>
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
793 <list type="tag">
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
794
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
795 <tag-name><literal>total</literal></tag-name>
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
796 <tag-desc>
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
797 The total number of completed client sessions.
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
798 </tag-desc>
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
799
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
800 <tag-name>
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
801 <literal>2xx</literal>,
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
802 <literal>4xx</literal>,
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
803 <literal>5xx</literal>
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
804 </tag-name>
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
805 <tag-desc>
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
806 The number of sessions completed with
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
807 <link doc="../stream/ngx_stream_core_module.xml" id="var_status">status codes</link>
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
808 2xx, 4xx, or 5xx.
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
809 </tag-desc>
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
810
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
811 </list>
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
812 </tag-desc>
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
813
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
814 <tag-name id="stream_discarded"><literal>discarded</literal></tag-name>
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
815 <tag-desc>
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
816 The total number of connections completed without creating a session.
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
817 </tag-desc>
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
818
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
819 <tag-name><literal>received</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
820 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
821 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
822 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
823
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
824 <tag-name><literal>sent</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
825 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
826 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
827 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
828
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
829 </list>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
830 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
831
1925
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
832 <tag-name id="stream_upstreams"><literal>upstreams</literal></tag-name>
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
833 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
834 For each
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
835 <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
836 configurable</link>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
837 <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
838 the following data are provided:
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
839 <list type="tag">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
840
1561
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
841 <tag-name><literal>peers</literal></tag-name>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
842 <tag-desc>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
843 For each
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
844 <link doc="../stream/ngx_stream_upstream_module.xml" id="server"/>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
845 the following data are provided:
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
846 <list type="tag">
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
847
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
848 <tag-name><literal>id</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
849 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
850 The ID of the server.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
851 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
852
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
853 <tag-name><literal>server</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
854 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
855 An
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
856 <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
857 of the server.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
858 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
859
1925
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
860
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
861 <tag-name id="stream_name"><literal>name</literal></tag-name>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
862 <tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
863 The name of the server specified in the
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
864 <link doc="../stream/ngx_stream_upstream_module.xml" id="server"/> directive.
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
865 </tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
866
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
867 <tag-name id="stream_service"><literal>service</literal></tag-name>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
868 <tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
869 The <link doc="../stream/ngx_stream_upstream_module.xml" id="service"/>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
870 parameter value of the
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
871 <link doc="../stream/ngx_stream_upstream_module.xml" id="server"/> directive.
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
872 </tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
873
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
874 <tag-name><literal>backup</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
875 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
876 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
877 <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
878 server.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
879 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
880
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
881 <tag-name><literal>weight</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
882 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
883 <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
884 of the server.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
885 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
886
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
887 <tag-name><literal>state</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
888 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
889 Current state, which may be one of
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
890 “<literal>up</literal>”,
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
891 “<literal>down</literal>”,
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
892 “<literal>unavail</literal>”,
1925
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
893 “<literal>checking</literal>”,
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
894 or
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
895 “<literal>unhealthy</literal>”.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
896 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
897
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
898 <tag-name><literal>active</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
899 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
900 The current number of connections.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
901 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
902
2028
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1947
diff changeset
903 <tag-name><literal>max_conns</literal></tag-name>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1947
diff changeset
904 <tag-desc>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1947
diff changeset
905 The <link doc="../stream/ngx_stream_upstream_module.xml" id="max_conns"/> limit
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1947
diff changeset
906 for the server.
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1947
diff changeset
907 </tag-desc>
5c55b7054b58 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1947
diff changeset
908
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
909 <tag-name><literal>connections</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
910 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
911 The total number of
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
912 client connections forwarded to this server.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
913 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
914
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
915 <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
916 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
917 The average time to connect to the upstream server.
1943
96232cc8a0b7 Documented availability of some time metrics for all lb methods in status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1925
diff changeset
918 Prior to version 1.11.6,
96232cc8a0b7 Documented availability of some time metrics for all lb methods in status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1925
diff changeset
919 the field was available only when using the
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
920 <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
921 load balancing method.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
922 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
923
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
924 <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
925 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
926 The average time to receive the first byte of data.
1943
96232cc8a0b7 Documented availability of some time metrics for all lb methods in status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1925
diff changeset
927 Prior to version 1.11.6,
96232cc8a0b7 Documented availability of some time metrics for all lb methods in status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1925
diff changeset
928 the field was available only when using the
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
929 <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
930 load balancing method.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
931 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
932
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
933 <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
934 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
935 The average time to receive the last byte of data.
1943
96232cc8a0b7 Documented availability of some time metrics for all lb methods in status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1925
diff changeset
936 Prior to version 1.11.6,
96232cc8a0b7 Documented availability of some time metrics for all lb methods in status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1925
diff changeset
937 the field was available only when using the
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
938 <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
939 load balancing method.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
940 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
941
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
942 <tag-name><literal>sent</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
943 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
944 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
945 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
946
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
947 <tag-name><literal>received</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
948 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
949 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
950 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
951
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
952 <tag-name><literal>fails</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
953 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
954 The total number of
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
955 unsuccessful attempts to communicate with the server.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
956 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
957
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
958 <tag-name><literal>unavail</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
959 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
960 How many times
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
961 the server became unavailable for client connections
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
962 (state “<literal>unavail</literal>”)
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
963 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
964 <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
965 threshold.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
966 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
967
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
968 <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
969 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
970 <list type="tag">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
971
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
972 <tag-name><literal>checks</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
973 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
974 The total number of
1947
6b6d0e844bf7 Moved "health_check" and "match" to ngx_stream_upstream_hc_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1945
diff changeset
975 <link doc="../stream/ngx_stream_upstream_hc_module.xml" id="health_check">health check</link>
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
976 requests made.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
977 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
978
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
979 <tag-name><literal>fails</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
980 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
981 The number of failed health checks.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
982 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
983
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
984 <tag-name><literal>unhealthy</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
985 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
986 How many times
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
987 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
988 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
989
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
990 <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
991 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
992 Boolean indicating
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
993 if the last health check request was successful and passed
1947
6b6d0e844bf7 Moved "health_check" and "match" to ngx_stream_upstream_hc_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1945
diff changeset
994 <link doc="../stream/ngx_stream_upstream_hc_module.xml" id="match">tests</link>.
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
995 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
996
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
997 </list>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
998 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
999
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1000 <tag-name><literal>downtime</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1001 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1002 Total time
1925
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1003 the server was in the “<literal>unavail</literal>”,
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1004 “<literal>checking</literal>”, and “<literal>unhealthy</literal>” states.
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1005 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1006
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1007 <tag-name><literal>downstart</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1008 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1009 The time (in milliseconds since Epoch)
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1010 when the server became
1925
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1011 “<literal>unavail</literal>”,
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1012 “<literal>checking</literal>”, or “<literal>unhealthy</literal>”.
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1013 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1014
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1015 <tag-name><literal>selected</literal></tag-name>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1016 <tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1017 The time (in milliseconds since Epoch)
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1018 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
1019 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1020
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1021 </list>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1022 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1023
1925
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1024 <tag-name><literal>zombies</literal></tag-name>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1025 <tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1026 The current number of servers removed
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1027 from the group but still processing active client connections.
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1028 </tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1029
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1030 <tag-name><literal>zone</literal></tag-name>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1031 <tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1032 The name of the shared memory
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1033 <link doc="../stream/ngx_stream_upstream_module.xml" id="zone"/>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1034 that keeps the group’s configuration and run-time state.
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1035 </tag-desc>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1036
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1037 </list>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1038 </tag-desc>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1039
965
fadccc156188 Status: fixed indentation.
Andrei Belov <defan@nginx.com>
parents: 953
diff changeset
1040 </list>
1561
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1041 </tag-desc>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1042
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1043 </list>
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1044 </para>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1045
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1046 </section>
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1047
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1048 <section id="compatibility" name="Compatibility">
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1049
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1050 <para>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1051 <list type="bullet">
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1052
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1053 <listitem>
1825
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
1054 The
1925
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1055 <link id="zone"/> field in
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1056 <link id="upstreams">http</link> and <link id="stream_upstreams">stream</link>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1057 upstreams
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1058 was added in <link id="version"/> 8.
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1059 </listitem>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1060
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1061 <listitem>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1062 The <link id="slabs"/> status data
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1063 were added in <link id="version"/> 8.
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1064 </listitem>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1065
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1066 <listitem>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1067 The
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1068 <link id="state">checking</link> state
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1069 was added in <link id="version"/> 8.
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1070 </listitem>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1071
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1072 <listitem>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1073 The
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1074 <link id="name"/> and <link id="service"/> fields in
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1075 <link id="upstreams">http</link> and <link id="stream_upstreams">stream</link>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1076 upstreams
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1077 were added in <link id="version"/> 8.
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1078 </listitem>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1079
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1080 <listitem>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1081 The
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1082 <link id="nginx_build"/> and <link id="ppid"/> fields
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1083 were added in <link id="version"/> 8.
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1084 </listitem>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1085
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1086 <listitem>
a58b35cc0823 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1825
diff changeset
1087 The
1825
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
1088 <link id="sessions"/> status data
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
1089 and the <link id="stream_discarded">discarded</link> field in
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
1090 stream <link id="stream_server_zones">server_zones</link>
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
1091 were added in <link id="version"/> 7.
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
1092 </listitem>
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
1093
56b6244ddadb Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1814
diff changeset
1094 <listitem>
1805
0c08e8861cfe Documented the "zombies" metrics in status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1617
diff changeset
1095 The <link id="zombies"/> field
0c08e8861cfe Documented the "zombies" metrics in status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1617
diff changeset
1096 was moved from nginx <link doc="../debugging_log.xml">debug</link> version
0c08e8861cfe Documented the "zombies" metrics in status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1617
diff changeset
1097 in <link id="version"/> 6.
0c08e8861cfe Documented the "zombies" metrics in status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1617
diff changeset
1098 </listitem>
0c08e8861cfe Documented the "zombies" metrics in status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1617
diff changeset
1099
0c08e8861cfe Documented the "zombies" metrics in status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1617
diff changeset
1100 <listitem>
1561
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1101 The <link id="ssl"/> status data
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1102 were added in <link id="version"/> 6.
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1103 </listitem>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1104
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1105 <listitem>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1106 The
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1107 <link id="discarded"/> field in
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1108 <link id="server_zones"/>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1109 was added in <link id="version"/> 6.
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1110 </listitem>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1111
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1112 <listitem>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1113 The <link id="queue"/> status data
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1114 were added in <link id="version"/> 6.
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1115 </listitem>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1116
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1117 <listitem>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1118 The
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1119 <link id="pid"/> field
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1120 was added in <link id="version"/> 6.
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1121 </listitem>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1122
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1123 <listitem>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1124 The list of servers in <link id="upstreams"/>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1125 was moved into <link id="peers"/> in
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1126 <link id="version"/> 6.
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1127 </listitem>
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1128
ed420c318557 Updated docs for the upcoming NGINX Plus release.
Ruslan Ermilov <ru@nginx.com>
parents: 1559
diff changeset
1129 <listitem>
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1130 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
1131 was removed in <link id="version"/> 5.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1132 </listitem>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1133
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1134 <listitem>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1135 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
1136 were added in <link id="version"/> 5.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1137 </listitem>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1138
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1139 <listitem>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1140 The
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1141 <link id="generation"/> field
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1142 was added in <link id="version"/> 5.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1143 </listitem>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1144
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1145 <listitem>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1146 The
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1147 <link id="respawned"/> field in
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1148 <link id="processes"/>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1149 was added in <link id="version"/> 5.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1150 </listitem>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1151
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1152 <listitem>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1153 The
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1154 <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
1155 <link id="upstreams"/>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1156 were added in <link id="version"/> 5.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1157 </listitem>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1158
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
1159 <listitem>
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1160 The
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1161 <link id="selected"/> field in
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1162 <link id="upstreams"/>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1163 was added in <link id="version"/> 4.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1164 </listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1165
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1166 <listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1167 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
1168 <link id="upstreams"/>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1169 was added in <link id="version"/> 4.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1170 </listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1171
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1172 <listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1173 The
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1174 <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
1175 <link id="upstreams"/>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1176 were added in <link id="version"/> 3.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1177 </listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1178
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1179 <listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1180 The <literal>revalidated</literal> field in
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1181 <link id="caches"/>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1182 was added in <link id="version"/> 3.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1183 </listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1184
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1185 <listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1186 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
1187 and <link id="load_timestamp"/> status data
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1188 were added in <link id="version"/> 2.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1189 </listitem>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1190
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1191 </list>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1192 </para>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1193
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1194 </section>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1284
diff changeset
1195
953
aded7086e84f Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1196 </module>