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