ngx_req_status - Request status in nginx

http {
    req_status_zone server_name $server_name 256k;
    req_status_zone server_addr $server_addr 256k;

    req_status server_name server_addr;

    server {
        location /req-status {
            req_status_show on;

            allow 10.0.0.0/8;
            allow 127.0.0.1;
            deny all;
        }
    }
}

syntax: req_status_zone name string size

default: None

context: http

Define a request status zone. Requests are grouped by the value of string specified in the second paramter.

req_status_zone server_addr "$server_addr:$server_port" 256k;

syntax: req_status zone1[ zone2]

default: None

context: http, server, location

Enables request status in this location. You can specify as many zones as needed.

syntax: req_status_show on

default: None

context: location

Enables the request status handler in this location. Same as req_status_show_plain. For example:

location /req-status {
    req_status_show on;

    allow 10.0.0.0/8;
    allow 127.0.0.1;
    deny all;
}

Then you can see the page by

curl http://127.0.0.1/req-status

It is plain text information like:

zone_name       key     max_active      max_bw  traffic requests        active  bandwidth
imgstore_appid  43    27      6M      63G     374063  0        0
imgstore_appid  53    329     87M     2058G   7870529 50      25M
server_addr     10.128.1.17     2        8968   24M     1849    0        0
server_addr     127.0.0.1       1       6M      5G      912     1        0
server_addr     180.96.x.1   3358    934M    27550G  141277391       891     356M
server_addr     180.96.x.2   78      45M     220G    400704  0        0
server_addr     180.96.x.3   242     58M     646G    2990547 42      7M
server_name     d.123.sogou.com 478     115M    2850G   30218726        115     39M
server_name     dl.pinyin.sogou.com     913     312M    8930G   35345453        225     97M
server_name     download.ie.sogou.com   964     275M    7462G   7979817 297     135M

syntax: req_status_show_json on

default: None

context: location

Enables the request status handler returning JSON in this location. It returns JSON formatted information like:

{"zone_list":[
    {"zone_name":"imgstore_appid","key":"43","max_active":27,"max_bw":6291456,"traffic":67645734912,"requests":374063,"active":0,"bandwith":0},
    {"zone_name":"server_addr","key":"10.128.1.17","max_active":2,"max_bw":8968,"traffic":25165824,"requests":1849,"active":0,"bandwith":0},
    {"zone_name":"server_name","key":"d.123.sogou.com","max_active":478,"max_bw":120586240,"traffic":3060164198400,"requests":30218726,"active":115,"bandwith":40894464}
]}

wget "http://nginx.org/download/nginx-1.3.5.tar.gz"
tar -xzvf nginx-1.3.5.tar.gz
cd nginx-1.3.5/

patch -p1 < /path/to/ngx_req_status/write_filter-VERSION.patch

./configure --prefix=/usr/local/nginx \
            --add-module=/path/to/ngx_req_status

make -j2
make install

Choose patch file according to Nginx version:

• 1.9.0-1.9.1
• 1.8.0
• 1.7.11-1.7.12

• 1.7.0-1.7.10
• 1.6.x
• 1.5.x
• 1.4.x
• 1.3.x
• 1.2.x
• 1.1.x
• 1.0.x

• Lanshun Zhou <zls0424@gmail.com>

This README template is from agentzh (http://github.com/agentzh).

I borrowed a lot of codes from limit_req module of Nginx. This part of code is copyrighted by Igor Sysoev.

This module is licensed under the terms of the BSD license.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.