Nginx virtual host traffic status module

Size: px

Start display at page:

Download "Nginx virtual host traffic status module"

Jared Maxwell
6 years ago
Views:

1 of 8 2/17/2015 11:32 AM Explore Gist Blog Help itpp16 + vozlt / nginx-module-vts 2 2 1 Nginx virtual host traffic status module 2 commits 1 branch 0 releases 1 contributor nginx-module-vts / +

1 1 of 8 2/17/ :32 AM Explore Gist Blog Help itpp16 + vozlt / nginx-module-vts Nginx virtual host traffic status module 2 commits 1 branch 0 releases 1 contributor nginx-module-vts / + added traffic calculation description vozlt authored a day ago latest commit f4c share first commit 4 days ago src first commit 4 days ago util first commit 4 days ago LICENSE first commit 4 days ago README.md added traffic calculation description a day ago config first commit 4 days ago HTTPS clone URL You can clone with HTTPS, SSH, or Subversion.? README.md Nginx virtual host traffic status module Nginx virtual host traffic status module

2 2 of 8 2/17/ :32 AM Dependencies nginx Compatibility 1.7.x (last tested: ) 1.6.x (last tested: 1.6.2) Earlier versions is not tested. Screenshots

3 3 of 8 2/17/ :32 AM Installation 1. Clone the git repository.

4 4 of 8 2/17/ :32 AM shell> git clone git://github.com/vozlt/nginx-module-vts.git 2. Add the module to the build configuration by adding 3. Build the nginx binary. 4. Install the nginx binary. Synopsis http { vhost_traffic_status_zone; server { location /status { vhost_traffic_status_display; vhost_traffic_status_display_format html; } Description This is an Nginx module that provides access to virtual host status information. This is similar to the live activity monitoring of nginx plus. The built-in html is also taken from the demo page. First of all, the directive is required, and then if the directive is set, can be access to as follows:

5 5 of 8 2/17/ :32 AM /status/format/json /status/format/html If you request, will respond with a JSON document containing the current activity data for using in live dashboards and third-party monitoring tools. If you request, will respond with the built-in live dashboard in HTML that requests internally to. JSON document contains as follows: { } "nginxversion":, "loadmsec":, "nowmsec":, "connections": { }, "serverzones": { }, "upstreamzones": { } main Basic version, uptime(nowmsec - loadmsec) connections Total connections and requests(same as stub_status_module in NGINX) serverzones Traffic(in/out) and request and response counts per each server zone Total traffic(in/out) and request and response counts(it zone name is )

6 6 of 8 2/17/ :32 AM upstreamzones Traffic(in/out) and request and response counts per server in each upstream group Current settings(weight, maxfails, failtimeout) in nginx.conf The directive sets the default ouput format that is one of json or html. (Default: json) Traffic calculation as follows: ServerZones in += requested_bytes out += sent_bytes UpstreamZones in += requested_bytes via the ServerZones out += sent_bytes via the ServerZones All calculations are working in log processing phase of Nginx. Internal redirects(x-accel-redirect or error_page) does not calculate in the UpstreamZones. this module relies on nginx logging system, so the traffic may be in certain cirumstances different that real bandwidth traffic. Websocket, canceled downloads may be cause of inaccuracies. Directives vhost_traffic_status Syntax Default vhost_traffic_status [on off] off

7 7 of 8 2/17/ :32 AM Context http, server, location is automatically enabled. Enables or disables the module working. If you set directive, vhost_traffic_status_zone Syntax Default Context vhost_traffic_status_zone [shared:name:size] shared:vhost_traffic_status:1m http Sets parameters for a shared memory zone that will keep states for various keys. The cache is shared between all worker processes. vhost_traffic_status_display Syntax vhost_traffic_status_display Default - Context http, server, location Enables or disables the module display handler.

8 8 of 8 2/17/ :32 AM vhost_traffic_status_display_format Syntax Default Context vhost_traffic_status_display_format [json html] json http, server, location Sets the display handler's output format. If you set json, will respond with a JSON document. If you set html, will respond with the built-in live dashboard in HTML. Author YoungJoo.Kim( ) [vozlt@vozlt.com] 2015 GitHub, Inc. Terms Privacy Security Contact Status API Training Shop Blog About

calio / form-input-nginx-module

https://github.com/ 1 of 5 2/17/2015 11:27 AM Explore Gist Blog Help itpp16 + calio / form-input-nginx-module 5 46 9 This is a nginx module that reads HTTP POST and PUT request body encoded in "application/x-www-formurlencoded",