Skip to main content

NGINX

Plugin: go.d.plugin Module: nginx

Overview

This collector monitors the activity and performance of NGINX servers, and collects metrics such as the number of connections, their status, and client requests.

It sends HTTP requests to the NGINX location stub-status, which is a built-in location that provides metrics about the NGINX server.

This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

Default Behavior

Auto-Detection

By default, it detects NGINX instances running on localhost that are listening on port 80. On startup, it tries to collect metrics from:

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per NGINX instance

These metrics refer to the entire monitored application.

This scope has no labels.

Metrics:

MetricDimensionsUnit
nginx.connectionsactiveconnections
nginx.connections_statusreading, writing, idleconnections
nginx.connections_accepted_handledaccepted, handledconnections/s
nginx.requestsrequestsrequests/s

Alerts

There are no alerts configured by default for this integration.

Setup

Prerequisites

Enable status support

Configure ngx_http_stub_status_module.

Configuration

File

The configuration file name for this integration is go.d/nginx.conf.

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/nginx.conf

Options

The following options can be defined globally: update_every, autodetection_retry.

Config options
NameDescriptionDefaultRequired
update_everyData collection frequency.1no
autodetection_retryRecheck interval in seconds. Zero means no recheck will be scheduled.0no
urlServer URL.http://127.0.0.1/stub_statusyes
timeoutHTTP request timeout.1no
usernameUsername for basic HTTP authentication.no
passwordPassword for basic HTTP authentication.no
proxy_urlProxy URL.no
proxy_usernameUsername for proxy basic HTTP authentication.no
proxy_passwordPassword for proxy basic HTTP authentication.no
methodHTTP request method.GETno
bodyHTTP request body.no
headersHTTP request headers.no
not_follow_redirectsRedirect handling policy. Controls whether the client follows redirects.nono
tls_skip_verifyServer certificate chain and hostname validation policy. Controls whether the client performs this check.nono
tls_caCertification authority that the client uses when verifying the server's certificates.no
tls_certClient TLS certificate.no
tls_keyClient TLS key.no

Examples

Basic

A basic example configuration.

jobs:
- name: local
url: http://127.0.0.1/stub_status

HTTP authentication

Basic HTTP authentication.

Config
jobs:
- name: local
url: http://127.0.0.1/stub_status
username: username
password: password

HTTPS with self-signed certificate

NGINX with enabled HTTPS and self-signed certificate.

Config
jobs:
- name: local
url: http://127.0.0.1/stub_status
tls_skip_verify: yes

Multi-instance

Note: When you define multiple jobs, their names must be unique.

Collecting metrics from local and remote instances.

Config
jobs:
- name: local
url: http://127.0.0.1/stub_status

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

Troubleshooting

Debug Mode

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.