Skip to main content

NGINX VTS monitoring

nginxvts can monitor statistics of NGINX which configured with nginx-module-vts.

Metrics

All metrics have "nginxvts." prefix.

MetricScopeDimensionsUnits
requests_totalglobalrequestsrequests/s
active_connectionsglobalactiveconnections
connections_totalglobalreading, writing, waiting, accepted, handledconnections/s
uptimeglobaluptimeseconds
shm_usageglobalmax, usedbytes
shm_used_nodeglobalusednodes
server_requests_totalglobalrequestsrequests/s
server_responses_totalglobal1xx, 2xx, 3xx, 4xx, 5xxresponses/s
server_traffic_totalglobalin, outbytes/s
server_cache_totalglobalmiss, bypass, expired, stale, updating, revalidated, hit, scarceevents/s

Refer nginx-module-vts for more information.

Configuration

Edit the go.d/nginxvts.conf configuration file using edit-config from the Netdata config directory, which is typically at /etc/netdata.

cd /etc/netdata # Replace this path with your Netdata config directory
sudo ./edit-config go.d/nginxvts.conf

Needs only url to server's stub_status. Here is an example for local and remote servers:

jobs:
- name: local
url: http://127.0.0.1/status/format/json
- name: remote
url: http://203.0.113.0/status/format/json

For all available options please see module configuration file.

Troubleshooting

To troubleshoot issues with the nginxvts collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

  • Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

    cd /usr/libexec/netdata/plugins.d/
  • Switch to the netdata user.

    sudo -u netdata -s
  • Run the go.d.plugin to debug the collector:

    ./go.d.plugin -d -m nginxvts

Was this page helpful?

Contribute