Project: Netdata (Observability and Analysis / Observability)
File: nginx_plus.md

<!--startmeta customediturl: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/nginxplus/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/nginxplus/metadata.yaml" sidebar_label: "NGINX Plus" learn_status: "Published" learnrelpath: "Collecting Metrics/Web Servers and Web Proxies" most_popular: False message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" endmeta--> <img src="https://netdata.cloud/img/nginxplus.svg" width="150"/> Plugin: go.d.plugin Module: nginxplus <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> 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. This integration doesn't support auto-detection. The default configuration for this integration does not impose any limits on data collection. The default configuration for this integration is not expected to impose a significant performance impact on the system. Metrics grouped by scope. The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. These metrics refer to the entire monitored application. This scope has no labels. Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | nginxplus.clientconnectionsrate | accepted, dropped | connections/s | | nginxplus.clientconnectionscount | active, idle | connections | | nginxplus.sslhandshakesrate | successful, failed | handshakes/s | | nginxplus.sslhandshakesfailuresrate | nocommonprotocol, nocommoncipher, timeout, peerrejected_cert | failures/s | | nginxplus.sslverificationerrorsrate | nocert, expiredcert, revokedcert, hostname_mismatch, other | errors/s | | nginxplus.sslsessionreusesrate | sslsession | reuses/s | | nginxplus.httprequestsrate | requests | requests/s | | nginxplus.httprequestscount | requests | requests | | nginxplus.uptime | uptime | seconds | These metrics refer to the HTTP server zone. Labels: | Label | Description | |:--|:-| | httpserverzone | HTTP server zone name | Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | nginxplus.httpserverzonerequestsrate | requests | requests/s | | nginxplus.httpserverzoneresponsespercodeclass_rate | 1xx, 2xx, 3xx, 4xx, 5xx | responses/s | | nginxplus.httpserverzonetrafficrate | received, sent | bytes/s | | nginxplus.httpserverzonerequestsprocessing_count | processing | requests | | nginxplus.httpserverzonerequestsdiscarded_rate | discarded | requests/s | These metrics refer to the HTTP location zone. Labels: | Label | Description | |:--|:-| | httplocationzone | HTTP location zone name | Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | nginxplus.httplocationzonerequestsrate | requests | requests/s | | nginxplus.httplocationzoneresponsespercodeclass_rate | 1xx, 2xx, 3xx, 4xx, 5xx | responses/s | | nginxplus.httplocationzonetrafficrate | received, sent | bytes/s | | nginxplus.httplocationzonerequestsdiscarded_rate | discarded | requests/s | These metrics refer to the HTTP upstream. Labels: | Label | Description | |:--|:-| | httpupstreamname | HTTP upstream name | | httpupstreamzone | HTTP upstream zone name | Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | nginxplus.httpupstreampeers_count | peers | peers | | nginxplus.httpupstreamzombies_count | zombie | servers | | nginxplus.httpupstreamkeepalive_count | keepalive | connections | These metrics refer to the HTTP upstream

