This reference covers all metrics and attributes collected by the OpenTelemetry NGINX receiver, applicable to both on-host and Kubernetes deployments.
Core NGINX metrics
The OpenTelemetry Collector Contrib's nginxreceiver collects the following metrics from the NGINX stub status module:
Metric | Description | Type |
|---|---|---|
| The total number of accepted client connections. Use this to track connection acceptance rates over time. | Sum |
| The total number of handled connections. Generally, the parameter value is the same as nginx.connections_accepted unless some resource limits have been reached (for example, the worker_connections limit). A gap between accepted and handled suggests resource constraints. | Sum |
| The current number of nginx connections by state. States include: active (total active connections), reading (reading request headers), writing (writing responses), waiting (keep-alive connections waiting for next request). | Sum |
| Total number of requests made to the server since it started. Use rate calculations to derive requests per second for performance monitoring. | Sum |
Capacity planning tips:
- High
waitingconnections may indicate keep-alive tuning opportunities - Gap between
acceptedandhandledconnections suggests resource constraints - Request-to-connection ratios help optimize worker configurations
Resource attributes
Resource attributes provide context about your NGINX deployment and vary depending on whether you're using on-host or Kubernetes deployment.
Common attributes
Attribute | Description | Example Values |
|---|---|---|
| The state of a connection (applicable to |
|
| The NGINX stub status endpoint URL |
|
On-host deployment attributes
Attribute | Description | Example Values |
|---|---|---|
| A unique name to identify this NGINX deployment |
|
| A display-friendly name combining "server" prefix with deployment name |
|
| The hostname of the system where NGINX is running |
|
| The unique identifier of the host system |
|
| The type of log being collected (applicable to logs only). Used by New Relic's built-in parsing rules. This attribute is only available when log forwarding is enabled. |
|
Kubernetes deployment attributes
Attribute | Description | Example Values |
|---|---|---|
| The name of the Kubernetes cluster |
|
| The Kubernetes namespace where the NGINX pod is running |
|
| The name of the Kubernetes pod running NGINX |
|
| Set to the pod name for Kubernetes deployments |
|
| A comprehensive display name including cluster, namespace, and pod information |
|
Metric collection details
Collection frequency
- Default interval: 30 seconds
- Configurable: Can be adjusted in the OpenTelemetry Collector configuration
Data source
All metrics are collected from the NGINX stub_status module, which must be enabled and configured to expose an HTTP endpoint.
Metric types
- Sum metrics: Cumulative values that represent totals over time
- Rate calculations: Use New Relic's
rate()function to convert cumulative metrics to per-second rates for monitoring
Related documentation
Setup guides:
- Monitor NGINX on self-hosted environments - Complete setup for on-host deployments
- Monitor NGINX on Kubernetes - Complete setup for Kubernetes deployments
Data usage:
- Find and query your NGINX data - Dashboards, NRQL queries, and alerts
Technical reference:
- NGINX receiver documentation - OpenTelemetry technical details