Mercurial > hg > nginx-site

comparison xml/ru/docs/http/ngx_http_stub_status_module.xml @ 1260:6e34b5716bdb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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="Модуль ngx_http_stub_status_module"
11 link="/ru/docs/http/ngx_http_stub_status_module.html"
12 lang="ru"
13 rev="1">
14
15 <section id="summary">
16
17 <para>
18 Модуль <literal>ngx_http_stub_status_module</literal> предоставляет
19 доступ к базовой информации о состоянии сервера.
20 </para>
21
22 <para>
23 По умолчанию этот модуль не собирается, его сборку необходимо
24 разрешить с помощью конфигурационного параметра
25 <literal>--with-http_stub_status_module</literal>.
26 </para>
27
28 </section>
29
30
31 <section id="example" name="Пример конфигурации">
32
33 <para>
34 <example>
35 location /basic_status {
36 stub_status;
37 }
38 </example>
39 В данной конфигурации создаётся простая веб-страница
40 с основной информацией о состоянии, которая может выглядеть следующим образом:
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="Директивы">
53
54 <directive name="stub_status">
55 <syntax/>
56 <default/>
57 <context>location</context>
58
59 <para>
60 Информация о состоянии будет доступна из данного location.
61 </para>
62
63 </directive>
64
65 </section>
66
67
68 <section id="data" name="Данные">
69
70 <para>
71 Доступна следующая информация:
72 <list type="tag">
73
74 <tag-name id="stubstat_active"><literal>Active connections</literal></tag-name>
75 <tag-desc>
76 Текущее число активных клиентских соединений,
77 включая <literal>Waiting</literal>-соединения.
78 </tag-desc>
79
80 <tag-name id="stubstat_accepts"><literal>accepts</literal></tag-name>
81 <tag-desc>
82 Суммарное число принятых клиентских соединений.
83 </tag-desc>
84
85 <tag-name id="stubstat_handled"><literal>handled</literal></tag-name>
86 <tag-desc>
87 Суммарное число обработанных соединений.
88 Как правило, значение этого параметра такое же, как <literal>accepts</literal>,
89 если не достигнуто какое-нибудь системное ограничение
90 (например, лимит
91 <link doc="../ngx_core_module.xml" id="worker_connections"/>).
92 </tag-desc>
93
94 <tag-name id="stubstat_requests"><literal>requests</literal></tag-name>
95 <tag-desc>
96 Суммарное число клиентских запросов.
97 </tag-desc>
98
99 <tag-name id="stubstat_reading"><literal>Reading</literal></tag-name>
100 <tag-desc>
101 Текущее число соединений,
102 в которых nginx в настоящий момент читает заголовок запроса.
103 </tag-desc>
104
105 <tag-name id="stubstat_writing"><literal>Writing</literal></tag-name>
106 <tag-desc>
107 Текущее число соединений,
108 в которых nginx в настоящий момент отвечает клиенту.
109 </tag-desc>
110
111 <tag-name id="stubstat_waiting"><literal>Waiting</literal></tag-name>
112 <tag-desc>
113 Текущее число бездействующих клиентских соединений в ожидании запроса.
114 </tag-desc>
115
116 </list>
117 </para>
118
119 </section>
120
121
122 <section id="variables" name="Встроенные переменные">
123
124 <para>
125 Модуль <literal>ngx_http_stub_status_module</literal>
126 поддерживает следующие встроенные переменные (1.3.14):
127 <list type="tag">
128
129 <tag-name
130 id="var_connections_active"><var>$connections_active</var></tag-name>
131 <tag-desc>
132 то же, что и значение <literal>Active connections</literal>;
133 </tag-desc>
134
135 <tag-name
136 id="var_connections_reading"><var>$connections_reading</var></tag-name>
137 <tag-desc>
138 то же, что и значение <literal>Reading</literal>;
139 </tag-desc>
140
141 <tag-name
142 id="var_connections_writing"><var>$connections_writing</var></tag-name>
143 <tag-desc>
144 то же, что и значение <literal>Writing</literal>;
145 </tag-desc>
146
147 <tag-name
148 id="var_connections_waiting"><var>$connections_waiting</var></tag-name>
149 <tag-desc>
150 то же, что и значение <literal>Waiting</literal>.
151 </tag-desc>
152
153 </list>
154 </para>
155
156 </section>
157
158 </module>