Mercurial > hg > nginx-site
comparison xml/en/docs/http/ngx_http_stub_status_module.xml @ 1260:6e34b5716bdb
Documented the stub_status module.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Mon, 21 Jul 2014 13:38:41 +0400 |
parents | |
children | bb647c5e4ead |
comparison
equal
deleted
inserted
replaced
1259:954dcc02cb63 | 1260:6e34b5716bdb |
---|---|
1 <?xml version="1.0"?> | |
2 | |
3 <!-- | |
4 Copyright (C) Yaroslav Zhuravlev | |
5 Copyright (C) Nginx, Inc. | |
6 --> | |
7 | |
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> | |
9 | |
10 <module name="Module ngx_http_stub_status_module" | |
11 link="/en/docs/http/ngx_http_stub_status_module.html" | |
12 lang="en" | |
13 rev="1"> | |
14 | |
15 <section id="summary"> | |
16 | |
17 <para> | |
18 The <literal>ngx_http_stub_status_module</literal> module provides | |
19 access to basic status information. | |
20 </para> | |
21 | |
22 <para> | |
23 This module is not built by default, it should be enabled with the | |
24 <literal>--with-http_stub_status_module</literal> | |
25 configuration parameter. | |
26 </para> | |
27 | |
28 </section> | |
29 | |
30 | |
31 <section id="example" name="Example Configuration"> | |
32 | |
33 <para> | |
34 <example> | |
35 location /basic_status { | |
36 stub_status; | |
37 } | |
38 </example> | |
39 This configuration creates a simple web page | |
40 with basic status data which may look like as follows: | |
41 <example> | |
42 Active connections: 291 | |
43 server accepts handled requests | |
44 16630948 16630948 31070465 | |
45 Reading: 6 Writing: 179 Waiting: 106 | |
46 </example> | |
47 </para> | |
48 | |
49 </section> | |
50 | |
51 | |
52 <section id="directives" name="Directives"> | |
53 | |
54 <directive name="stub_status"> | |
55 <syntax/> | |
56 <default/> | |
57 <context>location</context> | |
58 | |
59 <para> | |
60 The basic status information will be accessible from the surrounding location. | |
61 </para> | |
62 | |
63 </directive> | |
64 | |
65 </section> | |
66 | |
67 | |
68 <section id="data" name="Data"> | |
69 | |
70 <para> | |
71 The following status information is provided: | |
72 <list type="tag"> | |
73 | |
74 <tag-name id="stubstat_active"><literal>Active connections</literal></tag-name> | |
75 <tag-desc> | |
76 The current number of active client connections | |
77 including <literal>Waiting</literal> connections. | |
78 </tag-desc> | |
79 | |
80 <tag-name id="stubstat_accepts"><literal>accepts</literal></tag-name> | |
81 <tag-desc> | |
82 The total number of accepted client connections. | |
83 </tag-desc> | |
84 | |
85 <tag-name id="stubstat_handled"><literal>handled</literal></tag-name> | |
86 <tag-desc> | |
87 The total number of handled connections. | |
88 Generally, the parameter value is the same as <literal>accepts</literal> | |
89 unless some resource limits have been reached | |
90 (for example, the | |
91 <link doc="../ngx_core_module.xml" id="worker_connections"/> limit). | |
92 </tag-desc> | |
93 | |
94 <tag-name id="stubstat_requests"><literal>requests</literal></tag-name> | |
95 <tag-desc> | |
96 The total number of client requests. | |
97 </tag-desc> | |
98 | |
99 <tag-name id="stubstat_reading"><literal>Reading</literal></tag-name> | |
100 <tag-desc> | |
101 The current number of connections where nginx is reading the request header. | |
102 </tag-desc> | |
103 | |
104 <tag-name id="stubstat_writing"><literal>Writing</literal></tag-name> | |
105 <tag-desc> | |
106 The current number of connections | |
107 where nginx is writing the response back to the client. | |
108 </tag-desc> | |
109 | |
110 <tag-name id="stubstat_waiting"><literal>Waiting</literal></tag-name> | |
111 <tag-desc> | |
112 The current number of idle client connections waiting for a request. | |
113 </tag-desc> | |
114 | |
115 </list> | |
116 </para> | |
117 | |
118 </section> | |
119 | |
120 | |
121 <section id="variables" name="Embedded Variables"> | |
122 | |
123 <para> | |
124 The <literal>ngx_http_stub_status_module</literal> module | |
125 supports the following embedded variables (1.3.14): | |
126 <list type="tag"> | |
127 | |
128 <tag-name | |
129 id="var_connections_active"><var>$connections_active</var></tag-name> | |
130 <tag-desc> | |
131 same as the <literal>Active connections</literal> value; | |
132 </tag-desc> | |
133 | |
134 <tag-name | |
135 id="var_connections_reading"><var>$connections_reading</var></tag-name> | |
136 <tag-desc> | |
137 same as the <literal>Reading</literal> value; | |
138 </tag-desc> | |
139 | |
140 <tag-name | |
141 id="var_connections_writing"><var>$connections_writing</var></tag-name> | |
142 <tag-desc> | |
143 same as the <literal>Writing</literal> value; | |
144 </tag-desc> | |
145 | |
146 <tag-name | |
147 id="var_connections_waiting"><var>$connections_waiting</var></tag-name> | |
148 <tag-desc> | |
149 same as the <literal>Waiting</literal> value. | |
150 </tag-desc> | |
151 | |
152 </list> | |
153 </para> | |
154 | |
155 </section> | |
156 | |
157 </module> |