Labels: | Label | Description | |:--|:-| | httpupstreamname | HTTP upstream name | | httpupstreamzone | HTTP upstream zone name | | httpupstreamserver_address | HTTP upstream server address (e.g. 127.0.0.1:81) | | httpupstreamserver_name | HTTP upstream server name | Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | nginxplus.httpupstreamserverrequestsrate | requests | requests/s | | nginxplus.httpupstreamserverresponsespercodeclass_rate | 1xx, 2xx, 3xx, 4xx, 5xx | responses/s | | nginxplus.httpupstreamserverresponsetime | response | milliseconds | | nginxplus.httpupstreamserverresponseheader_time | header | milliseconds | | nginxplus.httpupstreamservertrafficrate | received, sent | bytes/s | | nginxplus.httpupstreamserver_state | up, down, draining, unavail, checking, unhealthy | state | | nginxplus.httpupstreamserverconnectionscount | active | connections | | nginxplus.httpupstreamserver_downtime | downtime | seconds | These metrics refer to the HTTP cache. Labels: | Label | Description | |:--|:-| | http_cache | HTTP cache name | Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | nginxplus.httpcachestate | warm, cold | state | | nginxplus.httpcacheiops | served, written, bypass | responses/s | | nginxplus.httpcacheio | served, written, bypass | bytes/s | | nginxplus.httpcachesize | size | bytes | These metrics refer to the Stream server zone. Labels: | Label | Description | |:--|:-| | streamserverzone | Stream server zone name | Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | nginxplus.streamserverzoneconnectionsrate | accepted | connections/s | | nginxplus.streamserverzonesessionspercodeclass_rate | 2xx, 4xx, 5xx | sessions/s | | nginxplus.streamserverzonetrafficrate | received, sent | bytes/s | | nginxplus.streamserverzoneconnectionsprocessing_count | processing | connections | | nginxplus.streamserverzoneconnectionsdiscarded_rate | discarded | connections/s | These metrics refer to the Stream upstream. Labels: | Label | Description | |:--|:-| | streamupstreamname | Stream upstream name | | streamupstreamzone | Stream upstream zone name | Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | nginxplus.streamupstreampeers_count | peers | peers | | nginxplus.streamupstreamzombies_count | zombie | servers | These metrics refer to the Stream upstream server. Labels: | Label | Description | |:--|:-| | streamupstreamname | Stream upstream name | | streamupstreamzone | Stream upstream zone name | | streamupstreamserver_address | Stream upstream server address (e.g. 127.0.0.1:12346) | | streamupstreamserver_name | Stream upstream server name | Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | nginxplus.streamupstreamserverconnectionsrate | forwarded | connections/s | | nginxplus.streamupstreamservertrafficrate | received, sent | bytes/s | | nginxplus.streamupstreamserver_state | up, down, unavail, checking, unhealthy | state | | nginxplus.streamupstreamserver_downtime | downtime | seconds | | nginxplus.streamupstreamserverconnectionscount | active | connections | These metrics refer to the resolver zone. Labels: | Label | Description | |:--|:-| | resolver_zone | resolver zone name | Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | nginxplus.resolverzonerequests_rate | name, srv, addr | requests/s | |

| noerror, formerr, servfail, nxdomain, notimp, refused, timedout, unknown | responses/s | There are no alerts configured by default for this integration. To configure API, see the . 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 . ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata sudo ./edit-config go.d/nginxplus.conf ``` The following options can be defined globally: updateevery, autodetectionretry. <details><summary>Config options</summary> | Name | Description | Default | Required | |:-|:--|:-|:--:| | update_every | Data collection frequency. | 1 | no | | autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no | | url | Server URL. | http://127.0.0.1 | yes | | timeout | HTTP request timeout. | 1 | no | | username | Username for basic HTTP authentication. | | no | | password | Password for basic HTTP authentication. | | no | | proxy_url | Proxy URL. | | no | | proxy_username | Username for proxy basic HTTP authentication. | | no | | proxy_password | Password for proxy basic HTTP authentication. | | no | | method | HTTP request method. | GET | no | | body | HTTP request body. | | no | | headers | HTTP request headers. | | no | | notfollowredirects | Redirect handling policy. Controls whether the client follows redirects. | no | no | | tlsskipverify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no | | tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no | | tls_cert | Client TLS certificate. | | no | | tls_key | Client TLS key. | | no | </details> A basic example configuration. <details><summary>Config</summary> ```yaml jobs: name: local url: http://127.0.0.1 ``` </details> Basic HTTP authentication. <details><summary>Config</summary> ```yaml jobs: name: local url: http://127.0.0.1 username: username password: password ``` </details> NGINX Plus with enabled HTTPS and self-signed certificate. <details><summary>Config</summary> ```yaml jobs: name: local url: https://127.0.0.1 tlsskipverify: yes ``` </details> Note: When you define multiple jobs, their names must be unique. Collecting metrics from local and remote instances. <details><summary>Config</summary> ```yaml jobs: name: local url: http://127.0.0.1 name: remote url: http://192.0.2.1 ``` </details> 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.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]`. ```bash cd /usr/libexec/netdata/plugins.d/ ``` Switch to the `netdata` user. ```bash sudo -u netdata -s ``` Run the `go.d.plugin` to debug the collector: ```bash ./go.d.plugin -d -m nginxplus ```