Nginx monitoring integration

Our NGINX integration collects and sends inventory, logs, and metrics from your NGINX server to our platform, where you can see data on connections and client requests so that you can find the source of any problems.

Image of the dashboard available through the NGINX quickstart

Dashboard installed through the New Relic NGINX Monitor quickstart.

To get the most out of this page, select the installation method that fits your environment. You need a New Relic account to finish the installation process.

NGINX config settings

The following configuration options are available:

Setting	Description	Default	Applies to
`STATUS_URL`	The URL set up to provide the metrics using the status module.	`http://127.0.0.1/status`	Metrics/Inventory
`STATUS_MODULE`	Name of NGINX status module. Valid options are: `discover` `ngx_http_stub_status_module` `ngx_http_status_module` `ngx_http_api_module`	`discover`	Metrics
`CONNECTION_TIMEOUT`	Connection timeout to the NGINX instance in seconds.	`5`	Metrics
`VALIDATE_CERTS`	Set to `false` if the status URL is HTTPS with a self-signed certificate.	`true`	Metrics
`CONFIG_PATH`	The path to the NGINX configuration file.	N/A	Inventory
`REMOTE_MONITORING`	Enable multi-tenancy monitoring. Read more about remote monitoring.	`true`	Metrics/Inventory
`METRICS`	Set to `true` to enable Metrics only collection.	`false`
`INVENTORY`	Set to `true` to enable Inventory only collection.	`false`

Metric data

The NGINX integration collects the following metrics:

Metric	Description
`net.connectionsActive`	Number of connections that are currently active
`net.connectionsAcceptedPerSecond`	Number of accepted client connections per second
`net.connectionsDroppedPerSecond`	Number of connections per second that were accepted but could not he handled and hence dropped
`net.connectionsReading`	Current number of connections where NGINX is reading the request header
`net.connectionsWaiting`	Current number of idle client connections waiting for a request
`net.connectionsWriting`	Current number of connections where NGINX is writing the response back to the client
`net.requestsPerSecond`	Total number of client requests per second

New Relic's integration retrieves all available metric data from the following HTTP API endpoints: /nginx, /processes, /connections, /http/requests, and /ssl.

Metric	Description
`net.connectionsAcceptedPerSecond`	Accepted client connections as requests per second
`net.connectionsDroppedPerSecond`	Dropped client connections as requests per second
`net.connectionsActive`	Current number of active client connections
`net.connectionsIdle`	Current number of idle client connections
`net.requests`	Current number of requests
`net.requestsPerSecond`	Current number of requests per second
`processes.respawned`	Current number of abnormally terminated and respawned child processes
`ssl.handshakes`	Current number for successful SSL handshakes
`ssl.failedHandshakes`	Current number of failed SSL handshakes
`ssl.sessionReuses`	Current number of session reuses during SSL handshake

Name	Description
`software.edition`	The NGINX edition: either `"open source"` or `"plus"`.
`software.version`	The version of NGINX.

Nginx monitoring integration

NGINX config settings

Metric data

NGINX Open Source

NGINX Plus

Inventory data

Tip

System metadata

Nginx monitoring integration

NGINX config settings .css-21sua1{background:none;border:none;width:0;padding:0;}

Metric data

NGINX Plus

Inventory data

System metadata

NGINX config settings