Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_status_module.xml @ 1027:dd64ce140de2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Status: virtual servers, caches, load_timestamp.
author Ruslan Ermilov <ru@nginx.com>
date Wed, 23 Oct 2013 13:36:17 +0400
parents 81717ad0a9c9
children 379cb572a7ec
comparison
equal deleted inserted replaced
1026:3056640d5022 1027:dd64ce140de2
29 29
30 <section id="example" name="Example Configuration"> 30 <section id="example" name="Example Configuration">
31 31
32 <para> 32 <para>
33 <example> 33 <example>
34 location = /status { 34 server {
35 status; 35 location = /status {
36 status;
37 }
38
39 status_zone example_server;
36 } 40 }
37 </example> 41 </example>
38 </para> 42 </para>
39 43
40 <para> 44 <para>
81 then “<literal>ngx_status_jsonp_callback</literal>” is used. 85 then “<literal>ngx_status_jsonp_callback</literal>” is used.
82 </para> 86 </para>
83 87
84 </directive> 88 </directive>
85 89
90
91 <directive name="status_zone">
92 <syntax><value>zone</value></syntax>
93 <default/>
94 <context>server</context>
95
96 <para>
97 Enables collection of virtual
98 <link doc="ngx_http_core_module.xml" id="server"/>
99 status information in the specified <value>zone</value>.
100 Several virtual servers may share the same zone.
101 </para>
102
103 </directive>
104
86 </section> 105 </section>
87 106
88 107
89 <section id="data" name="Data"> 108 <section id="data" name="Data">
90 109
93 <list type="tag"> 112 <list type="tag">
94 113
95 <tag-name><literal>version</literal></tag-name> 114 <tag-name><literal>version</literal></tag-name>
96 <tag-desc> 115 <tag-desc>
97 Version of the provided data set. 116 Version of the provided data set.
98 The current version is 1. 117 The current version is 2.
99 </tag-desc> 118 </tag-desc>
100 119
101 <tag-name><literal>nginx_version</literal></tag-name> 120 <tag-name><literal>nginx_version</literal></tag-name>
102 <tag-desc> 121 <tag-desc>
103 Version of nginx. 122 Version of nginx.
104 </tag-desc> 123 </tag-desc>
105 124
106 <tag-name><literal>address</literal></tag-name> 125 <tag-name><literal>address</literal></tag-name>
107 <tag-desc> 126 <tag-desc>
108 An address of the server that accepted status request. 127 The address of the server that accepted status request.
128 </tag-desc>
129
130 <tag-name><literal>load_timestamp</literal></tag-name>
131 <tag-desc>
132 Time of the last reload of configuration, in milliseconds since Epoch.
109 </tag-desc> 133 </tag-desc>
110 134
111 <tag-name><literal>timestamp</literal></tag-name> 135 <tag-name><literal>timestamp</literal></tag-name>
112 <tag-desc> 136 <tag-desc>
113 Current time in milliseconds since Epoch. 137 Current time in milliseconds since Epoch.
150 </tag-desc> 174 </tag-desc>
151 175
152 <tag-name><literal>current</literal></tag-name> 176 <tag-name><literal>current</literal></tag-name>
153 <tag-desc> 177 <tag-desc>
154 The current number of client requests. 178 The current number of client requests.
179 </tag-desc>
180
181 </list>
182 </tag-desc>
183
184 <tag-name><literal>server_zones</literal></tag-name>
185 <tag-desc>
186 For each <link id="status_zone"/>:
187 <list type="tag">
188
189 <tag-name><literal>processing</literal></tag-name>
190 <tag-desc>
191 The number of
192 client requests that are currently being processed.
193 </tag-desc>
194
195 <tag-name><literal>requests</literal></tag-name>
196 <tag-desc>
197 The total number of
198 client requests received from clients.
199 </tag-desc>
200
201 <tag-name><literal>responses</literal></tag-name>
202 <tag-desc>
203 <list type="tag">
204
205 <tag-name><literal>total</literal></tag-name>
206 <tag-desc>
207 The total number of
208 responses sent to clients.
209 </tag-desc>
210
211 <tag-name>
212 <literal>1xx</literal>,
213 <literal>2xx</literal>,
214 <literal>3xx</literal>,
215 <literal>4xx</literal>,
216 <literal>5xx</literal>
217 </tag-name>
218 <tag-desc>
219 The number of responses with status codes 1xx, 2xx, 3xx, 4xx, and 5xx.
220 </tag-desc>
221
222 </list>
223 </tag-desc>
224
225 <tag-name><literal>received</literal></tag-name>
226 <tag-desc>
227 The total number of bytes received from clients.
228 </tag-desc>
229
230 <tag-name><literal>sent</literal></tag-name>
231 <tag-desc>
232 The total number of bytes sent to clients.
155 </tag-desc> 233 </tag-desc>
156 234
157 </list> 235 </list>
158 </tag-desc> 236 </tag-desc>
159 237
174 <link doc="ngx_http_upstream_module.xml" id="server"/>. 252 <link doc="ngx_http_upstream_module.xml" id="server"/>.
175 </tag-desc> 253 </tag-desc>
176 254
177 <tag-name><literal>backup</literal></tag-name> 255 <tag-name><literal>backup</literal></tag-name>
178 <tag-desc> 256 <tag-desc>
179 Boolean indicating if the server is a backup server. 257 A boolean value indicating whether the “cache loader” process is still loading
258 data from disk into the cache.
180 </tag-desc> 259 </tag-desc>
181 260
182 <tag-name><literal>weight</literal></tag-name> 261 <tag-name><literal>weight</literal></tag-name>
183 <tag-desc> 262 <tag-desc>
184 Weight of the 263 Weight of the
236 </list> 315 </list>
237 </tag-desc> 316 </tag-desc>
238 317
239 <tag-name><literal>sent</literal></tag-name> 318 <tag-name><literal>sent</literal></tag-name>
240 <tag-desc> 319 <tag-desc>
241 The total bytes sent to this server. 320 The total number of bytes sent to this server.
242 </tag-desc> 321 </tag-desc>
243 322
244 <tag-name><literal>received</literal></tag-name> 323 <tag-name><literal>received</literal></tag-name>
245 <tag-desc> 324 <tag-desc>
246 The total bytes received from this server. 325 The total number of bytes received from this server.
247 </tag-desc> 326 </tag-desc>
248 327
249 <tag-name><literal>fails</literal></tag-name> 328 <tag-name><literal>fails</literal></tag-name>
250 <tag-desc> 329 <tag-desc>
251 The total number of 330 The total number of
309 </tag-desc> 388 </tag-desc>
310 389
311 </list> 390 </list>
312 </tag-desc> 391 </tag-desc>
313 392
393 <tag-name><literal>caches</literal></tag-name>
394 <tag-desc>
395 For each cache (configured by
396 <link doc="ngx_http_proxy_module.xml" id="proxy_cache_path"/> and the likes):
397 <list type="tag">
398
399 <tag-name><literal>size</literal></tag-name>
400 <tag-desc>
401 The current size of the cache.
402 </tag-desc>
403
404 <tag-name><literal>max_size</literal></tag-name>
405 <tag-desc>
406 The limit on the maximum size of the cache specified in the configuration.
407 </tag-desc>
408
409 <tag-name><literal>cold</literal></tag-name>
410 <tag-desc>
411 Boolean indicating if “cache loader” is still loading data into the cache.
412 </tag-desc>
413
414 <tag-name>
415 <literal>hits</literal>,
416 <literal>stale</literal>,
417 <literal>updating</literal>
418 </tag-name>
419 <tag-desc>
420 <list type="tag">
421
422 <tag-name><literal>responses</literal></tag-name>
423 <tag-desc>
424 The total number of responses read from the cache (hits, or stale responses
425 due to <link doc="ngx_http_proxy_module.xml" id="proxy_cache_use_stale"/>
426 and the likes).
427 </tag-desc>
428
429 <tag-name><literal>bytes</literal></tag-name>
430 <tag-desc>
431 The total number of bytes read from the cache.
432 </tag-desc>
433
434 </list>
435 </tag-desc>
436
437 <tag-name>
438 <literal>miss</literal>,
439 <literal>expired</literal>,
440 <literal>bypass</literal>
441 </tag-name>
442 <tag-desc>
443 <list type="tag">
444
445 <tag-name><literal>responses</literal></tag-name>
446 <tag-desc>
447 The total number of responses not taken from the cache (misses, expires, or
448 bypasses due to
449 <link doc="ngx_http_proxy_module.xml" id="proxy_cache_bypass"/>
450 and the likes).
451 </tag-desc>
452
453 <tag-name><literal>bytes</literal></tag-name>
454 <tag-desc>
455 The total number of bytes read from the proxied server.
456 </tag-desc>
457
458 <tag-name><literal>responses_written</literal></tag-name>
459 <tag-desc>
460 The total number of responses written to the cache.
461 </tag-desc>
462
463 <tag-name><literal>bytes_written</literal></tag-name>
464 <tag-desc>
465 The total number of bytes written to the cache.
466 </tag-desc>
467
468 </list>
469 </tag-desc>
470
471 </list>
472 </tag-desc>
473
314 </list> 474 </list>
315 </para> 475 </para>
316 476
317 </section> 477 </section>
318 478