Mercurial > hg > nginx-site
comparison xml/en/docs/http/ngx_http_status_module.xml @ 1925:a58b35cc0823
Updated docs for the upcoming NGINX Plus release.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Wed, 08 Mar 2017 18:05:46 +0300 |
parents | 56b6244ddadb |
children | 96232cc8a0b7 |
comparison
equal
deleted
inserted
replaced
1924:237a10fb98d2 | 1925:a58b35cc0823 |
---|---|
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="12"> | 12 rev="13"> |
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 7. | 187 The current version is 8. |
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. |
193 </tag-desc> | |
194 | |
195 <tag-name id="nginx_build"><literal>nginx_build</literal></tag-name> | |
196 <tag-desc> | |
197 Name of nginx build. | |
193 </tag-desc> | 198 </tag-desc> |
194 | 199 |
195 <tag-name><literal>address</literal></tag-name> | 200 <tag-name><literal>address</literal></tag-name> |
196 <tag-desc> | 201 <tag-desc> |
197 The address of the server that accepted status request. | 202 The address of the server that accepted status request. |
214 </tag-desc> | 219 </tag-desc> |
215 | 220 |
216 <tag-name id="pid"><literal>pid</literal></tag-name> | 221 <tag-name id="pid"><literal>pid</literal></tag-name> |
217 <tag-desc> | 222 <tag-desc> |
218 The ID of the worker process that handled status request. | 223 The ID of the worker process that handled status request. |
224 </tag-desc> | |
225 | |
226 <tag-name id="ppid"><literal>ppid</literal></tag-name> | |
227 <tag-desc> | |
228 The ID of the master process that started | |
229 the <link id="pid">worker process</link>. | |
219 </tag-desc> | 230 </tag-desc> |
220 | 231 |
221 <tag-name id="processes"><literal>processes</literal></tag-name> | 232 <tag-name id="processes"><literal>processes</literal></tag-name> |
222 <tag-desc> | 233 <tag-desc> |
223 <list type="tag"> | 234 <list type="tag"> |
354 </tag-desc> | 365 </tag-desc> |
355 | 366 |
356 </list> | 367 </list> |
357 </tag-desc> | 368 </tag-desc> |
358 | 369 |
370 <tag-name id="slabs"><literal>slabs</literal></tag-name> | |
371 <tag-desc> | |
372 For each shared memory zone that uses slab allocator: | |
373 <list type="tag"> | |
374 | |
375 <tag-name><literal>pages</literal></tag-name> | |
376 <tag-desc> | |
377 <list type="tag"> | |
378 | |
379 <tag-name><literal>used</literal></tag-name> | |
380 <tag-desc> | |
381 The current number of used memory pages. | |
382 </tag-desc> | |
383 | |
384 <tag-name><literal>free</literal></tag-name> | |
385 <tag-desc> | |
386 The current number of free memory pages. | |
387 </tag-desc> | |
388 | |
389 </list> | |
390 </tag-desc> | |
391 | |
392 <tag-name><literal>slots</literal></tag-name> | |
393 <tag-desc> | |
394 For each memory slot size (8, 16, 32, 64, 128, etc.) | |
395 the following data are provided: | |
396 <list type="tag"> | |
397 | |
398 <tag-name><literal>used</literal></tag-name> | |
399 <tag-desc> | |
400 The current number of used memory slots. | |
401 </tag-desc> | |
402 | |
403 <tag-name><literal>free</literal></tag-name> | |
404 <tag-desc> | |
405 The current number of free memory slots. | |
406 </tag-desc> | |
407 | |
408 <tag-name><literal>reqs</literal></tag-name> | |
409 <tag-desc> | |
410 The total number of attempts to allocate memory of specified size. | |
411 </tag-desc> | |
412 | |
413 <tag-name><literal>fails</literal></tag-name> | |
414 <tag-desc> | |
415 The number of unsuccessful attempts to allocate memory of specified size. | |
416 </tag-desc> | |
417 | |
418 </list> | |
419 </tag-desc> | |
420 | |
421 </list> | |
422 </tag-desc> | |
423 | |
359 <tag-name id="upstreams"><literal>upstreams</literal></tag-name> | 424 <tag-name id="upstreams"><literal>upstreams</literal></tag-name> |
360 <tag-desc> | 425 <tag-desc> |
361 For each | 426 For each |
362 <link doc="ngx_http_upstream_module.xml" id="zone">dynamically | 427 <link doc="ngx_http_upstream_module.xml" id="zone">dynamically |
363 configurable</link> | 428 configurable</link> |
382 An | 447 An |
383 <link doc="ngx_http_upstream_module.xml" id="server">address</link> | 448 <link doc="ngx_http_upstream_module.xml" id="server">address</link> |
384 of the server. | 449 of the server. |
385 </tag-desc> | 450 </tag-desc> |
386 | 451 |
452 <tag-name id="name"><literal>name</literal></tag-name> | |
453 <tag-desc> | |
454 The name of the server specified in the | |
455 <link doc="ngx_http_upstream_module.xml" id="server"/> | |
456 directive. | |
457 </tag-desc> | |
458 | |
459 <tag-name id="service"><literal>service</literal></tag-name> | |
460 <tag-desc> | |
461 The <link doc="ngx_http_upstream_module.xml" id="service"/> | |
462 parameter value of the | |
463 <link doc="ngx_http_upstream_module.xml" id="server"/> directive. | |
464 </tag-desc> | |
465 | |
387 <tag-name><literal>backup</literal></tag-name> | 466 <tag-name><literal>backup</literal></tag-name> |
388 <tag-desc> | 467 <tag-desc> |
389 A boolean value indicating whether the server is a | 468 A boolean value indicating whether the server is a |
390 <link doc="ngx_http_upstream_module.xml" id="backup"/> | 469 <link doc="ngx_http_upstream_module.xml" id="backup"/> |
391 server. | 470 server. |
402 Current state, which may be one of | 481 Current state, which may be one of |
403 “<literal>up</literal>”, | 482 “<literal>up</literal>”, |
404 “<literal>draining</literal>”, | 483 “<literal>draining</literal>”, |
405 “<literal>down</literal>”, | 484 “<literal>down</literal>”, |
406 “<literal>unavail</literal>”, | 485 “<literal>unavail</literal>”, |
486 “<literal>checking</literal>”, | |
407 or | 487 or |
408 “<literal>unhealthy</literal>”. | 488 “<literal>unhealthy</literal>”. |
409 </tag-desc> | 489 </tag-desc> |
410 | 490 |
411 <tag-name><literal>active</literal></tag-name> | 491 <tag-name><literal>active</literal></tag-name> |
508 </tag-desc> | 588 </tag-desc> |
509 | 589 |
510 <tag-name><literal>downtime</literal></tag-name> | 590 <tag-name><literal>downtime</literal></tag-name> |
511 <tag-desc> | 591 <tag-desc> |
512 Total time | 592 Total time |
513 the server was in the “<literal>unavail</literal>” | 593 the server was in the “<literal>unavail</literal>”, |
514 and “<literal>unhealthy</literal>” states. | 594 “<literal>checking</literal>”, and “<literal>unhealthy</literal>” states. |
515 </tag-desc> | 595 </tag-desc> |
516 | 596 |
517 <tag-name><literal>downstart</literal></tag-name> | 597 <tag-name><literal>downstart</literal></tag-name> |
518 <tag-desc> | 598 <tag-desc> |
519 The time (in milliseconds since Epoch) | 599 The time (in milliseconds since Epoch) |
520 when the server became | 600 when the server became |
521 “<literal>unavail</literal>” | 601 “<literal>unavail</literal>”, |
522 or “<literal>unhealthy</literal>”. | 602 “<literal>checking</literal>”, or “<literal>unhealthy</literal>”. |
523 </tag-desc> | 603 </tag-desc> |
524 | 604 |
525 <tag-name id="selected"><literal>selected</literal></tag-name> | 605 <tag-name id="selected"><literal>selected</literal></tag-name> |
526 <tag-desc> | 606 <tag-desc> |
527 The time (in milliseconds since Epoch) | 607 The time (in milliseconds since Epoch) |
561 <tag-desc> | 641 <tag-desc> |
562 The current number of servers removed | 642 The current number of servers removed |
563 from the group but still processing active client requests. | 643 from the group but still processing active client requests. |
564 </tag-desc> | 644 </tag-desc> |
565 | 645 |
646 <tag-name id="zone"><literal>zone</literal></tag-name> | |
647 <tag-desc> | |
648 The name of the shared memory | |
649 <link doc="ngx_http_upstream_module.xml" id="zone"/> | |
650 that keeps the group’s configuration and run-time state. | |
651 </tag-desc> | |
652 | |
566 <tag-name id="queue"><literal>queue</literal></tag-name> | 653 <tag-name id="queue"><literal>queue</literal></tag-name> |
567 <tag-desc> | 654 <tag-desc> |
568 For the requests <link doc="ngx_http_upstream_module.xml" id="queue"/>, | 655 For the requests <link doc="ngx_http_upstream_module.xml" id="queue"/>, |
569 the following data are provided: | 656 the following data are provided: |
570 <list type="tag"> | 657 <list type="tag"> |
733 </tag-desc> | 820 </tag-desc> |
734 | 821 |
735 </list> | 822 </list> |
736 </tag-desc> | 823 </tag-desc> |
737 | 824 |
738 <tag-name><literal>upstreams</literal></tag-name> | 825 <tag-name id="stream_upstreams"><literal>upstreams</literal></tag-name> |
739 <tag-desc> | 826 <tag-desc> |
740 For each | 827 For each |
741 <link doc="../stream/ngx_stream_upstream_module.xml" id="zone">dynamically | 828 <link doc="../stream/ngx_stream_upstream_module.xml" id="zone">dynamically |
742 configurable</link> | 829 configurable</link> |
743 <link doc="../stream/ngx_stream_upstream_module.xml" id="upstream">group</link>, | 830 <link doc="../stream/ngx_stream_upstream_module.xml" id="upstream">group</link>, |
761 An | 848 An |
762 <link doc="../stream/ngx_stream_upstream_module.xml" id="server">address</link> | 849 <link doc="../stream/ngx_stream_upstream_module.xml" id="server">address</link> |
763 of the server. | 850 of the server. |
764 </tag-desc> | 851 </tag-desc> |
765 | 852 |
853 | |
854 <tag-name id="stream_name"><literal>name</literal></tag-name> | |
855 <tag-desc> | |
856 The name of the server specified in the | |
857 <link doc="../stream/ngx_stream_upstream_module.xml" id="server"/> directive. | |
858 </tag-desc> | |
859 | |
860 <tag-name id="stream_service"><literal>service</literal></tag-name> | |
861 <tag-desc> | |
862 The <link doc="../stream/ngx_stream_upstream_module.xml" id="service"/> | |
863 parameter value of the | |
864 <link doc="../stream/ngx_stream_upstream_module.xml" id="server"/> directive. | |
865 </tag-desc> | |
866 | |
766 <tag-name><literal>backup</literal></tag-name> | 867 <tag-name><literal>backup</literal></tag-name> |
767 <tag-desc> | 868 <tag-desc> |
768 A boolean value indicating whether the server is a | 869 A boolean value indicating whether the server is a |
769 <link doc="../stream/ngx_stream_upstream_module.xml" id="backup"/> | 870 <link doc="../stream/ngx_stream_upstream_module.xml" id="backup"/> |
770 server. | 871 server. |
780 <tag-desc> | 881 <tag-desc> |
781 Current state, which may be one of | 882 Current state, which may be one of |
782 “<literal>up</literal>”, | 883 “<literal>up</literal>”, |
783 “<literal>down</literal>”, | 884 “<literal>down</literal>”, |
784 “<literal>unavail</literal>”, | 885 “<literal>unavail</literal>”, |
886 “<literal>checking</literal>”, | |
785 or | 887 or |
786 “<literal>unhealthy</literal>”. | 888 “<literal>unhealthy</literal>”. |
787 </tag-desc> | 889 </tag-desc> |
788 | 890 |
789 <tag-name><literal>active</literal></tag-name> | 891 <tag-name><literal>active</literal></tag-name> |
880 </tag-desc> | 982 </tag-desc> |
881 | 983 |
882 <tag-name><literal>downtime</literal></tag-name> | 984 <tag-name><literal>downtime</literal></tag-name> |
883 <tag-desc> | 985 <tag-desc> |
884 Total time | 986 Total time |
885 the server was in the “<literal>unavail</literal>” | 987 the server was in the “<literal>unavail</literal>”, |
886 and “<literal>unhealthy</literal>” states. | 988 “<literal>checking</literal>”, and “<literal>unhealthy</literal>” states. |
887 </tag-desc> | 989 </tag-desc> |
888 | 990 |
889 <tag-name><literal>downstart</literal></tag-name> | 991 <tag-name><literal>downstart</literal></tag-name> |
890 <tag-desc> | 992 <tag-desc> |
891 The time (in milliseconds since Epoch) | 993 The time (in milliseconds since Epoch) |
892 when the server became | 994 when the server became |
893 “<literal>unavail</literal>” | 995 “<literal>unavail</literal>”, |
894 or “<literal>unhealthy</literal>”. | 996 “<literal>checking</literal>”, or “<literal>unhealthy</literal>”. |
895 </tag-desc> | 997 </tag-desc> |
896 | 998 |
897 <tag-name><literal>selected</literal></tag-name> | 999 <tag-name><literal>selected</literal></tag-name> |
898 <tag-desc> | 1000 <tag-desc> |
899 The time (in milliseconds since Epoch) | 1001 The time (in milliseconds since Epoch) |
901 </tag-desc> | 1003 </tag-desc> |
902 | 1004 |
903 </list> | 1005 </list> |
904 </tag-desc> | 1006 </tag-desc> |
905 | 1007 |
1008 <tag-name><literal>zombies</literal></tag-name> | |
1009 <tag-desc> | |
1010 The current number of servers removed | |
1011 from the group but still processing active client connections. | |
1012 </tag-desc> | |
1013 | |
1014 <tag-name><literal>zone</literal></tag-name> | |
1015 <tag-desc> | |
1016 The name of the shared memory | |
1017 <link doc="../stream/ngx_stream_upstream_module.xml" id="zone"/> | |
1018 that keeps the group’s configuration and run-time state. | |
1019 </tag-desc> | |
1020 | |
906 </list> | 1021 </list> |
907 </tag-desc> | 1022 </tag-desc> |
908 | 1023 |
909 </list> | 1024 </list> |
910 </tag-desc> | 1025 </tag-desc> |
916 | 1031 |
917 <section id="compatibility" name="Compatibility"> | 1032 <section id="compatibility" name="Compatibility"> |
918 | 1033 |
919 <para> | 1034 <para> |
920 <list type="bullet"> | 1035 <list type="bullet"> |
1036 | |
1037 <listitem> | |
1038 The | |
1039 <link id="zone"/> field in | |
1040 <link id="upstreams">http</link> and <link id="stream_upstreams">stream</link> | |
1041 upstreams | |
1042 was added in <link id="version"/> 8. | |
1043 </listitem> | |
1044 | |
1045 <listitem> | |
1046 The <link id="slabs"/> status data | |
1047 were added in <link id="version"/> 8. | |
1048 </listitem> | |
1049 | |
1050 <listitem> | |
1051 The | |
1052 <link id="state">checking</link> state | |
1053 was added in <link id="version"/> 8. | |
1054 </listitem> | |
1055 | |
1056 <listitem> | |
1057 The | |
1058 <link id="name"/> and <link id="service"/> fields in | |
1059 <link id="upstreams">http</link> and <link id="stream_upstreams">stream</link> | |
1060 upstreams | |
1061 were added in <link id="version"/> 8. | |
1062 </listitem> | |
1063 | |
1064 <listitem> | |
1065 The | |
1066 <link id="nginx_build"/> and <link id="ppid"/> fields | |
1067 were added in <link id="version"/> 8. | |
1068 </listitem> | |
921 | 1069 |
922 <listitem> | 1070 <listitem> |
923 The | 1071 The |
924 <link id="sessions"/> status data | 1072 <link id="sessions"/> status data |
925 and the <link id="stream_discarded">discarded</link> field in | 1073 and the <link id="stream_discarded">discarded</link> field in |