NGinX

For Nginx open source, this plugin collects metrics from the Nginx status page generated by the ngx_http_stub_status module. To enable it, add a location block to your server:

http {
    server {
        location /nginx_status {
            stub_status on;
            access_log off;
            allow 127.0.0.1;
            deny all;
        }
    }
}

For Nginx Plus, this plugin collects metrics from the Nginx Plus REST API provided by the ngx_http_api_module module. To enable it, add a location block to your server:

http {
    server {
        location /api {
            api write=on;
            allow 127.0.0.1;
            deny all;
        }
    }
}

As soon as your Nginx instance is properly set up as described above, just run the Nginx plugin against your Nginx instance to start collecting metrics. When using Nginx Plus, set the environment variable nginx_plus: true to collect Nginx Plus metrics.

Plugin Environment Variables

The Nginx plugin can be customized via environment variables.