Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_status_module.xml @ 1561:ed420c318557

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated docs for the upcoming NGINX Plus release.
author Ruslan Ermilov <ru@nginx.com>
date Thu, 10 Sep 2015 15:50:32 +0300
parents d876f94135ac
children 69ff752dcb55
comparison
equal deleted inserted replaced
1560:dad3af7a1019 1561:ed420c318557
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8 8
9 <module name="Module ngx_http_status_module" 9 <module name="Module ngx_http_status_module"
10 link="/en/docs/http/ngx_http_status_module.html" 10 link="/en/docs/http/ngx_http_status_module.html"
11 lang="en" 11 lang="en"
12 rev="7"> 12 rev="8">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 16 <para>
17 The <literal>ngx_http_status_module</literal> module provides 17 The <literal>ngx_http_status_module</literal> module provides
182 <list type="tag"> 182 <list type="tag">
183 183
184 <tag-name id="version"><literal>version</literal></tag-name> 184 <tag-name id="version"><literal>version</literal></tag-name>
185 <tag-desc> 185 <tag-desc>
186 Version of the provided data set. 186 Version of the provided data set.
187 The current version is 5. 187 The current version is 6.
188 </tag-desc> 188 </tag-desc>
189 189
190 <tag-name><literal>nginx_version</literal></tag-name> 190 <tag-name><literal>nginx_version</literal></tag-name>
191 <tag-desc> 191 <tag-desc>
192 Version of nginx. 192 Version of nginx.
211 <tag-name><literal>timestamp</literal></tag-name> 211 <tag-name><literal>timestamp</literal></tag-name>
212 <tag-desc> 212 <tag-desc>
213 Current time in milliseconds since Epoch. 213 Current time in milliseconds since Epoch.
214 </tag-desc> 214 </tag-desc>
215 215
216 <tag-name id="pid"><literal>pid</literal></tag-name>
217 <tag-desc>
218 The ID of the worker process that handled status request.
219 </tag-desc>
220
216 <tag-name id="processes"><literal>processes</literal></tag-name> 221 <tag-name id="processes"><literal>processes</literal></tag-name>
217 <tag-desc> 222 <tag-desc>
218 <list type="tag"> 223 <list type="tag">
219 224
220 <tag-name id="respawned"><literal>respawned</literal></tag-name> 225 <tag-name id="respawned"><literal>respawned</literal></tag-name>
246 </tag-desc> 251 </tag-desc>
247 252
248 <tag-name><literal>idle</literal></tag-name> 253 <tag-name><literal>idle</literal></tag-name>
249 <tag-desc> 254 <tag-desc>
250 The current number of idle client connections. 255 The current number of idle client connections.
256 </tag-desc>
257
258 </list>
259 </tag-desc>
260
261 <tag-name id="ssl"><literal>ssl</literal></tag-name>
262 <tag-desc>
263 <list type="tag">
264
265 <tag-name><literal>handshakes</literal></tag-name>
266 <tag-desc>
267 The total number of successful SSL handshakes.
268 </tag-desc>
269
270 <tag-name><literal>handshakes_failed</literal></tag-name>
271 <tag-desc>
272 The total number of failed SSL handshakes.
273 </tag-desc>
274
275 <tag-name><literal>session_reuses</literal></tag-name>
276 <tag-desc>
277 The total number of session reuses during SSL handshake.
251 </tag-desc> 278 </tag-desc>
252 279
253 </list> 280 </list>
254 </tag-desc> 281 </tag-desc>
255 282
309 </tag-desc> 336 </tag-desc>
310 337
311 </list> 338 </list>
312 </tag-desc> 339 </tag-desc>
313 340
341 <tag-name id="discarded"><literal>discarded</literal></tag-name>
342 <tag-desc>
343 The total number of requests completed without sending a response.
344 </tag-desc>
345
314 <tag-name><literal>received</literal></tag-name> 346 <tag-name><literal>received</literal></tag-name>
315 <tag-desc> 347 <tag-desc>
316 The total number of bytes received from clients. 348 The total number of bytes received from clients.
317 </tag-desc> 349 </tag-desc>
318 350
325 </tag-desc> 357 </tag-desc>
326 358
327 <tag-name id="upstreams"><literal>upstreams</literal></tag-name> 359 <tag-name id="upstreams"><literal>upstreams</literal></tag-name>
328 <tag-desc> 360 <tag-desc>
329 For each 361 For each
330 <link doc="ngx_http_upstream_module.xml" id="server"/>
331 in the
332 <link doc="ngx_http_upstream_module.xml" id="zone">dynamically 362 <link doc="ngx_http_upstream_module.xml" id="zone">dynamically
333 configurable</link> 363 configurable</link>
334 <link doc="ngx_http_upstream_module.xml" id="upstream">group</link>, 364 <link doc="ngx_http_upstream_module.xml" id="upstream">group</link>,
365 the following data are provided:
366 <list type="tag">
367
368 <tag-name id="peers"><literal>peers</literal></tag-name>
369 <tag-desc>
370 For each
371 <link doc="ngx_http_upstream_module.xml" id="server"/>,
335 the following data are provided: 372 the following data are provided:
336 <list type="tag"> 373 <list type="tag">
337 374
338 <tag-name id="id"><literal>id</literal></tag-name> 375 <tag-name id="id"><literal>id</literal></tag-name>
339 <tag-desc> 376 <tag-desc>
374 <tag-name><literal>active</literal></tag-name> 411 <tag-name><literal>active</literal></tag-name>
375 <tag-desc> 412 <tag-desc>
376 The current number of active connections. 413 The current number of active connections.
377 </tag-desc> 414 </tag-desc>
378 415
379 <!--
380 <tag-name><literal>keepalive</literal></tag-name>
381 <tag-desc>
382 The current number of
383 idle <link doc="ngx_http_upstream_module.xml" id="keepalive"/> connections.
384 </tag-desc>
385 -->
386
387 <tag-name id="max_conns"><literal>max_conns</literal></tag-name> 416 <tag-name id="max_conns"><literal>max_conns</literal></tag-name>
388 <tag-desc> 417 <tag-desc>
389 The <link doc="ngx_http_upstream_module.xml" id="max_conns"/> limit 418 The <link doc="ngx_http_upstream_module.xml" id="max_conns"/> limit
390 for the server. 419 for the server.
391 </tag-desc> 420 </tag-desc>
520 </tag-desc> 549 </tag-desc>
521 550
522 </list> 551 </list>
523 </tag-desc> 552 </tag-desc>
524 553
554 <tag-name><literal>keepalive</literal></tag-name>
555 <tag-desc>
556 The current number of
557 idle <link doc="ngx_http_upstream_module.xml" id="keepalive"/> connections.
558 </tag-desc>
559
560 <tag-name id="queue"><literal>queue</literal></tag-name>
561 <tag-desc>
562 For the requests <link doc="ngx_http_upstream_module.xml" id="queue"/>,
563 the following data are provided:
564 <list type="tag">
565
566 <tag-name><literal>size</literal></tag-name>
567 <tag-desc>
568 The current number of requests in the queue.
569 </tag-desc>
570
571 <tag-name id="max_size"><literal>max_size</literal></tag-name>
572 <tag-desc>
573 The maximum number of requests that can be in the queue at the same time.
574 </tag-desc>
575
576 <tag-name><literal>overflows</literal></tag-name>
577 <tag-desc>
578 The total number of requests rejected due to the queue overflow.
579 </tag-desc>
580
581 </list>
582 </tag-desc>
583
584 </list>
585 </tag-desc>
586
525 <tag-name id="caches"><literal>caches</literal></tag-name> 587 <tag-name id="caches"><literal>caches</literal></tag-name>
526 <tag-desc> 588 <tag-desc>
527 For each cache (configured by 589 For each cache (configured by
528 <link doc="ngx_http_proxy_module.xml" id="proxy_cache_path"/> and the likes): 590 <link doc="ngx_http_proxy_module.xml" id="proxy_cache_path"/> and the likes):
529 <list type="tag"> 591 <list type="tag">
640 </tag-desc> 702 </tag-desc>
641 703
642 <tag-name><literal>upstreams</literal></tag-name> 704 <tag-name><literal>upstreams</literal></tag-name>
643 <tag-desc> 705 <tag-desc>
644 For each 706 For each
645 <link doc="../stream/ngx_stream_upstream_module.xml" id="server"/>
646 in the
647 <link doc="../stream/ngx_stream_upstream_module.xml" id="zone">dynamically 707 <link doc="../stream/ngx_stream_upstream_module.xml" id="zone">dynamically
648 configurable</link> 708 configurable</link>
649 <link doc="../stream/ngx_stream_upstream_module.xml" id="upstream">group</link>, 709 <link doc="../stream/ngx_stream_upstream_module.xml" id="upstream">group</link>,
710 the following data are provided:
711 <list type="tag">
712
713 <tag-name><literal>peers</literal></tag-name>
714 <tag-desc>
715 For each
716 <link doc="../stream/ngx_stream_upstream_module.xml" id="server"/>
650 the following data are provided: 717 the following data are provided:
651 <list type="tag"> 718 <list type="tag">
652 719
653 <tag-name><literal>id</literal></tag-name> 720 <tag-name><literal>id</literal></tag-name>
654 <tag-desc> 721 <tag-desc>
804 871
805 </list> 872 </list>
806 </tag-desc> 873 </tag-desc>
807 874
808 </list> 875 </list>
876 </tag-desc>
877
878 </list>
809 </para> 879 </para>
810 880
811 </section> 881 </section>
812 882
813 <section id="compatibility" name="Compatibility"> 883 <section id="compatibility" name="Compatibility">
814 884
815 <para> 885 <para>
816 <list type="bullet"> 886 <list type="bullet">
887
888 <listitem>
889 The <link id="ssl"/> status data
890 were added in <link id="version"/> 6.
891 </listitem>
892
893 <listitem>
894 The
895 <link id="discarded"/> field in
896 <link id="server_zones"/>
897 was added in <link id="version"/> 6.
898 </listitem>
899
900 <listitem>
901 The <link id="queue"/> status data
902 were added in <link id="version"/> 6.
903 </listitem>
904
905 <listitem>
906 The
907 <link id="pid"/> field
908 was added in <link id="version"/> 6.
909 </listitem>
910
911 <listitem>
912 The list of servers in <link id="upstreams"/>
913 was moved into <link id="peers"/> in
914 <link id="version"/> 6.
915 </listitem>
817 916
818 <listitem> 917 <listitem>
819 The <literal>keepalive</literal> field of an upstream server 918 The <literal>keepalive</literal> field of an upstream server
820 was removed in <link id="version"/> 5. 919 was removed in <link id="version"/> 5.
821 </listitem> 920 </listitem>