Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_status_module.xml @ 1258:700487454cf2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Status: documented the query API implementation.
author Yaroslav Zhuravlev <yar@nginx.com>
date Thu, 10 Jul 2014 15:33:59 +0400
parents 59099cb4b16f
children d3548b46b87f
comparison
equal deleted inserted replaced
1257:ac7a5ee98768 1258:700487454cf2
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8 8
9 <module name="Module ngx_http_status_module" 9 <module name="Module ngx_http_status_module"
10 link="/en/docs/http/ngx_http_status_module.html" 10 link="/en/docs/http/ngx_http_status_module.html"
11 lang="en" 11 lang="en"
12 rev="2"> 12 rev="3">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 16 <para>
17 The <literal>ngx_http_status_module</literal> module provides 17 The <literal>ngx_http_status_module</literal> module provides
30 30
31 <section id="example" name="Example Configuration"> 31 <section id="example" name="Example Configuration">
32 32
33 <para> 33 <para>
34 <example> 34 <example>
35 upstream <emphasis>backend</emphasis> {
36 <emphasis>zone</emphasis> upstream_backend 64k;
37
38 server backend1.example.com weight=5;
39 server backend2.example.com;
40 }
41
42 proxy_cache_path /data/nginx/cache_backend keys_zone=<emphasis>cache_backend</emphasis>:10m;
43
35 server { 44 server {
36 location = /status { 45 server_name backend.example.com;
46
47 location / {
48 proxy_pass http://backend;
49 proxy_cache cache_backend;
50
51 health_check;
52 }
53
54 <emphasis>status_zone server_backend;</emphasis>
55 }
56
57 server {
58 listen 127.0.0.1;
59
60 location /upstream_conf {
61 upstream_conf;
62 }
63
64 location /status {
37 status; 65 status;
38 } 66 }
39 67
40 status_zone example_server; 68 location = /status.html {
69 }
41 } 70 }
42 </example> 71 </example>
43 </para> 72 </para>
44 73
45 <para> 74 <para>
75 Examples of status requests with this configuration:
76 <example>
77 http://127.0.0.1/status
78 http://127.0.0.1/status/nginx_version
79 http://127.0.0.1/status/caches/cache_backend
80 http://127.0.0.1/status/upstreams
81 http://127.0.0.1/status/upstreams/backend
82 http://127.0.0.1/status/upstreams/backend/1
83 http://127.0.0.1/status/upstreams/backend/1/weight
84 </example>
85 </para>
86
87 <para>
46 The simple monitoring page is shipped with this distribution, 88 The simple monitoring page is shipped with this distribution,
47 accessible as “<literal>/status.html</literal>” in the default configuration. 89 accessible as “<literal>/status.html</literal>” in the default configuration.
48 It requires the location “<literal>/status</literal>” to be configured 90 It requires the locations “<literal>/status</literal>” and
49 as shown above. 91 “<literal>/status.html</literal>” to be configured as shown above.
50 </para> 92 </para>
51 93
52 </section> 94 </section>
53 95
54 96