pod/nginx/ngx_http_stub_status_module.pod


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230

=encoding utf-8

=head1 NAME

ngx_http_stub_status_module - Module ngx_http_stub_status_module


=head1


The C<ngx_http_stub_status_module> module provides
access to basic status information.


This module is not built by default, it should be enabled with the
C<--with-http_stub_status_module>
configuration parameter.


=head1 Example Configuration


    location = /basic_status {
        stub_status;
    }


This configuration creates a simple web page
with basic status data which may look like as follows:

    
    Active connections: 291
    server accepts handled requests
     16630948 16630948 31070465
    Reading: 6 Writing: 179 Waiting: 106


=head1 Directives

=head2 stub_status


B<context:> I<server>


B<context:> I<location>


The basic status information will be accessible from the surrounding location.


B<NOTE>

In versions prior to 1.7.5,
the directive syntax required an arbitrary argument, for example,
“C<stub_status on>”.


=head1 Data


The following status information is provided:

=over


=item C<Active connections>


The current number of active client connections
including C<Waiting> connections.


=item C<accepts>


The total number of accepted client connections.


=item C<handled>


The total number of handled connections.
Generally, the parameter value is the same as C<accepts>
unless some resource limits have been reached
(for example, the
L<ngx_core_module> limit).


=item C<requests>


The total number of client requests.


=item C<Reading>


The current number of connections where nginx is reading the request header.


=item C<Writing>


The current number of connections
where nginx is writing the response back to the client.


=item C<Waiting>


The current number of idle client connections waiting for a request.


=back


=head1 Embedded Variables


The C<ngx_http_stub_status_module> module
supports the following embedded variables (1.3.14):

=over


=item C<$connections_active>


same as the C<Active connections> value;


=item C<$connections_reading>


same as the C<Reading> value;


=item C<$connections_writing>


same as the C<Writing> value;


=item C<$connections_waiting>


same as the C<Waiting> value.


=back