changeset 1258:700487454cf2

Status: documented the query API implementation.
author Yaroslav Zhuravlev <yar@nginx.com>
date Thu, 10 Jul 2014 15:33:59 +0400
parents ac7a5ee98768
children 954dcc02cb63
files xml/en/docs/http/ngx_http_status_module.xml xml/ru/docs/http/ngx_http_status_module.xml
diffstat 2 files changed, 96 insertions(+), 10 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_status_module.xml
+++ b/xml/en/docs/http/ngx_http_status_module.xml
@@ -9,7 +9,7 @@
 <module name="Module ngx_http_status_module"
         link="/en/docs/http/ngx_http_status_module.html"
         lang="en"
-        rev="2">
+        rev="3">
 
 <section id="summary">
 
@@ -32,21 +32,63 @@ This module is available as part of our
 
 <para>
 <example>
+upstream <emphasis>backend</emphasis> {
+    <emphasis>zone</emphasis> upstream_backend 64k;
+
+    server backend1.example.com weight=5;
+    server backend2.example.com;
+}
+
+proxy_cache_path /data/nginx/cache_backend keys_zone=<emphasis>cache_backend</emphasis>:10m;
+
 server {
-    location = /status {
+    server_name backend.example.com;
+
+    location / {
+        proxy_pass http://backend;
+        proxy_cache cache_backend;
+
+        health_check;
+    }
+
+    <emphasis>status_zone server_backend;</emphasis>
+}
+
+server {
+    listen 127.0.0.1;
+
+    location /upstream_conf {
+        upstream_conf;
+    }
+
+    location /status {
         status;
     }
 
-    status_zone example_server;
+    location = /status.html {
+    }
 }
 </example>
 </para>
 
 <para>
+Examples of status requests with this configuration:
+<example>
+http://127.0.0.1/status
+http://127.0.0.1/status/nginx_version
+http://127.0.0.1/status/caches/cache_backend
+http://127.0.0.1/status/upstreams
+http://127.0.0.1/status/upstreams/backend
+http://127.0.0.1/status/upstreams/backend/1
+http://127.0.0.1/status/upstreams/backend/1/weight
+</example>
+</para>
+
+<para>
 The simple monitoring page is shipped with this distribution,
 accessible as “<literal>/status.html</literal>” in the default configuration.
-It requires the location “<literal>/status</literal>” to be configured
-as shown above.
+It requires the locations “<literal>/status</literal>” and
+“<literal>/status.html</literal>” to be configured as shown above.
 </para>
 
 </section>
--- a/xml/ru/docs/http/ngx_http_status_module.xml
+++ b/xml/ru/docs/http/ngx_http_status_module.xml
@@ -9,7 +9,7 @@
 <module name="Модуль ngx_http_status_module"
         link="/ru/docs/http/ngx_http_status_module.html"
         lang="ru"
-        rev="2">
+        rev="3">
 
 <section id="summary">
 
@@ -32,21 +32,65 @@
 
 <para>
 <example>
+upstream <emphasis>backend</emphasis> {
+    <emphasis>zone</emphasis> upstream_backend 64k;
+
+    server backend1.example.com weight=5;
+    server backend2.example.com;
+}
+
+proxy_cache_path /data/nginx/cache_backend keys_zone=<emphasis>cache_backend</emphasis>:10m;
+
 server {
-    location = /status {
+    server_name backend.example.com;
+
+    location / {
+        proxy_pass http://backend;
+        proxy_cache cache_backend;
+
+        health_check;
+    }
+
+    <emphasis>status_zone server_backend;</emphasis>
+}
+
+server {
+    listen 127.0.0.1;
+
+    location /upstream_conf {
+        upstream_conf;
+    }
+
+    location /status {
         status;
     }
 
-    status_zone example_server;
+    location = /status.html {
+    }
 }
 </example>
 </para>
 
 <para>
+Примеры запросов информации о состоянии,
+возможные с данной конфигурацией:
+<example>
+http://127.0.0.1/status
+http://127.0.0.1/status/nginx_version
+http://127.0.0.1/status/caches/cache_backend
+http://127.0.0.1/status/upstreams
+http://127.0.0.1/status/upstreams/backend
+http://127.0.0.1/status/upstreams/backend/1
+http://127.0.0.1/status/upstreams/backend/1/weight
+</example>
+</para>
+
+<para>
 В составе дистрибутива nginx имеется простая страница мониторинга, доступная
 по запросу “<literal>/status.html</literal>” в стандартной конфигурации.
-Для работы этой страницы требуется настроить
-location “<literal>/status</literal>”, как показано выше.
+Для работы этой страницы требуется настроить location
+“<literal>/status</literal>” и location “<literal>/status.html</literal>”
+как показано выше.
 </para>
 
 </section>