#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.

NGINX can be monitored further using the following other integrations:

• HTTP Endpoints
• Web server log files
• Applications
• Containers

#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:

• http://127.0.0.1/basic_status
• http://localhost/stub_status
• http://127.0.0.1/stub_status
• http://127.0.0.1/nginx_status
• http://127.0.0.1/status

#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.

#Setup

You can configure the nginx collector in two ways:

Method	Best for	How to
UI	Fast setup without editing files	Go to Nodes → Configure this node → Collectors → Jobs, search for nginx, then click + to add a job.
File	If you prefer configuring via file, or need to automate deployments (e.g., with Ansible)	Edit go.d/nginx.conf and add a job.

:::important

UI configuration requires paid Netdata Cloud plan.

:::

#Prerequisites

#Enable status support

Configure ngx_http_stub_status_module.

1. Add a status location

Create a small server/location that only listens on localhost and exposes /stub_status:

For local monitoring (default):

     # /etc/nginx/conf.d/stub_status.conf
     server {
         listen 127.0.0.1:80;
         server_name localhost 127.0.0.1;

         location = /stub_status {
             stub_status;        # exposes NGINX counters
             access_log off;     # keep logs clean
             allow 127.0.0.1;    # only local access
             deny all;
         }
     }

**For remote monitoring:**
- Change `listen` to bind to an accessible interface (e.g., `listen 80;`)
- Replace `allow 127.0.0.1;` with your Netdata collector's IP address
- Keep `deny all;` to block other IPs

1. Reload NGINX and restart Netdata

   nginx -t
   # if OK:
   systemctl reload nginx    # or: nginx -s reload

   systemctl restart netdata

After restart, Netdata will auto-detect the endpoint and begin collecting NGINX metrics.

#Configuration

#Options

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

Config options

| Group | Option | Description | Default | Required | |:------|:-----|:------------|:--------|:---------:| | **Collection** | update_every | Data collection interval (seconds). | 1 | no | | | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no | | **Target** | url | Target endpoint URL. | http://127.0.0.1/stub_status | yes | | | timeout | HTTP request timeout (seconds). | 1 | no | | **HTTP Auth** | username | Username for Basic HTTP authentication. | | no | | | password | Password for Basic HTTP authentication. | | no | | | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no | | **TLS** | tls_skip_verify | Skip TLS certificate and hostname verification (insecure). | no | no | | | tls_ca | Path to CA bundle used to validate the server certificate. | | no | | | tls_cert | Path to client TLS certificate (for mTLS). | | no | | | tls_key | Path to client TLS private key (for mTLS). | | no | | **Proxy** | proxy_url | HTTP proxy URL. | | no | | | proxy_username | Username for proxy Basic HTTP authentication. | | no | | | proxy_password | Password for proxy Basic HTTP authentication. | | no | | **Request** | method | HTTP method to use. | GET | no | | | body | Request body (e.g., for POST/PUT). | | no | | | headers | Additional HTTP headers (one per line as key: value). | | no | | | not_follow_redirects | Do not follow HTTP redirects. | no | no | | **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |

#via UI

Configure the nginx collector from the Netdata web interface:

1. Go to Nodes.
2. Select the node where you want the nginx data-collection job to run and click the :gear: (Configure this node). That node will run the data collection.
3. The Collectors → Jobs view opens by default.
4. In the Search box, type nginx (or scroll the list) to locate the nginx collector.
5. Click the + next to the nginx collector to add a new job.
6. Fill in the job fields, then click Test to verify the configuration and Submit to save.
   • Test runs the job with the provided settings and shows whether data can be collected.
   • If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.

#via File

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

The file format is YAML. Generally, the structure is:

update_every: 1
autodetection_retry: 0
jobs:
  - name: some_name1
  - name: some_name2

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

#Examples

#Basic

A basic example configuration.

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

#HTTP authentication

Basic HTTP authentication.

Config

```yaml 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

```yaml 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

```yaml jobs: - name: local url: http://127.0.0.1/stub_status - name: remote url: http://192.0.2.1/stub_status ```

#Alerts

There are no alerts configured by default for this integration.

#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:

Metric	Dimensions	Unit
nginx.connections	active	connections
nginx.connections_status	reading, writing, idle	connections
nginx.connections_accepted_handled	accepted, handled	connections/s
nginx.requests	requests	requests/s

#Troubleshooting

#Debug Mode

Important: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.

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

To debug a specific job:

  ./go.d.plugin -d -m nginx -j jobName

#Getting Logs

If you're encountering problems with the nginx collector, follow these steps to retrieve logs and identify potential issues:

• Run the command specific to your system (systemd, non-systemd, or Docker container).
• Examine the output for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.

#System with systemd

Use the following command to view logs generated since the last Netdata service restart:

journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep nginx

#System without systemd

Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector's name:

grep nginx /var/log/netdata/collector.log

Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.

#Docker Container

If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:

docker logs netdata 2>&1 | grep nginx