NGINX Plus
NGINX Plus
Plugin: go.d.plugin Module: nginxplus
Overview
This collector monitors NGINX Plus servers.
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
This integration doesn’t support auto-detection.
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
Prerequisites
Config API
To configure API, see the official documentation.
Configuration
File
The configuration file name for this integration is go.d/nginxplus.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/nginxplus.conf
Options
The following options can be defined globally: update_every, autodetection_retry.
| Name | Description | Default | Required |
|---|---|---|---|
| update_every | Data collection frequency. | 1 | False |
| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | False |
| url | Server URL. | http://127.0.0.1 | True |
| timeout | HTTP request timeout. | 1 | False |
| username | Username for basic HTTP authentication. | False | |
| password | Password for basic HTTP authentication. | False | |
| proxy_url | Proxy URL. | False | |
| proxy_username | Username for proxy basic HTTP authentication. | False | |
| proxy_password | Password for proxy basic HTTP authentication. | False | |
| method | HTTP request method. | GET | False |
| body | HTTP request body. | False | |
| headers | HTTP request headers. | False | |
| not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | False | False |
| tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | False | False |
| tls_ca | Certification authority that the client uses when verifying the server’s certificates. | False | |
| tls_cert | Client TLS certificate. | False | |
| tls_key | Client TLS key. | False |
Examples
Basic
A basic example configuration.
jobs:
- name: local
url: http://127.0.0.1
HTTP authentication
Basic HTTP authentication.
jobs:
- name: local
url: http://127.0.0.1
username: username
password: password
HTTPS with self-signed certificate
NGINX Plus with enabled HTTPS and self-signed certificate.
jobs:
- name: local
url: https://127.0.0.1
tls_skip_verify: yes
Multi-instance
Note: When you define multiple jobs, their names must be unique.
Collecting metrics from local and remote instances.
jobs:
- name: local
url: http://127.0.0.1
- name: remote
url: http://192.0.2.1
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 Plus instance
These metrics refer to the entire monitored application.
This scope has no labels.
Metrics:
| Metric | Dimensions | Unit |
|---|---|---|
| nginxplus.client_connections_rate | accepted, dropped | connections/s |
| nginxplus.client_connections_count | active, idle | connections |
| nginxplus.ssl_handshakes_rate | successful, failed | handshakes/s |
| nginxplus.ssl_handshakes_failures_rate | no_common_protocol, no_common_cipher, timeout, peer_rejected_cert | failures/s |
| nginxplus.ssl_verification_errors_rate | no_cert, expired_cert, revoked_cert, hostname_mismatch, other | errors/s |
| nginxplus.ssl_session_reuses_rate | ssl_session | reuses/s |
| nginxplus.http_requests_rate | requests | requests/s |
| nginxplus.http_requests_count | requests | requests |
| nginxplus.uptime | uptime | seconds |
Per http server zone
These metrics refer to the HTTP server zone.
Labels:
| Label | Description |
|---|---|
| http_server_zone | HTTP server zone name |
Metrics:
| Metric | Dimensions | Unit |
|---|---|---|
| nginxplus.http_server_zone_requests_rate | requests | requests/s |
| nginxplus.http_server_zone_responses_per_code_class_rate | 1xx, 2xx, 3xx, 4xx, 5xx | responses/s |
| nginxplus.http_server_zone_traffic_rate | received, sent | bytes/s |
| nginxplus.http_server_zone_requests_processing_count | processing | requests |
| nginxplus.http_server_zone_requests_discarded_rate | discarded | requests/s |
Per http location zone
These metrics refer to the HTTP location zone.
Labels:
| Label | Description |
|---|---|
| http_location_zone | HTTP location zone name |
Metrics:
| Metric | Dimensions | Unit |
|---|---|---|
| nginxplus.http_location_zone_requests_rate | requests | requests/s |
| nginxplus.http_location_zone_responses_per_code_class_rate | 1xx, 2xx, 3xx, 4xx, 5xx | responses/s |
| nginxplus.http_location_zone_traffic_rate | received, sent | bytes/s |
| nginxplus.http_location_zone_requests_discarded_rate | discarded | requests/s |
Per http upstream
These metrics refer to the HTTP upstream.
Labels:
| Label | Description |
|---|---|
| http_upstream_name | HTTP upstream name |
| http_upstream_zone | HTTP upstream zone name |
Metrics:
| Metric | Dimensions | Unit |
|---|---|---|
| nginxplus.http_upstream_peers_count | peers | peers |
| nginxplus.http_upstream_zombies_count | zombie | servers |
| nginxplus.http_upstream_keepalive_count | keepalive | connections |
Per http upstream server
These metrics refer to the HTTP upstream server.
Labels:
| Label | Description |
|---|---|
| http_upstream_name | HTTP upstream name |
| http_upstream_zone | HTTP upstream zone name |
| http_upstream_server_address | HTTP upstream server address (e.g. 127.0.0.1:81) |
| http_upstream_server_name | HTTP upstream server name |
Metrics:
| Metric | Dimensions | Unit |
|---|---|---|
| nginxplus.http_upstream_server_requests_rate | requests | requests/s |
| nginxplus.http_upstream_server_responses_per_code_class_rate | 1xx, 2xx, 3xx, 4xx, 5xx | responses/s |
| nginxplus.http_upstream_server_response_time | response | milliseconds |
| nginxplus.http_upstream_server_response_header_time | header | milliseconds |
| nginxplus.http_upstream_server_traffic_rate | received, sent | bytes/s |
| nginxplus.http_upstream_server_state | up, down, draining, unavail, checking, unhealthy | state |
| nginxplus.http_upstream_server_connections_count | active | connections |
| nginxplus.http_upstream_server_downtime | downtime | seconds |
Per http cache
These metrics refer to the HTTP cache.
Labels:
| Label | Description |
|---|---|
| http_cache | HTTP cache name |
Metrics:
| Metric | Dimensions | Unit |
|---|---|---|
| nginxplus.http_cache_state | warm, cold | state |
| nginxplus.http_cache_iops | served, written, bypass | responses/s |
| nginxplus.http_cache_io | served, written, bypass | bytes/s |
| nginxplus.http_cache_size | size | bytes |
Per stream server zone
These metrics refer to the Stream server zone.
Labels:
| Label | Description |
|---|---|
| stream_server_zone | Stream server zone name |
Metrics:
| Metric | Dimensions | Unit |
|---|---|---|
| nginxplus.stream_server_zone_connections_rate | accepted | connections/s |
| nginxplus.stream_server_zone_sessions_per_code_class_rate | 2xx, 4xx, 5xx | sessions/s |
| nginxplus.stream_server_zone_traffic_rate | received, sent | bytes/s |
| nginxplus.stream_server_zone_connections_processing_count | processing | connections |
| nginxplus.stream_server_zone_connections_discarded_rate | discarded | connections/s |
Per stream upstream
These metrics refer to the Stream upstream.
Labels:
| Label | Description |
|---|---|
| stream_upstream_name | Stream upstream name |
| stream_upstream_zone | Stream upstream zone name |
Metrics:
| Metric | Dimensions | Unit |
|---|---|---|
| nginxplus.stream_upstream_peers_count | peers | peers |
| nginxplus.stream_upstream_zombies_count | zombie | servers |
Per stream upstream server
These metrics refer to the Stream upstream server.
Labels:
| Label | Description |
|---|---|
| stream_upstream_name | Stream upstream name |
| stream_upstream_zone | Stream upstream zone name |
| stream_upstream_server_address | Stream upstream server address (e.g. 127.0.0.1:12346) |
| stream_upstream_server_name | Stream upstream server name |
Metrics:
| Metric | Dimensions | Unit |
|---|---|---|
| nginxplus.stream_upstream_server_connections_rate | forwarded | connections/s |
| nginxplus.stream_upstream_server_traffic_rate | received, sent | bytes/s |
| nginxplus.stream_upstream_server_state | up, down, unavail, checking, unhealthy | state |
| nginxplus.stream_upstream_server_downtime | downtime | seconds |
| nginxplus.stream_upstream_server_connections_count | active | connections |
Per resolver zone
These metrics refer to the resolver zone.
Labels:
| Label | Description |
|---|---|
| resolver_zone | resolver zone name |
Metrics:
| Metric | Dimensions | Unit |
|---|---|---|
| nginxplus.resolver_zone_requests_rate | name, srv, addr | requests/s |
| nginxplus.resolver_zone_responses_rate | noerror, formerr, servfail, nxdomain, notimp, refused, timedout, unknown | responses/s |
Alerts
There are no alerts configured by default for this integration.
Troubleshooting
Debug Mode
To troubleshoot issues with the nginxplus 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.ddirectory, usually at/usr/libexec/netdata/plugins.d/. If that’s not the case on your system, opennetdata.confand look for thepluginssetting under[directories].cd /usr/libexec/netdata/plugins.d/ -
Switch to the
netdatauser.sudo -u netdata -s -
Run the
go.d.pluginto debug the collector:./go.d.plugin -d -m nginxplus