Nginx stream server traffic status core module

Version

This document describes nginx-module-stream-sts v0.1.1 released on 04 Feb 2018.

Dependencies

Compatibility

Nginx
- 1.11.5 <= (last tested: 1.15.0)

Earlier versions does not work.

Screenshots

Installation

Clone the git repository.

shell> git clone git://github.com/vozlt/nginx-module-sts.git

shell> git clone git://github.com/vozlt/nginx-module-stream-sts.git

Add the module to the build configuration by adding

--with-stream
--add-module=/path/to/nginx-module-sts
--add-module=/path/to/nginx-module-stream-sts

Build the nginx binary.
Install the nginx binary.

Synopsis

http {
    stream_server_traffic_status_zone;

    ...

    server {

        ...

        location /status {
            stream_server_traffic_status_display;
            stream_server_traffic_status_display_format html;
        }
    }
}

stream {
    server_traffic_status_zone;

    ...

    server {
        ...
    }
}

Description

This is an Nginx module that provides access to stream server traffic status information. This is a porting version of the nginx-module-vts to the NGINX "stream" subsystem so as to support the same features in nginx-module-vts. It contains the current status such as servers, upstreams, user-defined filter. This module is the core module of two modules(nginx-module-sts, nginx-module-stream-sts).

The functions of each module are as follows:

nginx-module-stream-sts
- Support for implementing stream server stats.
- Support for implementing stream filter.
- Support for implementing stream limit.
- Support for implementing stream embedded variables.
nginx-module-sts
- Support for implementing display of stream server stats.
- Support for implementing control of stream server stats.

TODO

Donation

Author

YoungJoo.Kim(김영주) [vozltx@gmail.com]

vozlt/nginx-module-stream-sts