Mercurial > hg > nginx-site

comparison xml/ru/docs/http/ngx_http_status_module.xml @ 1247:7020b8262dc0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Russian translation of ngx_http_status_module.
author Ruslan Ermilov <ru@nginx.com>
date Wed, 09 Jul 2014 13:39:09 +0400
parents
children 700487454cf2
comparison
equal deleted inserted replaced
1246:5be7716a5684 1247:7020b8262dc0
1 <?xml version="1.0"?>
2
3 <!--
4 Copyright (C) Nginx, Inc.
5 -->
6
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8
9 <module name="Модуль ngx_http_status_module"
10 link="/ru/docs/http/ngx_http_status_module.html"
11 lang="ru"
12 rev="2">
13
14 <section id="summary">
15
16 <para>
17 Модуль <literal>ngx_http_status_module</literal> предоставляет
18 доступ к информации о состоянии сервера.
19 </para>
20
21 <para>
22 <note>
23 Модуль доступен как часть
24 <commercial_version>коммерческой подписки</commercial_version>.
25 </note>
26 </para>
27
28 </section>
29
30
31 <section id="example" name="Пример конфигурации">
32
33 <para>
34 <example>
35 server {
36 location = /status {
37 status;
38 }
39
40 status_zone example_server;
41 }
42 </example>
43 </para>
44
45 <para>
46 В составе дистрибутива nginx имеется простая страница мониторинга, доступная
47 по запросу “<literal>/status.html</literal>” в стандартной конфигурации.
48 Для работы этой страницы требуется настроить
49 location “<literal>/status</literal>”, как показано выше.
50 </para>
51
52 </section>
53
54
55 <section id="directives" name="Директивы">
56
57 <directive name="status">
58 <syntax/>
59 <default/>
60 <context>location</context>
61
62 <para>
63 Информация о состоянии будет доступна из содержащего location.
64 </para>
65
66 </directive>
67
68
69 <directive name="status_format">
70 <syntax><literal>json</literal></syntax>
71 <syntax><literal>jsonp</literal> [<value>callback</value>]</syntax>
72 <default>json</default>
73 <context>http</context>
74 <context>server</context>
75 <context>location</context>
76
77 <para>
78 По умолчанию информация выводится в формате JSON.
79 </para>
80
81 <para>
82 Также данные могут выводиться в формате JSONP.
83 Параметр <value>callback</value> задаёт имя callback-функции.
84 Значение может содержать переменные.
85 Если параметр не задан или вычисленное значение является пустой строкой,
86 используется имя “<literal>ngx_status_jsonp_callback</literal>”.
87 </para>
88
89 </directive>
90
91
92 <directive name="status_zone">
93 <syntax><value>зона</value></syntax>
94 <default/>
95 <context>server</context>
96
97 <para>
98 Включает сбор информации о состоянии виртуального
99 <link doc="ngx_http_core_module.xml" id="server">сервера</link>
100 в указанной <value>зоне</value>.
101 В одной и той же зоне может одновременно собираться информация
102 сразу по нескольким виртуальным серверам.
103 </para>
104
105 </directive>
106
107 </section>
108
109
110 <section id="data" name="Данные">
111
112 <para>
113 Доступна следующая информация:
114 <list type="tag">
115
116 <tag-name><literal>version</literal></tag-name>
117 <tag-desc>
118 Версия предоставляемого набора данных.
119 Текущей является версия 2.
120 </tag-desc>
121
122 <tag-name><literal>nginx_version</literal></tag-name>
123 <tag-desc>
124 Версия nginx.
125 </tag-desc>
126
127 <tag-name><literal>address</literal></tag-name>
128 <tag-desc>
129 Адрес сервера, принявшего запрос получения информации о состоянии.
130 </tag-desc>
131
132 <tag-name><literal>load_timestamp</literal></tag-name>
133 <tag-desc>
134 Время последней перезагрузки конфигурации, в миллисекундах с начала эпохи.
135 </tag-desc>
136
137 <tag-name><literal>timestamp</literal></tag-name>
138 <tag-desc>
139 Текущее время в миллисекундах с начала эпохи.
140 </tag-desc>
141
142 <tag-name><literal>connections</literal></tag-name>
143 <tag-desc>
144 <list type="tag">
145
146 <tag-name><literal>accepted</literal></tag-name>
147 <tag-desc>
148 Суммарное число принятых клиентских соединений.
149 </tag-desc>
150
151 <tag-name><literal>dropped</literal></tag-name>
152 <tag-desc>
153 Суммарное число отвергнутых клиентских соединений.
154 </tag-desc>
155
156 <tag-name><literal>active</literal></tag-name>
157 <tag-desc>
158 Текущее число активных клиентских соединений.
159 </tag-desc>
160
161 <tag-name><literal>idle</literal></tag-name>
162 <tag-desc>
163 Текущее число бездействующих клиентских соединений.
164 </tag-desc>
165
166 </list>
167 </tag-desc>
168
169 <tag-name><literal>requests</literal></tag-name>
170 <tag-desc>
171 <list type="tag">
172
173 <tag-name><literal>total</literal></tag-name>
174 <tag-desc>
175 Суммарное число клиентских запросов.
176 </tag-desc>
177
178 <tag-name><literal>current</literal></tag-name>
179 <tag-desc>
180 Текущее число клиентских запросов.
181 </tag-desc>
182
183 </list>
184 </tag-desc>
185
186 <tag-name><literal>server_zones</literal></tag-name>
187 <tag-desc>
188 Для каждой <link id="status_zone"/>:
189 <list type="tag">
190
191 <tag-name><literal>processing</literal></tag-name>
192 <tag-desc>
193 Число обрабатываемых в настоящий момент
194 клиентских запросов.
195 </tag-desc>
196
197 <tag-name><literal>requests</literal></tag-name>
198 <tag-desc>
199 Суммарное число
200 запросов, полученных от клиентов.
201 </tag-desc>
202
203 <tag-name><literal>responses</literal></tag-name>
204 <tag-desc>
205 <list type="tag">
206
207 <tag-name><literal>total</literal></tag-name>
208 <tag-desc>
209 Суммарное число
210 ответов, отправленных клиентам.
211 </tag-desc>
212
213 <tag-name>
214 <literal>1xx</literal>,
215 <literal>2xx</literal>,
216 <literal>3xx</literal>,
217 <literal>4xx</literal>,
218 <literal>5xx</literal>
219 </tag-name>
220 <tag-desc>
221 Число ответов со статусами 1xx, 2xx, 3xx, 4xx и 5xx.
222 </tag-desc>
223
224 </list>
225 </tag-desc>
226
227 <tag-name><literal>received</literal></tag-name>
228 <tag-desc>
229 Суммарное число байт, полученных от клиентов.
230 </tag-desc>
231
232 <tag-name><literal>sent</literal></tag-name>
233 <tag-desc>
234 Суммарное число байт, отправленных клиентам.
235 </tag-desc>
236
237 </list>
238 </tag-desc>
239
240 <tag-name><literal>upstreams</literal></tag-name>
241 <tag-desc>
242 Для каждого
243 <link doc="ngx_http_upstream_module.xml" id="server">сервера</link>
244 в
245 <link doc="ngx_http_upstream_module.xml" id="zone">динамически
246 настраиваемой</link>
247 <link doc="ngx_http_upstream_module.xml" id="upstream">группе</link>
248 доступны следующие данные:
249 <list type="tag">
250
251 <tag-name><literal>server</literal></tag-name>
252 <tag-desc>
253 Адрес
254 <link doc="ngx_http_upstream_module.xml" id="server">сервера</link>.
255 </tag-desc>
256
257 <tag-name><literal>backup</literal></tag-name>
258 <tag-desc>
259 Логическое значение, означающее, является ли сервер запасным.
260 </tag-desc>
261
262 <tag-name><literal>weight</literal></tag-name>
263 <tag-desc>
264 Вес
265 <link doc="ngx_http_upstream_module.xml" id="server">сервера</link>.
266 </tag-desc>
267
268 <tag-name><literal>state</literal></tag-name>
269 <tag-desc>
270 Текущее состояние, которое может быть одним из
271 “<literal>up</literal>”,
272 “<literal>down</literal>”,
273 “<literal>unavail</literal>”
274 или
275 “<literal>unhealthy</literal>”.
276 </tag-desc>
277
278 <tag-name><literal>active</literal></tag-name>
279 <tag-desc>
280 Текущее число активных соединений.
281 </tag-desc>
282
283 <tag-name><literal>keepalive</literal></tag-name>
284 <tag-desc>
285 Текущее число бездействующих
286 <link doc="ngx_http_upstream_module.xml" id="keepalive"/>-соединений.
287 </tag-desc>
288
289 <tag-name><literal>requests</literal></tag-name>
290 <tag-desc>
291 Суммарное число
292 клиентских запросов, перенаправленных на этот сервер.
293 </tag-desc>
294
295 <tag-name><literal>responses</literal></tag-name>
296 <tag-desc>
297 <list type="tag">
298
299 <tag-name><literal>total</literal></tag-name>
300 <tag-desc>
301 Суммарное число
302 ответов, полученных от этого сервера.
303 </tag-desc>
304
305 <tag-name>
306 <literal>1xx</literal>,
307 <literal>2xx</literal>,
308 <literal>3xx</literal>,
309 <literal>4xx</literal>,
310 <literal>5xx</literal>
311 </tag-name>
312 <tag-desc>
313 Число ответов со статусами 1xx, 2xx, 3xx, 4xx и 5xx.
314 </tag-desc>
315
316 </list>
317 </tag-desc>
318
319 <tag-name><literal>sent</literal></tag-name>
320 <tag-desc>
321 Суммарное число байт, отправленных на этот сервер.
322 </tag-desc>
323
324 <tag-name><literal>received</literal></tag-name>
325 <tag-desc>
326 Суммарное число байт, полученных с этого сервера.
327 </tag-desc>
328
329 <tag-name><literal>fails</literal></tag-name>
330 <tag-desc>
331 Суммарное число
332 неудачных попыток работы с этим сервером.
333 </tag-desc>
334
335 <tag-name><literal>unavail</literal></tag-name>
336 <tag-desc>
337 Количество раз, когда
338 сервер становился недоступным для клиентских запросов
339 (состояние “<literal>unavail</literal>”)
340 из-за достижения порогового числа неудачных
341 попыток <literal>max_fails</literal>.
342 </tag-desc>
343
344 <tag-name><literal>health_checks</literal></tag-name>
345 <tag-desc>
346 <list type="tag">
347
348 <tag-name><literal>checks</literal></tag-name>
349 <tag-desc>
350 Суммарное число запросов
351 <link doc="ngx_http_upstream_module.xml" id="health_check">проверки
352 работоспособности</link>.
353 </tag-desc>
354
355 <tag-name><literal>fails</literal></tag-name>
356 <tag-desc>
357 Число неудачных проверок работоспособности.
358 </tag-desc>
359
360 <tag-name><literal>unhealthy</literal></tag-name>
361 <tag-desc>
362 Количество раз, когда
363 сервер становился неработоспособным (состояние “<literal>unhealthy</literal>”).
364 </tag-desc>
365
366 <tag-name><literal>last_passed</literal></tag-name>
367 <tag-desc>
368 Логическое значение, означающее, была ли последняя проверка
369 работоспособности удачной и удовлетворял ли ответ заданным
370 <link doc="ngx_http_upstream_module.xml" id="match">тестам</link>.
371 </tag-desc>
372
373 </list>
374 </tag-desc>
375
376 <tag-name><literal>downtime</literal></tag-name>
377 <tag-desc>
378 Суммарное время,
379 когда сервер находился в состояниях “<literal>unavail</literal>”
380 и “<literal>unhealthy</literal>”.
381 </tag-desc>
382
383 <tag-name><literal>downstart</literal></tag-name>
384 <tag-desc>
385 Время (в миллисекундах с начала эпохи),
386 когда сервер стал
387 “<literal>unavail</literal>”
388 или “<literal>unhealthy</literal>”.
389 </tag-desc>
390
391 </list>
392 </tag-desc>
393
394 <tag-name><literal>caches</literal></tag-name>
395 <tag-desc>
396 Для каждого кэша, сконфигурированного при помощи
397 <link doc="ngx_http_proxy_module.xml" id="proxy_cache_path"/>
398 и аналогичных директив:
399 <list type="tag">
400
401 <tag-name><literal>size</literal></tag-name>
402 <tag-desc>
403 Текущий размер кэша.
404 </tag-desc>
405
406 <tag-name><literal>max_size</literal></tag-name>
407 <tag-desc>
408 Ограничение на максимальный размер кэша, заданное в конфигурации.
409 </tag-desc>
410
411 <tag-name><literal>cold</literal></tag-name>
412 <tag-desc>
413 Логическое значение, указывающее, продолжается ли загрузка
414 данных процессом “cache loader” с диска в кэш.
415 </tag-desc>
416
417 <tag-name>
418 <literal>hits</literal>,
419 <literal>stale</literal>,
420 <literal>updating</literal>,
421 <literal>revalidated</literal>
422 </tag-name>
423 <tag-desc>
424 <list type="tag">
425
426 <tag-name><literal>responses</literal></tag-name>
427 <tag-desc>
428 Суммарное число ответов, прочитанных из кэша (попадания в кэш
429 или просроченные ответы вследствие
430 <link doc="ngx_http_proxy_module.xml" id="proxy_cache_use_stale"/>
431 и аналогичных директив).
432 </tag-desc>
433
434 <tag-name><literal>bytes</literal></tag-name>
435 <tag-desc>
436 Суммарное число байт, прочитанных из кэша.
437 </tag-desc>
438
439 </list>
440 </tag-desc>
441
442 <tag-name>
443 <literal>miss</literal>,
444 <literal>expired</literal>,
445 <literal>bypass</literal>
446 </tag-name>
447 <tag-desc>
448 <list type="tag">
449
450 <tag-name><literal>responses</literal></tag-name>
451 <tag-desc>
452 Суммарное число ответов, взятых не из кэша (<literal>miss</literal> —
453 отсутствие данных в кэше, <literal>expired</literal> — просроченные ответы,
454 <literal>bypass</literal> — ответ не был взят из кэша
455 вследствие <link doc="ngx_http_proxy_module.xml" id="proxy_cache_bypass"/>
456 и аналогичных директив).
457 </tag-desc>
458
459 <tag-name><literal>bytes</literal></tag-name>
460 <tag-desc>
461 Суммарное число байт, прочитанных с проксируемого сервера.
462 </tag-desc>
463
464 <tag-name><literal>responses_written</literal></tag-name>
465 <tag-desc>
466 Суммарное число ответов, записанных в кэш.
467 </tag-desc>
468
469 <tag-name><literal>bytes_written</literal></tag-name>
470 <tag-desc>
471 Суммарное число байт, записанных в кэш.
472 </tag-desc>
473
474 </list>
475 </tag-desc>
476
477 </list>
478 </tag-desc>
479
480 </list>
481 </para>
482
483 </section>
484
485 </module>