annotate xml/en/docs/http/ngx_http_status_module.xml @ 2769:16f6fa718be2

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