Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The following table lists the metrics available for the NGINX.NGINXPLUS/nginxDeployments resource type.
Table headings
Metric - The metric display name as it appears in the Azure portal.
Name in Rest API - Metric name as referred to in the REST API.
Unit - Unit of measure.
Aggregation - The default aggregation type. Valid values: Average, Minimum, Maximum, Total, Count.
Dimensions - Dimensions available for the metric.
Time Grains - Intervals at which the metric is sampled. For example, PT1M indicates that the metric is sampled every minute, PT30M every 30 minutes, PT1H every hour, and so on.
DS Export- Whether the metric is exportable to Azure Monitor Logs via Diagnostic Settings.
For information on exporting metrics, see - Metrics export using data collection rules and Create diagnostic settings in Azure Monitor.
For information on metric retention, see Azure Monitor Metrics overview.
For a list of supported logs, see Supported log categories - NGINX.NGINXPLUS/nginxDeployments
Category: nginx cache statistics
| Metric | Name in REST API | Unit | Aggregation | Dimensions | Time Grains | DS Export |
|---|---|---|---|---|---|---|
| Cache bypass bytes The total number of bytes served by bypassing the cache during the aggregation interval. |
plus.cache.bypass.bytes |
Bytes | Total (Sum) | build, version, cache_zone |
PT1M | Yes |
| Cache bypass bytes written The total number of bytes that bypassed the cache and were written back to the cache during the aggregation interval. |
plus.cache.bypass.bytes_written |
Bytes | Total (Sum) | build, version, cache_zone |
PT1M | Yes |
| Cache bypass responses The total number of responses that bypassed the cache during the aggregation interval. |
plus.cache.bypass.responses |
Count | Total (Sum) | build, version, cache_zone |
PT1M | Yes |
| Cache bypass responses written The total number of responses that bypassed the cache and were written back to the cache during the aggregation interval. |
plus.cache.bypass.responses_written |
Count | Total (Sum) | build, version, cache_zone |
PT1M | Yes |
| Cache expired bytes The total number of bytes served from the cache after expiration and refresh from the origin server during the aggregation interval. |
plus.cache.expired.bytes |
Bytes | Total (Sum) | build, version, cache_zone |
PT1M | Yes |
| Cache expired bytes written The total number of bytes written back to the cache after expiration and refresh from the origin server during the aggregation interval. |
plus.cache.expired.bytes_written |
Bytes | Total (Sum) | build, version, cache_zone |
PT1M | Yes |
| Cache expired responses The total number of cache responses that expired and had to be refreshed from the origin server during the aggregation interval. |
plus.cache.expired.responses |
Count | Total (Sum) | build, version, cache_zone |
PT1M | Yes |
| Cache expired responses written The total number of expired cache responses that were refreshed and written back to the cache during the aggregation interval. |
plus.cache.expired.responses_written |
Count | Total (Sum) | build, version, cache_zone |
PT1M | Yes |
| Cache hit bytes The total number of bytes served from the cache during the aggregation interval. |
plus.cache.hit.bytes |
Bytes | Total (Sum) | build, version, cache_zone |
PT1M | Yes |
| Cache hit ratio The average ratio of cache hits to misses during the aggregation interval |
plus.cache.hit.ratio |
Count | Average | build, version, cache_zone |
PT1M | Yes |
| Cache hit responses The total number of responses that were served from the cache during the aggregation interval. |
plus.cache.hit.responses |
Count | Total (Sum) | build, version, cache_zone |
PT1M | Yes |
| Cache max size The max size of the cache during the aggregation interval. |
plus.cache.max_size |
Count | Maximum | build, version, cache_zone |
PT1M | Yes |
| Cache miss bytes The total number of bytes served from the origin server due to cache misses during the aggregation interval. |
plus.cache.miss.bytes |
Bytes | Total (Sum) | build, version, cache_zone |
PT1M | Yes |
| Cache miss responses The total number of responses that were not served from the cache (cache misses) during the aggregation interval. |
plus.cache.miss.responses |
Count | Total (Sum) | build, version, cache_zone |
PT1M | Yes |
| Cache revalidated bytes The total number of bytes served from the cache after successful revalidation with the origin server during the aggregation interval. |
plus.cache.revalidated.bytes |
Bytes | Total (Sum) | build, version, cache_zone |
PT1M | Yes |
| Cache revalidated responses The total number of cache responses that were successfully revalidated with the origin server during the aggregation interval. |
plus.cache.revalidated.responses |
Count | Total (Sum) | build, version, cache_zone |
PT1M | Yes |
| Cache Size The average size of the cache during the aggregation interval. |
plus.cache.size |
Count | Average | build, version, cache_zone |
PT1M | Yes |
| Cache stale bytes The total number of bytes served from stale cache content during the aggregation interval. |
plus.cache.stale.bytes |
Bytes | Total (Sum) | build, version, cache_zone |
PT1M | Yes |
| Cache stale responses The total number of responses served from stale cache content during the aggregation interval. |
plus.cache.stale.responses |
Count | Total (Sum) | build, version, cache_zone |
PT1M | Yes |
| Cache updating bytes The total number of bytes served from the cache while the cache is being updated during the aggregation interval. |
plus.cache.updating.bytes |
Bytes | Total (Sum) | build, version, cache_zone |
PT1M | Yes |
| Cache updating responses The total number of responses served from the cache while the cache is being updated during the aggregation interval. |
plus.cache.updating.responses |
Count | Total (Sum) | build, version, cache_zone |
PT1M | Yes |
Category: nginx connections statistics
| Metric | Name in REST API | Unit | Aggregation | Dimensions | Time Grains | DS Export |
|---|---|---|---|---|---|---|
| Accepted connections The total number of accepted client connections during the aggregation interval |
nginx.conn.accepted |
Count | Total (Sum) | build, version |
PT1M | Yes |
| Active connections The total number of active client connections during the aggregation interval |
nginx.conn.active |
Count | Total (Sum) | build, version |
PT1M | Yes |
| Current connections The total number of active and idle client connections during the aggregation interval |
nginx.conn.current |
Count | Total (Sum) | build, version |
PT1M | Yes |
| Dropped connections The total number of dropped client connections during the aggregation interval |
nginx.conn.dropped |
Count | Total (Sum) | build, version |
PT1M | Yes |
| Idle connections The total number of idle client connections during the aggregation interval |
nginx.conn.idle |
Count | Total (Sum) | build, version |
PT1M | Yes |
Category: nginx requests and response statistics
| Metric | Name in REST API | Unit | Aggregation | Dimensions | Time Grains | DS Export |
|---|---|---|---|---|---|---|
| HTTP limit conn passed The total number of connections that were neither limited nor accounted as limited during the aggregation interval |
nginx.http.limit_conns.passed |
Count | Total (Sum) | build, version, limit_conn_zone |
PT1M | Yes |
| HTTP limit conn rejected The total number of connections that were rejected during the aggregation interval |
nginx.http.limit_conns.rejected |
Count | Total (Sum) | build, version, limit_conn_zone |
PT1M | Yes |
| HTTP limit conn rejected dry-run The total number of connections accounted as rejected in the dry run mode during the aggregation interval |
nginx.http.limit_conns.rejected_dry_run |
Count | Total (Sum) | build, version, limit_conn_zone |
PT1M | Yes |
| HTTP limit requests delayed The total number of requests that were delayed during the aggregation interval |
nginx.http.limit_reqs.delayed |
Count | Total (Sum) | build, version, limit_req_zone |
PT1M | Yes |
| HTTP limit requests delayed dry-run The total number of requests accounted as delayed in the dry run mode during the aggregation interval |
nginx.http.limit_reqs.delayed_dry_run |
Count | Total (Sum) | build, version, limit_req_zone |
PT1M | Yes |
| HTTP limit requests passed The total number of requests that were neither limited nor accounted as limited during the aggregation interval |
nginx.http.limit_reqs.passed |
Count | Total (Sum) | build, version, limit_req_zone |
PT1M | Yes |
| HTTP limit requests rejected The total number of requests that were rejected during the aggregation interval |
nginx.http.limit_reqs.rejected |
Count | Total (Sum) | build, version, limit_req_zone |
PT1M | Yes |
| HTTP limit requests rejected dry-run The total number of requests accounted as rejected in the dry run mode during the aggregation interval |
nginx.http.limit_reqs.rejected_dry_run |
Count | Total (Sum) | build, version, limit_req_zone |
PT1M | Yes |
| Total HTTP requests The total number of HTTP requests during the aggregation interval |
nginx.http.request.count |
Count | Total (Sum) | build, version |
PT1M | Yes |
| Current HTTP requests The number of current requests during the aggregation interval |
nginx.http.request.current |
Count | Total (Sum) | build, version |
PT1M | Yes |
| HTTP bytes received The total number of bytes received from clients during the aggregation interval |
plus.http.request.bytes_rcvd |
Bytes | Total (Sum) | build, version, server_zone, location_zone |
PT1M | Yes |
| HTTP bytes sent The total number of bytes sent to clients during the aggregation interval |
plus.http.request.bytes_sent |
Bytes | Total (Sum) | build, version, server_zone, location_zone |
PT1M | Yes |
| HTTP requests The total number of HTTP requests during the aggregation interval |
plus.http.request.count |
Count | Total (Sum) | build, version, server_zone, location_zone |
PT1M | Yes |
| HTTP responses The total number of HTTP responses during the aggregation interval |
plus.http.response.count |
Count | Total (Sum) | build, version, server_zone, location_zone |
PT1M | Yes |
| HTTP 1xx responses The total number of HTTP responses with a 1xx status code during the aggregation interval |
plus.http.status.1xx |
Count | Total (Sum) | build, version, server_zone, location_zone |
PT1M | Yes |
| HTTP 2xx responses The total number of HTTP responses with a 2xx status code during the aggregation interval |
plus.http.status.2xx |
Count | Total (Sum) | build, version, server_zone, location_zone |
PT1M | Yes |
| HTTP 3xx responses The total number of HTTP responses with a 3xx status code during the aggregation interval |
plus.http.status.3xx |
Count | Total (Sum) | build, version, server_zone, location_zone |
PT1M | Yes |
| HTTP 4xx responses The total number of HTTP responses with a 4xx status code during the aggregation interval |
plus.http.status.4xx |
Count | Total (Sum) | build, version, server_zone, location_zone |
PT1M | Yes |
| HTTP 5xx responses The total number of HTTP responses with a 5xx status code during the aggregation interval |
plus.http.status.5xx |
Count | Total (Sum) | build, version, server_zone, location_zone |
PT1M | Yes |
| HTTP status processing The number of client requests that are currently being processed |
plus.http.status.processing |
Count | Average | build, version, server_zone, location_zone |
PT1M | Yes |
Category: nginx resolver statistics
| Metric | Name in REST API | Unit | Aggregation | Dimensions | Time Grains | DS Export |
|---|---|---|---|---|---|---|
| Resolve address requests The number of requests to resolve addresses to names during the aggregation interval |
plus.resolvers.requests.addr |
Count | Total (Sum) | build, version, resolver_zone |
PT1M | Yes |
| Resolve name requests The number of requests to resolve names to addresses during the aggregation interval |
plus.resolvers.requests.name |
Count | Total (Sum) | build, version, resolver_zone |
PT1M | Yes |
| Resolve SRV requests The number of requests to resolve SRV records during the aggregation interval |
plus.resolvers.requests.srv |
Count | Total (Sum) | build, version, resolver_zone |
PT1M | Yes |
| FORMERR responses The number of FORMERR (Format error) responses during the aggregation interval |
plus.resolvers.responses.formerr |
Count | Total (Sum) | build, version, resolver_zone |
PT1M | Yes |
| Successful responses The number of successful responses during the aggregation interval |
plus.resolvers.responses.noerror |
Count | Total (Sum) | build, version, resolver_zone |
PT1M | Yes |
| NOTIMP responses The number of NOTIMP (Unimplemented) responses during the aggregation interval |
plus.resolvers.responses.notimp |
Count | Total (Sum) | build, version, resolver_zone |
PT1M | Yes |
| NXDOMAIN responses The number of NXDOMAIN (Host not found) responses during the aggregation interval |
plus.resolvers.responses.nxdomain |
Count | Total (Sum) | build, version, resolver_zone |
PT1M | Yes |
| Refused responses The number of REFUSED (Operation refused) responses during the aggregation interval |
plus.resolvers.responses.refused |
Count | Total (Sum) | build, version, resolver_zone |
PT1M | Yes |
| SERVFAIL responses The number of SERVFAIL (Server failure) responses during the aggregation interval |
plus.resolvers.responses.servfail |
Count | Total (Sum) | build, version, resolver_zone |
PT1M | Yes |
| Timed out requests The number of timed out requests during the aggregation interval |
plus.resolvers.responses.timedout |
Count | Total (Sum) | build, version, resolver_zone |
PT1M | Yes |
| Unknown error responses The number of requests completed with an unknown error during the aggregation interval |
plus.resolvers.responses.unknown |
Count | Total (Sum) | build, version, resolver_zone |
PT1M | Yes |
Category: nginx ssl statistics
| Metric | Name in REST API | Unit | Aggregation | Dimensions | Time Grains | DS Export |
|---|---|---|---|---|---|---|
| Handshakes failed - timeout The number of SSL handshakes failed because of a timeout during the aggregation interval |
plus.http.ssl.handshake_timeout |
Count | Total (Sum) | build, version, server_zone |
PT1M | Yes |
| HTTP successful SSL handshakes The total number of successful SSL handshakes during the aggregation interval |
plus.http.ssl.handshakes |
Count | Total (Sum) | build, version, server_zone |
PT1M | Yes |
| HTTP failed SSL handshakes The total number of failed SSL handshakes during the aggregation interval |
plus.http.ssl.handshakes.failed |
Count | Total (Sum) | build, version, server_zone |
PT1M | Yes |
| Handshakes failed - no shared cipher The number of SSL handshakes failed because of no shared cipher during the aggregation interval |
plus.http.ssl.no_common_cipher |
Count | Total (Sum) | build, version, server_zone |
PT1M | Yes |
| Handshakes failed - no common protocol The number of SSL handshakes failed because of no common protocol during the aggregation interval |
plus.http.ssl.no_common_protocol |
Count | Total (Sum) | build, version, server_zone |
PT1M | Yes |
| Handshakes failed - certificate rejected The number of failed SSL handshakes when nginx presented the certificate to the client but it was rejected with a corresponding alert message during the aggregation interval |
plus.http.ssl.peer_rejected_cert |
Count | Total (Sum) | build, version, server_zone |
PT1M | Yes |
| HTTP SSL session reuses The total number of session reuses during SSL handshakes in the aggregation interval |
plus.http.ssl.session.reuses |
Count | Total (Sum) | build, version, server_zone |
PT1M | Yes |
| Verify failures - expired cert SSL certificate verification errors - an expired or not yet valid certificate was presented by a client during the aggregation interval |
plus.http.ssl.verify_failures.expired_cert |
Count | Total (Sum) | build, version, server_zone |
PT1M | Yes |
| Verify failures - no certificate SSL certificate verification errors - a client did not provide the required certificate during the aggregation interval |
plus.http.ssl.verify_failures.no_cert |
Count | Total (Sum) | build, version, server_zone |
PT1M | Yes |
| Verify failures - other SSL certificate verification errors - other SSL certificate verification errors during the aggregation interval |
plus.http.ssl.verify_failures.other |
Count | Total (Sum) | build, version, server_zone |
PT1M | Yes |
| Verify failures - revoked cert SSL certificate verification errors - a revoked certificate was presented by a client during the aggregation interval |
plus.http.ssl.verify_failures.revoked_cert |
Count | Total (Sum) | build, version, server_zone |
PT1M | Yes |
| Failed SSL handshakes The total number of failed SSL handshakes during the aggregation interval |
plus.ssl.failed |
Count | Total (Sum) | build, version |
PT1M | Yes |
| Handshakes failed - timeout The number of SSL handshakes failed because of a timeout during the aggregation interval |
plus.ssl.handshake_timeout |
Count | Total (Sum) | build, version |
PT1M | Yes |
| Successful SSL handshakes The total number of successful SSL handshakes during the aggregation interval |
plus.ssl.handshakes |
Count | Total (Sum) | build, version |
PT1M | Yes |
| Handshakes failed - no shared cipher The number of SSL handshakes failed because of no shared cipher during the aggregation interval |
plus.ssl.no_common_cipher |
Count | Total (Sum) | build, version |
PT1M | Yes |
| Handshakes failed - no common protocol The number of SSL handshakes failed because of no common protocol during the aggregation interval |
plus.ssl.no_common_protocol |
Count | Total (Sum) | build, version |
PT1M | Yes |
| Handshakes failed - certificate rejected The number of failed SSL handshakes when nginx presented the certificate to the client but it was rejected with a corresponding alert message during the aggregation interval |
plus.ssl.peer_rejected_cert |
Count | Total (Sum) | build, version |
PT1M | Yes |
| SSL session reuses The total number of session reuses during SSL handshakes in the aggregation interval |
plus.ssl.reuses |
Count | Total (Sum) | build, version |
PT1M | Yes |
| Cert verify failures - expired cert SSL certificate verification errors - an expired or not yet valid certificate was presented by a client during the aggregation interval |
plus.ssl.verify_failures.expired_cert |
Count | Total (Sum) | build, version |
PT1M | Yes |
| Cert verify failures - hostname mismatch SSL certificate verification errors - server's certificate doesn't match the hostname during the aggregation interval |
plus.ssl.verify_failures.hostname_mismatch |
Count | Total (Sum) | build, version |
PT1M | Yes |
| Cert verify failures - no cert SSL certificate verification errors - a client did not provide the required certificate during the aggregation interval |
plus.ssl.verify_failures.no_cert |
Count | Total (Sum) | build, version |
PT1M | Yes |
| Cert verify failures - other SSL certificate verification errors - other SSL certificate verification errors during the aggregation interval |
plus.ssl.verify_failures.other |
Count | Total (Sum) | build, version |
PT1M | Yes |
| Cert verify failures - revoked cert SSL certificate verification errors - a revoked certificate was presented by a client during the aggregation interval |
plus.ssl.verify_failures.revoked_cert |
Count | Total (Sum) | build, version |
PT1M | Yes |
Category: nginx stream statistics
| Metric | Name in REST API | Unit | Aggregation | Dimensions | Time Grains | DS Export |
|---|---|---|---|---|---|---|
| Connections passed The total number of connections that were neither limited nor accounted as limited |
plus.stream.limit_conns.passed |
Count | Total (Sum) | build, version, limit_conn_zone |
PT1M | Yes |
| Connections rejected The total number of connections that were rejected |
plus.stream.limit_conns.rejected |
Count | Total (Sum) | build, version, limit_conn_zone |
PT1M | Yes |
| Connections rejected dry run The total number of connections accounted as rejected in the dry run mode |
plus.stream.limit_conns.rejected_dry_run |
Count | Total (Sum) | build, version, limit_conn_zone |
PT1M | Yes |
| Request bytes received The total number of bytes received from clients |
plus.stream.request.bytes_rcvd |
Bytes | Total (Sum) | build, version, server_zone |
PT1M | Yes |
| Request bytes sent The total number of bytes sent to clients |
plus.stream.request.bytes_sent |
Bytes | Total (Sum) | build, version, server_zone |
PT1M | Yes |
| SSL handshake failed - timeout The number of SSL handshakes failed because of a timeout during the aggregation interval |
plus.stream.ssl.handshake_timeout |
Count | Total (Sum) | build, version, server_zone |
PT1M | Yes |
| SSL handshakes total The total number of successful SSL handshakes during the aggregation interval |
plus.stream.ssl.handshakes |
Count | Total (Sum) | build, version, server_zone |
PT1M | Yes |
| SSL handshakes failed The total number of failed SSL handshakes during the aggregation interval |
plus.stream.ssl.handshakes.failed |
Count | Total (Sum) | build, version, server_zone |
PT1M | Yes |
| SSL handshake failed - no common cipher The number of SSL handshakes failed because of no shared cipher during the aggregation interval |
plus.stream.ssl.no_common_cipher |
Count | Total (Sum) | build, version, server_zone |
PT1M | Yes |
| SSL HS failed - no common protocol The number of SSL handshakes failed because of no common protocol during the aggregation interval |
plus.stream.ssl.no_common_protocol |
Count | Total (Sum) | build, version, server_zone |
PT1M | Yes |
| SSL handshake failed - rejected cert The number of failed SSL handshakes when nginx presented the certificate to the client but it was rejected with a corresponding alert message during the aggregation interval |
plus.stream.ssl.peer_rejected_cert |
Count | Total (Sum) | build, version, server_zone |
PT1M | Yes |
| SSL session reuses The total number of session reuses during SSL handshakes in the aggregation interval |
plus.stream.ssl.session.reuses |
Count | Total (Sum) | build, version, server_zone |
PT1M | Yes |
| SSL verify failures - expired cert SSL certificate verification errors - an expired or not yet valid certificate was presented by a client during the aggregation interval |
plus.stream.ssl.verify_failures.expired_cert |
Count | Total (Sum) | build, version, server_zone |
PT1M | Yes |
| SSL verify failures - no certificate SSL certificate verification errors - a client did not provide the required certificate during the aggregation interval |
plus.stream.ssl.verify_failures.no_cert |
Count | Total (Sum) | build, version, server_zone |
PT1M | Yes |
| SSL verify failures - other SSL certificate verification errors - other SSL certificate verification errors during the aggregation interval |
plus.stream.ssl.verify_failures.other |
Count | Total (Sum) | build, version, server_zone |
PT1M | Yes |
| SSL verify failures - revoked cert SSL certificate verification errors - a revoked certificate was presented by a client during the aggregation interval |
plus.stream.ssl.verify_failures.revoked_cert |
Count | Total (Sum) | build, version, server_zone |
PT1M | Yes |
| Status 2xx The total number of sessions completed with status codes '2xx' |
plus.stream.status.2xx |
Count | Total (Sum) | build, version, server_zone |
PT1M | Yes |
| Status 4xx The total number of sessions completed with status codes '4xx' |
plus.stream.status.4xx |
Count | Total (Sum) | build, version, server_zone |
PT1M | Yes |
| Status 5xx The total number of sessions completed with status codes '5xx' |
plus.stream.status.5xx |
Count | Total (Sum) | build, version, server_zone |
PT1M | Yes |
| Accepted connections The average number of connections accepted from clients |
plus.stream.status.connections |
Count | Average | build, version, server_zone |
PT1M | Yes |
| Connections discarded The average number of connections completed without creating a session |
plus.stream.status.discarded |
Count | Average | build, version, server_zone |
PT1M | Yes |
| Connections processing The average number of client connections that are currently being processed |
plus.stream.status.processing |
Count | Average | build, version, server_zone |
PT1M | Yes |
| Upstream active connections The current number of connections |
plus.stream.upstream.peers.conn.active |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream downstart The time when the server became 'unavail', 'checking', or 'unhealthy', in the ISO 8601 format with millisecond resolution |
plus.stream.upstream.peers.downstart |
MilliSeconds | Minimum | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream downtime Total time the server was in the 'unavail', 'checking', and 'unhealthy' states |
plus.stream.upstream.peers.downtime |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream fails The total number of unsuccessful attempts to communicate with the server |
plus.stream.upstream.peers.fails |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream health checks The total number of health check requests made |
plus.stream.upstream.peers.health_checks.checks |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream health checks fails The number of failed health checks |
plus.stream.upstream.peers.health_checks.fails |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream last health check pass Boolean indicating whether the last health check request was successful and passed tests |
plus.stream.upstream.peers.health_checks.last_passed |
Count | Minimum | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream health checks unhealthy How many times the server became unhealthy (state 'unhealthy') |
plus.stream.upstream.peers.health_checks.unhealthy |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream request bytes received The total number of bytes received from this server |
plus.stream.upstream.peers.request.bytes_rcvd |
Bytes | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream request bytes sent The total number of bytes sent to this server |
plus.stream.upstream.peers.request.bytes_sent |
Bytes | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream response time The average time to receive the last byte of data |
plus.stream.upstream.peers.response.time |
Count | Average | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream state checking Boolean indicating if any of the upstream servers are being checked |
plus.stream.upstream.peers.state.checking |
Count | Minimum | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream state down Boolean indicating if any of the upstream servers are down |
plus.stream.upstream.peers.state.down |
Count | Minimum | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream state draining Boolean indicating if any of the upstream servers are draining |
plus.stream.upstream.peers.state.draining |
Count | Minimum | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream state unavailable Boolean indicating if any of the upstream servers are unavailable |
plus.stream.upstream.peers.state.unavail |
Count | Minimum | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream state unhealthy Boolean indicating if any of the upstream servers are unhealthy |
plus.stream.upstream.peers.state.unhealthy |
Count | Minimum | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream state up Boolean indicating if all upstream servers are up |
plus.stream.upstream.peers.state.up |
Count | Minimum | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream unavail How many times the server became unavailable for client connections (state 'unavail') due to the number of unsuccessful attempts reaching the max_fails threshold |
plus.stream.upstream.peers.unavail |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream zombies The current number of servers removed from the group but still processing active client connections |
plus.stream.upstream.zombies |
Count | Average | build, version |
PT1M | Yes |
| Zone sync bytes in The number of bytes received by all nodes during the aggregation interval |
plus.stream.zone_sync.status.bytes_in |
Bytes | Total (Sum) | build, version |
PT1M | Yes |
| Zone sync bytes out The number of bytes sent by all nodes during the aggregation interval |
plus.stream.zone_sync.status.bytes_out |
Bytes | Total (Sum) | build, version |
PT1M | Yes |
| Zone sync messages in The number of messages received by all nodes during the aggregation interval |
plus.stream.zone_sync.status.msgs_in |
Count | Total (Sum) | build, version |
PT1M | Yes |
| Zone sync messages out The number of messages sent by all nodes during the aggregation interval |
plus.stream.zone_sync.status.msgs_out |
Count | Total (Sum) | build, version |
PT1M | Yes |
| Zone sync records pending The average number of records that need to be sent to the cluster during the aggregation interval |
plus.stream.zone_sync.zones.records_pending |
Count | Average | build, version, shared_memory_zone |
PT1M | Yes |
| Zone sync records total The average number of records stored in the shared memory zone by all nodes during the aggregation interval |
plus.stream.zone_sync.zones.records_total |
Count | Average | build, version, shared_memory_zone |
PT1M | Yes |
Category: nginx system statistics
| Metric | Name in REST API | Unit | Aggregation | Dimensions | Time Grains | DS Export |
|---|---|---|---|---|---|---|
| CPU utilization System CPU Utilization |
system.cpu |
Count | Total (Sum) | <none> | PT1M | Yes |
| Interface bytes received System Interface Bytes Received |
system.interface.bytes_rcvd |
Bytes | Total (Sum) | interface |
PT1M | Yes |
| Interface bytes sent System Interface Bytes Sent |
system.interface.bytes_sent |
Bytes | Total (Sum) | interface |
PT1M | Yes |
| Interface egress throughput System Interface Egress Throughput, i.e. bytes sent per second |
system.interface.egress_throughput |
BytesPerSecond | Total (Sum) | interface |
PT1M | Yes |
| Interface packets received System Interface Packets Received |
system.interface.packets_rcvd |
Count | Total (Sum) | interface |
PT1M | Yes |
| Interface packets sent System Interface Packets Sent |
system.interface.packets_sent |
Count | Total (Sum) | interface |
PT1M | Yes |
| Interface total bytes System Interface Total Bytes, sum of bytes_sent and bytes_rcvd |
system.interface.total_bytes |
Bytes | Total (Sum) | interface |
PT1M | Yes |
Category: nginx upstream statistics
| Metric | Name in REST API | Unit | Aggregation | Dimensions | Time Grains | DS Export |
|---|---|---|---|---|---|---|
| Upstream keepalive connections The current number of idle keepalive connections |
plus.http.upstream.keepalives |
Count | Total (Sum) | build, version |
PT1M | Yes |
| Upstream active connections The number of active client connections during the aggregation interval |
plus.http.upstream.peers.conn.active |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream total connections The total number of client connections forwarded to this server during the aggregation interval |
plus.http.upstream.peers.connections |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream server downstart The time when the server became 'unavail', 'checking', or 'unhealthy', as a UTC timestamp |
plus.http.upstream.peers.downstart |
Count | Minimum | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream server fails The total number of unsuccessful attempts to communicate with the server during the aggregation interval |
plus.http.upstream.peers.fails |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream server header time The average time to get the response header from the server |
plus.http.upstream.peers.header.time |
Count | Average | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream server health checks The total number of health check requests made during the aggregation interval |
plus.http.upstream.peers.health_checks.checks |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream server health checks fails The number of failed health checks during the aggregation interval |
plus.http.upstream.peers.health_checks.fails |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream server health checks last pass Indicating if the last health check request was successful and passed tests |
plus.http.upstream.peers.health_checks.last_passed |
Count | Minimum | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream server health checks unhealthy How many times the server became unhealthy (state 'unhealthy') during the aggregation interval |
plus.http.upstream.peers.health_checks.unhealthy |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream server request bytes received The total number of bytes received in HTTP requests during the aggregation interval |
plus.http.upstream.peers.request.bytes_rcvd |
Bytes | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream server request bytes sent The total number of bytes sent in HTTP requests during the aggregation interval |
plus.http.upstream.peers.request.bytes_sent |
Bytes | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream HTTP requests The total number of HTTP requests during the aggregation interval |
plus.http.upstream.peers.request.count |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream server HTTP responses The total number of HTTP responses during the aggregation interval |
plus.http.upstream.peers.response.count |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream server response time The average time to get the full response from the server during the aggregation interval |
plus.http.upstream.peers.response.time |
Count | Average | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream SSL handshake timeout The number of SSL handshakes failed because of a timeout during the aggregation interval |
plus.http.upstream.peers.ssl.handshake_timeout |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream SSL handshakes The total number of successful SSL handshakes during the aggregation interval |
plus.http.upstream.peers.ssl.handshakes |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream SSL handshakes failed The total number of failed SSL handshakes during the aggregation interval |
plus.http.upstream.peers.ssl.handshakes.failed |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream SSL no common protocol The number of SSL handshakes failed because of no common protocol during the aggregation interval |
plus.http.upstream.peers.ssl.no_common_protocol |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| SSL handshake failed - rejected cert The number of failed SSL handshakes when nginx presented the certificate to the client but it was rejected with a corresponding alert message during the aggregation interval |
plus.http.upstream.peers.ssl.peer_rejected_cert |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream SSL session reuses The total number of session reuses during SSL handshake in the aggregation interval |
plus.http.upstream.peers.ssl.session.reuses |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| SSL verify failures - expired cert SSL certificate verification errors - an expired or not yet valid certificate was presented by a client during the aggregation interval |
plus.http.upstream.peers.ssl.verify_failures.expired_cert |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| SSL verify failures - hostname mismatch SSL certificate verification errors - server's certificate doesn't match the hostname during the aggregation interval |
plus.http.upstream.peers.ssl.verify_failures.hostname_mismatch |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| SSL verify failures - other SSL certificate verification errors - other SSL certificate verification errors during the aggregation interval |
plus.http.upstream.peers.ssl.verify_failures.other |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| SSL verify failures - revoked cert SSL certificate verification errors - a revoked certificate was presented by a client during the aggregation interval |
plus.http.upstream.peers.ssl.verify_failures.revoked_cert |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream server state checking Current state of upstream servers in deployment. If any of the upstream servers in the deployment is being checked then the value will be 1. If no upstream server is being checked then the value will be 0 |
plus.http.upstream.peers.state.checking |
Count | Maximum | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream server state down Current state of upstream servers in deployment. If any of the upstream servers in the deployment are down, then the value will be 1. If no upstream server is down, then the value will be 0 |
plus.http.upstream.peers.state.down |
Count | Maximum | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream server state draining Current state of upstream servers in deployment. If any of the upstream servers in the deployment are draining, then the value will be 1. If no upstream server is draining, then the value will be 0 |
plus.http.upstream.peers.state.draining |
Count | Maximum | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream server state unavailable Current state of upstream servers in deployment. If any of the upstream servers in the deployment are unavailable, then the value will be 1. If no upstream server is unavailable, then the value will be 0 |
plus.http.upstream.peers.state.unavail |
Count | Maximum | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream server state unhealthy Current state of upstream servers in deployment. If any of the upstream servers in the deployment are unhealthy then the value will be 1. If no upstream server is unhealthy then the value will be 0 |
plus.http.upstream.peers.state.unhealthy |
Count | Maximum | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream server state up Current state of upstream servers in deployment. If all upstream servers in the deployment are up, then the value will be 1. If any upstream server is not up, then the value will be 0 |
plus.http.upstream.peers.state.up |
Count | Minimum | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream server HTTP 1xx responses The total number of HTTP responses with a 1xx status code during the aggregation interval |
plus.http.upstream.peers.status.1xx |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream server HTTP 2xx responses The total number of HTTP responses with a 2xx status code during the aggregation interval |
plus.http.upstream.peers.status.2xx |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream server HTTP 3xx responses The total number of HTTP responses with a 3xx status code during the aggregation interval |
plus.http.upstream.peers.status.3xx |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream server HTTP 4xx responses The total number of HTTP responses with a 4xx status code during the aggregation interval |
plus.http.upstream.peers.status.4xx |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream server HTTP 5xx responses The total number of HTTP responses with a 5xx status code during the aggregation interval |
plus.http.upstream.peers.status.5xx |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream server unavailable The number of times the server became unavailable for client requests (state 'unavail') due to the number of unsuccessful attempts reaching the max_fails threshold during the aggregation interval |
plus.http.upstream.peers.unavail |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Upstream queue max size The maximum number of requests that can be in the queue at the same time |
plus.http.upstream.queue.maxsize |
Count | Average | build, version |
PT1M | Yes |
| Upstream queue overflows The total number of requests rejected due to the queue overflow |
plus.http.upstream.queue.overflows |
Count | Total (Sum) | build, version |
PT1M | Yes |
| Upstream queue size The current number of requests in the queue |
plus.http.upstream.queue.size |
Count | Average | build, version |
PT1M | Yes |
| Upstream zombies The current number of servers removed from the group but still processing active client requests |
plus.http.upstream.zombies |
Count | Average | build, version |
PT1M | Yes |
| Stream SSL handshake timeout The number of SSL handshakes failed because of a timeout during the aggregation interval |
plus.stream.upstream.peers.ssl.handshake_timeout |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Stream SSL handshakes total The total number of successful SSL handshakes during the aggregation interval |
plus.stream.upstream.peers.ssl.handshakes |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Stream SSL handshakes failed The total number of failed SSL handshakes during the aggregation interval |
plus.stream.upstream.peers.ssl.handshakes.failed |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Stream HS failed - no common protocol The number of SSL handshakes failed because of no common protocol during the aggregation interval |
plus.stream.upstream.peers.ssl.no_common_protocol |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Stream verify failure - rejected cert The number of failed SSL handshakes when nginx presented the certificate to the client but it was rejected with a corresponding alert message during the aggregation interval |
plus.stream.upstream.peers.ssl.peer_rejected_cert |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Stream SSL session reuses The total number of session reuses during SSL handshake in the aggregation interval |
plus.stream.upstream.peers.ssl.session.reuses |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Stream verify failure - expired cert SSL certificate verification errors - an expired or not yet valid certificate was presented by a client during the aggregation interval |
plus.stream.upstream.peers.ssl.verify_failures.expired_cert |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Stream verify failure hostname mismatch SSL certificate verification errors - server's certificate doesn't match the hostname during the aggregation interval |
plus.stream.upstream.peers.ssl.verify_failures.hostname_mismatch |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Stream SSL verify failure - other SSL certificate verification errors - other SSL certificate verification errors during the aggregation interval |
plus.stream.upstream.peers.ssl.verify_failures.other |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
| Stream verify failure - revoked cert SSL certificate verification errors - a revoked certificate was presented by a client during the aggregation interval |
plus.stream.upstream.peers.ssl.verify_failures.revoked_cert |
Count | Total (Sum) | build, version, upstream, peer.address, peer.name |
PT1M | Yes |
Category: nginx worker statistics
| Metric | Name in REST API | Unit | Aggregation | Dimensions | Time Grains | DS Export |
|---|---|---|---|---|---|---|
| Worker connections accepted The total number of client connections accepted by the worker process during the aggregation interval |
plus.worker.conn.accepted |
Count | Total (Sum) | build, version, worker_id |
PT1M | Yes |
| Active worker connections The current number of active client connections that are currently being handled by the worker process during the aggregation interval |
plus.worker.conn.active |
Count | Total (Sum) | build, version, worker_id |
PT1M | Yes |
| Worker connections dropped The total number of client connections dropped by the worker process during the aggregation interval |
plus.worker.conn.dropped |
Count | Total (Sum) | build, version, worker_id |
PT1M | Yes |
| Idle worker connections The number of idle client connections that are currently being handled by the worker process during the aggregation interval |
plus.worker.conn.idle |
Count | Total (Sum) | build, version, worker_id |
PT1M | Yes |
| Current worker HTTP requests The current number of client requests that are currently being processed by the worker process during the aggregation interval |
plus.worker.http.request.current |
Count | Total (Sum) | build, version, worker_id |
PT1M | Yes |
| Total worker HTTP requests The total number of client requests received by the worker process during the aggregation interval |
plus.worker.http.request.total |
Count | Total (Sum) | build, version, worker_id |
PT1M | Yes |
Category: nginxaas statistics
| Metric | Name in REST API | Unit | Aggregation | Dimensions | Time Grains | DS Export |
|---|---|---|---|---|---|---|
| NCU provisioned The number of successfully provisioned NCUs during the aggregation interval. During scaling events, this may lag behind ncu.requested as the system works to achieve the request. Available for Standard plan deployments |
ncu.provisioned |
Count | Total (Sum) | <none> | PT1M | Yes |
| NCU requested The requested number of NCUs during the aggregation interval. Describes the goal state of the system. Available for Standard plan deployments |
ncu.requested |
Count | Total (Sum) | <none> | PT1M | Yes |
| NGINXaaS capacity percentage The percentage of the deployment's total capacity being used. This may burst above 100%. Available for Standard plan deployments |
nginxaas.capacity.percentage |
Count | Total (Sum) | <none> | PT1M | Yes |
| Certificates The number of certificates added to the NGINXaaS deployment dimensioned by the name of the certificate and its status |
nginxaas.certificates |
Count | Total (Sum) | name, status |
PT1M | Yes |
| Maxmind status The status of any MaxMind license in use for downloading geoip2 databases. Refer to License Health to learn more about the status dimension |
nginxaas.maxmind |
Count | Total (Sum) | status |
PT1M | Yes |
| Ports used The number of listen ports used by the deployment during the aggregation interval. |
ports.used |
Count | Total (Sum) | <none> | PT1M | Yes |
| Listener backlog length The length of listener backlog during the aggregation interval. This represents the number of pending connections in the queue at any given time. |
system.listener_backlog.length |
Count | Total (Sum) | listen_address, file_desc |
PT1M | Yes |
| Max listener backlog The max listener backlog during the aggregation interval. The number of incoming connections that can be queued by the operating system before NGINX accepts and processes them. |
system.listener_backlog.max |
Count | Maximum | listen_addr, file_desc |
PT1M | Yes |
| Listener backlog queue limit The queue limit for listener backlog during the aggregation interval. This indicates the maximum number of pending connections that can be queued for a specific listener before the server starts refusing new connections. |
system.listener_backlog.queue_limit |
Count | Total (Sum) | listen_address, file_desc |
PT1M | Yes |
| Worker connections The number of nginx worker connections used on the dataplane. This metric is one of the factors which determines the deployment's consumed NCU value |
system.worker_connections |
Count | Total (Sum) | pid, process_name |
PT1M | Yes |
| Web application firewall enabled Current status of Web Application Firewall on the deployment. |
waf.enabled |
Count | Total (Sum) | <none> | PT1M | Yes |