VTS#

This is a set of modules for traffic tracking and real-time activity monitoring. It provides access to information about the status of virtual hosts, upstreams, caches, and also includes ready-made HTML templates to visualize statistics.

Installation#

To install the module, use one of the following packages:

Angie: angie-module-vts
Angie PRO: angie-pro-module-vts

Loading Modules#

Loading the modules in the context of main{}:

load_module modules/ngx_http_stream_server_traffic_status_module.so;
load_module modules/ngx_http_vhost_traffic_status_module.so;
load_module modules/ngx_stream_server_traffic_status_module.so;

Preparing for Demonstration#

HTML page templates are installed in the directory /usr/share/angie-module-vts/:

/usr/share/angie-module-vts/status.compress.html
/usr/share/angie-module-vts/status.template.html
/usr/share/angie-module-vts/stream/status.compress.html
/usr/share/angie-module-vts/stream/status.template.html

To work with the configuration example below, you need to:

Copy /usr/share/angie-module-vts/status.template.html to /usr/share/angie-module-vts/status.html:

cp /usr/share/angie-module-vts/status.template.html \
   /usr/share/angie-module-vts/status.html

In the file /usr/share/angie-module-vts/status.html, find the line:
```
var vtsStatusURI = "{{uri}}/format/json", vtsUpdateInterval = 1000;
```
and replace {uri} with /status.

Configuration Example#

http {
    # ...
    vhost_traffic_status_zone;

    server {
        listen 80;
        server_name localhost;

        root  /usr/share/angie/html;
        index index.html index.htm;

        location = /status.html {
            root  /usr/share/angie-module-vts;
        }

        location /status {
            vhost_traffic_status_display;
            vhost_traffic_status_display_format html;
        }
    }
}

Additional Information#

Detailed documentation and source code are available at: vozlt/nginx-module-vts.