# HG changeset patch # User Yaroslav Zhuravlev # Date 1405935521 -14400 # Node ID 6e34b5716bdb78c09974c91a81f278a059617c31 # Parent 954dcc02cb6338e3079e24b9c0c2b8b091088132 Documented the stub_status module. diff --git a/xml/en/GNUmakefile b/xml/en/GNUmakefile --- a/xml/en/GNUmakefile +++ b/xml/en/GNUmakefile @@ -76,6 +76,7 @@ REFS = \ http/ngx_http_ssi_module \ http/ngx_http_ssl_module \ http/ngx_http_status_module \ + http/ngx_http_stub_status_module \ http/ngx_http_sub_module \ http/ngx_http_upstream_module \ http/ngx_http_userid_module \ diff --git a/xml/en/docs/http/ngx_http_stub_status_module.xml b/xml/en/docs/http/ngx_http_stub_status_module.xml new file mode 100644 --- /dev/null +++ b/xml/en/docs/http/ngx_http_stub_status_module.xml @@ -0,0 +1,157 @@ + + + + + + + + +
+ + +The 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 +--with-http_stub_status_module +configuration parameter. + + +
+ + +
+ + + +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 + + + +
+ + +
+ + + + +location + + +The basic status information will be accessible from the surrounding location. + + + + +
+ + +
+ + +The following status information is provided: + + +Active connections + +The current number of active client connections +including Waiting connections. + + +accepts + +The total number of accepted client connections. + + +handled + +The total number of handled connections. +Generally, the parameter value is the same as accepts +unless some resource limits have been reached +(for example, the + limit). + + +requests + +The total number of client requests. + + +Reading + +The current number of connections where nginx is reading the request header. + + +Writing + +The current number of connections +where nginx is writing the response back to the client. + + +Waiting + +The current number of idle client connections waiting for a request. + + + + + +
+ + +
+ + +The ngx_http_stub_status_module module +supports the following embedded variables (1.3.14): + + +$connections_active + +same as the Active connections value; + + +$connections_reading + +same as the Reading value; + + +$connections_writing + +same as the Writing value; + + +$connections_waiting + +same as the Waiting value. + + + + + +
+ + diff --git a/xml/en/docs/index.xml b/xml/en/docs/index.xml --- a/xml/en/docs/index.xml +++ b/xml/en/docs/index.xml @@ -373,6 +373,11 @@ ngx_http_status_module + +ngx_http_stub_status_module + + + ngx_http_sub_module diff --git a/xml/ru/GNUmakefile b/xml/ru/GNUmakefile --- a/xml/ru/GNUmakefile +++ b/xml/ru/GNUmakefile @@ -65,6 +65,7 @@ REFS = \ http/ngx_http_ssi_module \ http/ngx_http_ssl_module \ http/ngx_http_status_module \ + http/ngx_http_stub_status_module \ http/ngx_http_sub_module \ http/ngx_http_upstream_module \ http/ngx_http_userid_module \ diff --git a/xml/ru/docs/http/ngx_http_stub_status_module.xml b/xml/ru/docs/http/ngx_http_stub_status_module.xml new file mode 100644 --- /dev/null +++ b/xml/ru/docs/http/ngx_http_stub_status_module.xml @@ -0,0 +1,158 @@ + + + + + + + + +
+ + +Модуль ngx_http_stub_status_module предоставляет +доступ к базовой информации о состоянии сервера. + + + +По умолчанию этот модуль не собирается, его сборку необходимо +разрешить с помощью конфигурационного параметра +--with-http_stub_status_module. + + +
+ + +
+ + + +location /basic_status { + stub_status; +} + +В данной конфигурации создаётся простая веб-страница +с основной информацией о состоянии, которая может выглядеть следующим образом: + +Active connections: 291 +server accepts handled requests + 16630948 16630948 31070465 +Reading: 6 Writing: 179 Waiting: 106 + + + +
+ + +
+ + + + +location + + +Информация о состоянии будет доступна из данного location. + + + + +
+ + +
+ + +Доступна следующая информация: + + +Active connections + +Текущее число активных клиентских соединений, +включая Waiting-соединения. + + +accepts + +Суммарное число принятых клиентских соединений. + + +handled + +Суммарное число обработанных соединений. +Как правило, значение этого параметра такое же, как accepts, +если не достигнуто какое-нибудь системное ограничение +(например, лимит +). + + +requests + +Суммарное число клиентских запросов. + + +Reading + +Текущее число соединений, +в которых nginx в настоящий момент читает заголовок запроса. + + +Writing + +Текущее число соединений, +в которых nginx в настоящий момент отвечает клиенту. + + +Waiting + +Текущее число бездействующих клиентских соединений в ожидании запроса. + + + + + +
+ + +
+ + +Модуль ngx_http_stub_status_module +поддерживает следующие встроенные переменные (1.3.14): + + +$connections_active + +то же, что и значение Active connections; + + +$connections_reading + +то же, что и значение Reading; + + +$connections_writing + +то же, что и значение Writing; + + +$connections_waiting + +то же, что и значение Waiting. + + + + + +
+ + diff --git a/xml/ru/docs/index.xml b/xml/ru/docs/index.xml --- a/xml/ru/docs/index.xml +++ b/xml/ru/docs/index.xml @@ -347,6 +347,11 @@ ngx_http_status_module + +ngx_http_stub_status_module + + + ngx_http_sub_module