Skip to main content

NGINX collector

NGINX is a web server which can also be used as a reverse proxy, load balancer, mail proxy and HTTP cache.

This module will monitor one or more NGINX servers, depending on your configuration.

Requirements

Metrics

All metrics have "nginx." prefix.

MetricScopeDimensionsUnits
connectionsglobalactiveconnections
connections_statusglobalreading, writing, idleconnections
connections_accepted_handledglobalaccepted, handledconnections/s
requestsglobalrequestsrequests/s

Configuration

Edit the go.d/nginx.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/nginx.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/stub_status

- name: remote
url: http://203.0.113.10/stub_status

For all available options please see module configuration file.

Troubleshooting

To troubleshoot issues with the nginx 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 nginx

Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.