Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_status_module.xml @ 1367:f1e14d87d833

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated commercial docs for the upcoming release.
author Ruslan Ermilov <ru@nginx.com>
date Mon, 01 Dec 2014 13:40:25 +0300
parents d3548b46b87f
children f5b5eefc43cb
comparison
equal deleted inserted replaced
1366:f3b7ec81b738 1367:f1e14d87d833
152 152
153 <para> 153 <para>
154 The following status information is provided: 154 The following status information is provided:
155 <list type="tag"> 155 <list type="tag">
156 156
157 <tag-name><literal>version</literal></tag-name> 157 <tag-name id="version"><literal>version</literal></tag-name>
158 <tag-desc> 158 <tag-desc>
159 Version of the provided data set. 159 Version of the provided data set.
160 The current version is 2. 160 The current version is 4.
161 </tag-desc> 161 </tag-desc>
162 162
163 <tag-name><literal>nginx_version</literal></tag-name> 163 <tag-name><literal>nginx_version</literal></tag-name>
164 <tag-desc> 164 <tag-desc>
165 Version of nginx. 165 Version of nginx.
168 <tag-name><literal>address</literal></tag-name> 168 <tag-name><literal>address</literal></tag-name>
169 <tag-desc> 169 <tag-desc>
170 The address of the server that accepted status request. 170 The address of the server that accepted status request.
171 </tag-desc> 171 </tag-desc>
172 172
173 <tag-name><literal>load_timestamp</literal></tag-name> 173 <tag-name id="load_timestamp"><literal>load_timestamp</literal></tag-name>
174 <tag-desc> 174 <tag-desc>
175 Time of the last reload of configuration, in milliseconds since Epoch. 175 Time of the last reload of configuration, in milliseconds since Epoch.
176 </tag-desc> 176 </tag-desc>
177 177
178 <tag-name><literal>timestamp</literal></tag-name> 178 <tag-name><literal>timestamp</literal></tag-name>
222 </tag-desc> 222 </tag-desc>
223 223
224 </list> 224 </list>
225 </tag-desc> 225 </tag-desc>
226 226
227 <tag-name><literal>server_zones</literal></tag-name> 227 <tag-name id="server_zones"><literal>server_zones</literal></tag-name>
228 <tag-desc> 228 <tag-desc>
229 For each <link id="status_zone"/>: 229 For each <link id="status_zone"/>:
230 <list type="tag"> 230 <list type="tag">
231 231
232 <tag-name><literal>processing</literal></tag-name> 232 <tag-name><literal>processing</literal></tag-name>
276 </tag-desc> 276 </tag-desc>
277 277
278 </list> 278 </list>
279 </tag-desc> 279 </tag-desc>
280 280
281 <tag-name><literal>upstreams</literal></tag-name> 281 <tag-name id="upstreams"><literal>upstreams</literal></tag-name>
282 <tag-desc> 282 <tag-desc>
283 For each 283 For each
284 <link doc="ngx_http_upstream_module.xml" id="server"/> 284 <link doc="ngx_http_upstream_module.xml" id="server"/>
285 in the 285 in the
286 <link doc="ngx_http_upstream_module.xml" id="zone">dynamically 286 <link doc="ngx_http_upstream_module.xml" id="zone">dynamically
287 configurable</link> 287 configurable</link>
288 <link doc="ngx_http_upstream_module.xml" id="upstream">group</link>, 288 <link doc="ngx_http_upstream_module.xml" id="upstream">group</link>,
289 the following data are provided: 289 the following data are provided:
290 <list type="tag"> 290 <list type="tag">
291 291
292 <tag-name id="id"><literal>id</literal></tag-name>
293 <tag-desc>
294 The ID of the server.
295 </tag-desc>
296
292 <tag-name><literal>server</literal></tag-name> 297 <tag-name><literal>server</literal></tag-name>
293 <tag-desc> 298 <tag-desc>
294 An address of the 299 An
295 <link doc="ngx_http_upstream_module.xml" id="server"/>. 300 <link doc="ngx_http_upstream_module.xml" id="server">address</link>
301 of the server.
296 </tag-desc> 302 </tag-desc>
297 303
298 <tag-name><literal>backup</literal></tag-name> 304 <tag-name><literal>backup</literal></tag-name>
299 <tag-desc> 305 <tag-desc>
300 A boolean value indicating whether the server is a backup server. 306 A boolean value indicating whether the server is a
307 <link doc="ngx_http_upstream_module.xml" id="backup"/>
308 server.
301 </tag-desc> 309 </tag-desc>
302 310
303 <tag-name><literal>weight</literal></tag-name> 311 <tag-name><literal>weight</literal></tag-name>
304 <tag-desc> 312 <tag-desc>
305 Weight of the 313 <link doc="ngx_http_upstream_module.xml" id="weight">Weight</link>
306 <link doc="ngx_http_upstream_module.xml" id="server"/>. 314 of the server.
307 </tag-desc> 315 </tag-desc>
308 316
309 <tag-name><literal>state</literal></tag-name> 317 <tag-name id="state"><literal>state</literal></tag-name>
310 <tag-desc> 318 <tag-desc>
311 Current state, which may be one of 319 Current state, which may be one of
312 “<literal>up</literal>”, 320 “<literal>up</literal>”,
321 “<literal>draining</literal>”,
313 “<literal>down</literal>”, 322 “<literal>down</literal>”,
314 “<literal>unavail</literal>”, 323 “<literal>unavail</literal>”,
315 or 324 or
316 “<literal>unhealthy</literal>”. 325 “<literal>unhealthy</literal>”.
317 </tag-desc> 326 </tag-desc>
323 332
324 <tag-name><literal>keepalive</literal></tag-name> 333 <tag-name><literal>keepalive</literal></tag-name>
325 <tag-desc> 334 <tag-desc>
326 The current number of 335 The current number of
327 idle <link doc="ngx_http_upstream_module.xml" id="keepalive"/> connections. 336 idle <link doc="ngx_http_upstream_module.xml" id="keepalive"/> connections.
337 </tag-desc>
338
339 <tag-name id="max_conns"><literal>max_conns</literal></tag-name>
340 <tag-desc>
341 The <link doc="ngx_http_upstream_module.xml" id="max_conns"/> limit
342 for the server.
328 </tag-desc> 343 </tag-desc>
329 344
330 <tag-name><literal>requests</literal></tag-name> 345 <tag-name><literal>requests</literal></tag-name>
331 <tag-desc> 346 <tag-desc>
332 The total number of 347 The total number of
376 <tag-name><literal>unavail</literal></tag-name> 391 <tag-name><literal>unavail</literal></tag-name>
377 <tag-desc> 392 <tag-desc>
378 How many times 393 How many times
379 the server became unavailable for client requests 394 the server became unavailable for client requests
380 (state “<literal>unavail</literal>”) 395 (state “<literal>unavail</literal>”)
381 due to the number of unsuccessful attempts reaching 396 due to the number of unsuccessful attempts reaching the
382 the <literal>max_fails</literal> threshold. 397 <link doc="ngx_http_upstream_module.xml" id="max_fails"/>
398 threshold.
383 </tag-desc> 399 </tag-desc>
384 400
385 <tag-name><literal>health_checks</literal></tag-name> 401 <tag-name><literal>health_checks</literal></tag-name>
386 <tag-desc> 402 <tag-desc>
387 <list type="tag"> 403 <list type="tag">
427 when the server became 443 when the server became
428 “<literal>unavail</literal>” 444 “<literal>unavail</literal>”
429 or “<literal>unhealthy</literal>”. 445 or “<literal>unhealthy</literal>”.
430 </tag-desc> 446 </tag-desc>
431 447
432 </list> 448 <tag-name id="selected"><literal>selected</literal></tag-name>
433 </tag-desc> 449 <tag-desc>
434 450 The time (in milliseconds since Epoch)
435 <tag-name><literal>caches</literal></tag-name> 451 when the server was last selected to process a request (1.7.5).
452 </tag-desc>
453
454 </list>
455 </tag-desc>
456
457 <tag-name id="caches"><literal>caches</literal></tag-name>
436 <tag-desc> 458 <tag-desc>
437 For each cache (configured by 459 For each cache (configured by
438 <link doc="ngx_http_proxy_module.xml" id="proxy_cache_path"/> and the likes): 460 <link doc="ngx_http_proxy_module.xml" id="proxy_cache_path"/> and the likes):
439 <list type="tag"> 461 <list type="tag">
440 462
518 </list> 540 </list>
519 </para> 541 </para>
520 542
521 </section> 543 </section>
522 544
545 <section id="compatibility" name="Compatibility">
546
547 <para>
548 <list type="bullet">
549
550 <listitem>
551 The
552 <link id="selected"/> field in
553 <link id="upstreams"/>
554 was added in <link id="version"/> 4.
555 </listitem>
556
557 <listitem>
558 The <link id="state">draining</link> state in
559 <link id="upstreams"/>
560 was added in <link id="version"/> 4.
561 </listitem>
562
563 <listitem>
564 The
565 <link id="id"/> and <link id="max_conns"/> fields in
566 <link id="upstreams"/>
567 were added in <link id="version"/> 3.
568 </listitem>
569
570 <listitem>
571 The <literal>revalidated</literal> field in
572 <link id="caches"/>
573 was added in <link id="version"/> 3.
574 </listitem>
575
576 <listitem>
577 The <link id="server_zones"/>, <link id="caches"/>,
578 and <link id="load_timestamp"/> status data
579 were added in <link id="version"/> 2.
580 </listitem>
581
582 </list>
583 </para>
584
585 </section>
586
523 </module> 587 </module>