README.md
1ngx_http_json_status_module
2===========================
3
4Specification
5----
6module to be returned in json format status of nginx
7
8### Directives
9```
10syntax: status;
11default: none;
12context: location
13```
14
15### response
16* Meaning of each element [Here](http://nginx.com/download/newrelic/newrelic_nginx_agent.tar.gz), want to see also
17```json
18{
19 "version": "1",
20 "nginx_version": "1.5.3",
21 "address": "127.0.0.1",
22 "timestamp": 1377263206961,
23 "connections": {
24 "accepted": 80399,
25 "dropped": 0,
26 "active": 1,
27 "idle": 1
28 },
29 "requests": {
30 "total": 80399,
31 "current": 1
32 },
33 "upstreams":{
34 "upstream_servers": [
35 {
36 "server": "127.0.0.1:1081",
37 "state": "up",
38 "weight": 1,
39 "backup": false,
40 "active": 0,
41 "keepalive": 0,
42 "requests": 470,
43 "fails": 0,
44 "unavail": 0,
45 "downstart": 0,
46 "sent": 78020,
47 "received": 2350,
48 "downtime": 0,
49 "responses": {
50 "1xx": 0,
51 "2xx": 470,
52 "3xx": 0,
53 "4xx": 0,
54 "5xx": 0,
55 "total": 470
56 },
57 "health_checks": {
58 "checks": 0,
59 "fails": 0,
60 "unhealthy": 0
61 }
62 },
63 ...
64 ],
65 }
66}
67```
68
69Built-in
70--------
71```bash
72./configure --add-module=./ngx_http_json_status_module
73```
74
75Setting Example
76------
77```
78server {
79 ...
80 location = /status {
81 status;
82 }
83}
84```
85
86Reference
87----
88* [module guide](http://www.evanmiller.org/nginx-modules-guide.html)
89* [nginx plus](http://nginx.com/products/)
90* [nginx plus tips](http://qiita.com/harukasan/items/5123f797a876696b343e)
91* [nginx status](http://nginx.org/en/docs/http/ngx_http_status_module.html)
92* [build nginx](BUILD.md)
93* [開発手順](PROCEDUREofDEVELOPEMENT.md)
94* [Development of modules for nginx](http://antoine.bonavita.free.fr/nginx_mod_dev_en.html)
95