Docs » Integrations Guide » Integrations Reference » NGINX Plus

../../_images/integrations_nginxplus.png NGINX Plus πŸ”—

DESCRIPTION πŸ”—

This is the SignalFx NGINX Plus plugin. Follow these instructions to install the NGINX Plus plugin for collectd.

The niginx-plus-collectd plugin collects metrics about a single NGINX Plus instance, using the /status endpoints exposed with the ngx_http_status_module, documentation here.

FEATURES πŸ”—

Built-in dashboards πŸ”—

  • NGINX+ Overview: Provides a high-level overview of key metrics for each NGINX Plus instance.

    ../../_images/overview_dashboard.png

  • NGINX+ Server Connections: Provides connection and SSL metrics for a single NIGNX Plus instance.

    ../../_images/connections_dashboard.png

  • NGINX+ Server Server Zones: Provides server zone metrics for a single NGINX Plus instance.

    ../../_images/server_zones_dashboard.png

  • NGINX+ Server Upstreams: Provides upstream group metrics for a single NGINX Plus instance.

    ../../_images/server_zones_dashboard.png

INSTALLATION πŸ”—

  1. Download the niginx-plus-collectd project.

  2. Run the following command to install the module’s dependencies using pip, replacing the example path with the download location of the niginx-plus-collectd project:

     sudo pip install -r install_requirements.txt
    
  3. Download SignalFx’s sample configuration file for this plugin to /etc/collectd/managed_config.

  4. Modify the configuration file to provide values that make sense for your environment, as described in Configuration below.

  5. Restart collectd.

CONFIGURATION πŸ”—

Using the example configuration file 10-nginx-plus.conf as a guide, provide values for the configuration options listed below that make sense for your environment.

Configuration Option Definition Default Value
ModulePath Path where collectd can find this module. /usr/share/collectd/niginx-plus-collectd/plugin
StatusHost IP address or DNS of the NGINX+ instance to retrieve status information from localhost
StatusPort Port the NGINX+ status endpoint can be reached at. 8080
DebugLogLevel true to enable logging at DEBUG level. false
Username Username to use for username/password authentication. None
Password Password to use for username/password authentication. None
Dimension A single additional dimension decorating to each metric. There are two values, the first for the name, the second for the value. None

Example configuration:

LoadPlugin python

<Plugin python>
  ModulePath "/usr/share/collectd/collectd-nginx-plus/plugin"
  Import nginx_plus_collectd

  <Module nginx_plus_collectd>
    StatusHost "localhost"
    StatusPort "8080"
    DebugLogLevel true
    Username "user_1"
    Password "my_password"
    Dimension "extra_dimension_name_1" "extra_dimension_value_1"
    Dimension "extra_dimension_name_2" "extra_dimension_value_2"
  </Module>
</Plugin>

By default only a subset of the available metrics are published by default. The remaining metrics can be enabled by opting-in to additional metric groups. See Usage for more details on each metric group and how to enable them.

USAGE πŸ”—

All metrics reported by the NGINX Plus collectd plugin will contain the following dimensions:

  • nginx.version will contain the version number of the NGINX Plus instance being monitored
  • plugin is always set to nginx-plus
  • plugin_instance will contain the IP address of the NGINX Plus instance as given in the /status/address response and the port given in the StatusPort configuration property.

Default Metrics πŸ”—

The default metrics report the values necessary to power the default dashboards. This includes high-level connection information, cache, server zone and upstreams metrics.

Metrics πŸ”—

  • connections.accepted
  • connections.dropped
  • connections.idle
  • connections.active
  • ssl.handshakes.successful
  • ssl.handshakes.failed
  • ssl.handshakes.reuses
  • requests.total
  • requests.current
  • server.zone.requests
  • server.zone.responses.1xx
  • server.zone.responses.2xx
  • server.zone.responses.3xx
  • server.zone.responses.4xx
  • server.zone.responses.5xx
  • server.zone.responses.total
  • server.zone.responses.received
  • server.zone.bytes.received
  • server.zone.bytes.sent
  • caches.size
  • caches.size.max
  • upstreams.requests
  • upstreams.responses.1xx
  • upstreams.responses.2xx
  • upstreams.responses.3xx
  • upstreams.responses.4xx
  • upstreams.responses.5xx
  • upstreams.responses.total
  • upstreams.downtime
  • upstreams.response.time
  • upstreams.bytes.received
  • upstreams.bytes.sent

Server Zone Metrics πŸ”—

Server Zone metrics are emitted for each server in each status zone. To include these metrics, add ServerZone true to the plugin configuration, e.g.

  <Module nginx_plus_collectd>
    StatusHost "localhost"
    StatusPort "8080"
    ServerZone true
  </Module>

Metrics πŸ”—

  • server.zone.processing
  • server.zone.discarded

Memory Zone Metrics πŸ”—

Memory Zone metrics are emitted for each shared memory zone that uses a slab allocator. To include these metrics, add MemoryZone true to the plugin configuration, e.g.

  <Module nginx_plus_collectd>
    StatusHost "localhost"
    StatusPort "8080"
    MemoryZone true
  </Module>

Metrics πŸ”—

  • zone.pages.used
  • zone.pages.free

Upstream Metrics πŸ”—

Upstream metrics are emitted for each server in each http-context upstream group. To include these metrics, add Upstream true to the plugin configuration, e.g.

  <Module nginx_plus_collectd>
    StatusHost "localhost"
    StatusPort "8080"
    Upstream true
  </Module>

Metrics πŸ”—

  • upstreams.active
  • upstreams.fails
  • upstreams.unavailable
  • upstreams.health.checks.checks
  • upstreams.health.checks.fails
  • upstreams.health.checks.unhealthy
  • upstreams.header.time
  • upstreams.keepalive
  • upstreams.zombies

Cache Metrics πŸ”—

Cache metrics are emitted for each cache, e.g. proxy cache. To include these metrics, add Cache true to the plugin configuration, e.g.

  <Module nginx_plus_collectd>
    StatusHost "localhost"
    StatusPort "8080"
    Cache true
  </Module>

Metrics πŸ”—

  • caches.hit.responses
  • caches.miss.responses
  • caches.stale.responses
  • caches.updating.responses
  • caches.revalidated.responses
  • caches.expired.responses
  • caches.bypass.responses
  • caches.hit.bytes
  • caches.miss.bytes
  • caches.stale.bytes
  • caches.updating.bytes
  • caches.revalidated.bytes
  • caches.expired.bytes
  • caches.bypass.bytes
  • caches.miss.responses.written
  • caches.expired.responses.written
  • caches.bypass.responses.written
  • caches.miss.bytes.written
  • caches.expired.bytes.written
  • caches.bypass.bytes.written

Stream Server Zone Metrics πŸ”—

Stream Server Zone metrics are emitted for each server in each stream-context status zone. To include these metrics, add StreamServerZone true to the plugin configuration, e.g.

  <Module nginx_plus_collectd>
    StatusHost "localhost"
    StatusPort "8080"
    StreamServerZone true
  </Module>

Metrics πŸ”—

  • stream.server.zone.connections
  • stream.server.zone.processing
  • stream.server.zone.sessions.2xx
  • stream.server.zone.sessions.4xx
  • stream.server.zone.sessions.5xx
  • stream.server.zone.received
  • stream.server.zone.sent
  • stream.server.zone.discarded

Stream Upstream Metrics πŸ”—

Stream Upstream metrics are emitted for each server in each stream-context upstream group. To include these metrics, add StreamUpstream true to the plugin configuration, e.g.

  <Module nginx_plus_collectd>
    StatusHost "localhost"
    StatusPort "8080"
    StreamUpstream true
  </Module>

Metrics πŸ”—

  • stream.upstreams.connections
  • stream.upstreams.active
  • stream.upstreams.connections.max
  • stream.upstreams.bytes.sent
  • stream.upstreams.bytes.received
  • stream.upstreams.fails
  • stream.upstreams.unavailable
  • stream.upstreams.health.checks.checks
  • stream.upstreams.health.checks.fails
  • stream.upstreams.health.checks.unhealthy
  • stream.upstreams.response.time
  • stream.upstreams.downtime
  • stream.upstreams.bytes.received
  • stream.upstreams.bytes.sent
  • stream.upstreams.zombies

Processes Metrics πŸ”—

Process metrics only include the default dimensions. To include these metrics, add Processes true to the plugin configuration, e.g.

  <Module nginx_plus_collectd>
    StatusHost "localhost"
    StatusPort "8080"
    Processes true
  </Module>

Metrics πŸ”—

  • processes.respawned

METRICS πŸ”—

Metric Name Description Type
counter.caches.bypass.bytes Total bytes read from an origin server due to a proxy_cache_bypass directive cumulative
counter.caches.bypass.bytes.written Total bytes written to the cache from responses that matched a proxy_cache_bypass directive cumulative
counter.caches.bypass.responses Total responses from an origin server due to a proxy_cache_bypass directive cumulative
counter.caches.bypass.responses.written Total responses written to the cache from responses that matched a proxy_cache_bypass directive cumulative
counter.caches.expire.bytes Total bytes read from an origin server due to expired cache entries cumulative
counter.caches.expire.bytes.written Total bytes written to the cache due to expired entries cumulative
counter.caches.expire.responses Total responses from an origin server due to expired cache entries cumulative
counter.caches.expire.responses.written Total responses written to the cache due to expired entries cumulative
counter.caches.hit.bytes Total bytes read on cache hits cumulative
counter.caches.hit.responses Total responses read on cache hits cumulative
counter.caches.miss.bytes Total bytes not found in the cache and fetched from the origin server cumulative
counter.caches.miss.bytes.written Total bytes written to the cache due to cache misses cumulative
counter.caches.miss.responses Total responses taken from an origin server instead of the cache cumulative
counter.caches.miss.responses.written Total responses written to the cache after a miss cumulative
counter.caches.revalidated.bytes Total revalidated bytes read from the cache cumulative
counter.caches.revalidated.responses Total revalidated responses read from the cache cumulative
counter.caches.stale.bytes Total stale bytes read from the cache cumulative
counter.caches.stale.responses Total stale responses read from the cache cumulative
counter.caches.updating.bytes Total stale responses read from the cache while content was being updated cumulative
counter.caches.updating.responses Total stale responses read from the cache while content was being updated cumulative
counter.connections.accepted Total accepted connections cumulative
counter.connections.dropped Total dropped connections cumulative
counter.processes.respawned Total number of abnormally terminated and respawned child processes. cumulative
counter.requests.total Total number of requests cumulative
counter.server.zone.bytes.received Number of bytes received by a server zone cumulative
counter.server.zone.bytes.sent Number of bytes sent by a server zone cumulative
counter.server.zone.discarded Total requests completed without sending a response cumulative
counter.server.zone.processing Requests currently being processed cumulative
counter.server.zone.requests Total requests received from clients cumulative
counter.server.zone.responses.1xx Total 1xx status code responses cumulative
counter.server.zone.responses.2xx Total 2xx status code responses cumulative
counter.server.zone.responses.3xx Total 3xx status code responses cumulative
counter.server.zone.responses.4xx Total 4xx status code responses cumulative
counter.server.zone.responses.5xx Total 5xx status code responses cumulative
counter.server.zone.responses.total Total responses sent to clients cumulative
counter.ssl.handshakes.failed Total failed SSL handshakes cumulative
counter.ssl.handshakes.successful Total successful SSL handshakes cumulative
counter.ssl.sessions.reuses Total SSL session reuses cumulative
counter.stream.server.zone.connections Total accepted connections cumulative
counter.stream.server.zone.discarded Total connections completed without a session cumulative
counter.stream.server.zone.processing Connections that are currently being processed cumulative
counter.stream.server.zone.received Total bytes received from clients cumulative
counter.stream.server.zone.sent Total bytes sent to clients cumulative
counter.stream.server.zone.sessions.2xx Completed sessions with a 2xx status code cumulative
counter.stream.server.zone.sessions.4xx Completed sessions with a 4xx status code cumulative
counter.stream.server.zone.sessions.5xx Completed sessions with a 5xx status code cumulative
counter.stream.upstreams.active The current number of connections for a stream upstream server cumulative
counter.stream.upstreams.bytes.received Total number of bytes received from a stream upstream server cumulative
counter.stream.upstreams.bytes.sent Total number of bytes sent to a stream upstream server cumulative
counter.stream.upstreams.connections.max Maximum number of simultaneous connections to a stream upstream server cumulative
counter.stream.upstreams.connections Total number of connections forwarded to a stream upstream server cumulative
counter.stream.upstreams.downtime Total time the stream upstream server was in the unavail, checking, and unhealthy states cumulative
counter.stream.upstreams.fails Total number of unsuccessful attempts to communicate with stream upstream server cumulative
counter.stream.upstreams.health.checks.checks Total health check requests made to a stream upstream server server cumulative
counter.stream.upstreams.health.checks.fails Total failed health check requests made to a stream upstream server server cumulative
counter.stream.upstreams.health.checks.unhealthy Total number of times a stream upstream server became unhealthy cumulative
counter.stream.upstreams.unavailable Number of times a stream upstream server server became unavailable for client connections cumulative
counter.upstreams.active Current number of active connections for an upstream server cumulative
counter.upstreams.bytes.received Total number of bytes received from an upstream server cumulative
counter.upstreams.bytes.sent Total number of bytes sent to an upstream server cumulative
counter.upstreams.downtime Total time the server was in the unavail, checking, and unhealthy states cumulative
counter.upstreams.fails Total failed attempts to communicate with an upstream server cumulative
counter.upstreams.health.checks.checks Total failed health check requests made to an upstream server cumulative
counter.upstreams.health.checks.fails Total failed health check requests made to an upstream server cumulative
counter.upstreams.health.checks.unhealthy Total number of times an upstream server became unhealthy cumulative
counter.upstreams.requests Total number of client requests forwarded to an upstream server cumulative
counter.upstreams.responses.1xx Total 1xx status code responses from an upstream server cumulative
counter.upstreams.responses.2xx Total 2xx status code responses from an upstream server cumulative
counter.upstreams.responses.3xx Total 3xx status code responses from an upstream server cumulative
counter.upstreams.responses.4xx Total 4xx status code responses from an upstream server cumulative
counter.upstreams.responses.5xx Total 5xx status code responses from an upstream server cumulative
counter.upstreams.responses.total Total responses obtained from an upstream server cumulative
counter.upstreams.unavailable Number of times an upstream peer server became unavailable for client connections cumulative
counter.zone.pages.free Current number of free memory pages cumulative
counter.zone.pages.used Current number of used memory pages cumulative
gauge.caches.size.max Maximum size of the cache gauge
gauge.caches.size Current size of the cache gauge
gauge.connections.active Current number of active connections gauge
gauge.connections.idle Total idle connections gauge
gauge.requests.current Current number of client requests gauge
gauge.stream.upstreams.response.time Average time to get the full response from the server gauge
gauge.stream.upstreams.zombies Current number of servers removed from the stream upstream group but still processing active client requests gauge
gauge.upstreams.header.time Average time to get the response header from the server gauge
gauge.upstreams.keepalive The current number of idle keepalive connections gauge
gauge.upstreams.response.time Average time to get the full response from the server gauge
gauge.upstreams.zombies Current number of servers removed from the group but still processing active client requests gauge

counter.caches.bypass.bytes πŸ”—

cumulative

The total number of bytes read from an origin server rather than the cache due to a matching proxy_cache_bypass directive. This metric is reported with the dimension cache.name to indicate the name of the cache.

counter.caches.bypass.bytes.written πŸ”—

cumulative

The total number of bytes written to the cache that matched a proxy_cache_bypass directive. This metric is reported with the dimension cache.name to indicate the name of the cache.

counter.caches.bypass.responses πŸ”—

cumulative

The total number of responses from an origin server rather than the cache due to a matching proxy_cache_bypass directive. This metric is reported with the dimension cache.name to indicate the name of the cache.

counter.caches.bypass.responses.written πŸ”—

cumulative

The total number of responses written to the cache that matched a proxy_cache_bypass directive. This metric is reported with the dimension cache.name to indicate the name of the cache.

counter.caches.expire.bytes πŸ”—

cumulative

The total number of bytes read from an origin server due to expired cache entries. This metric is reported with the dimension cache.name to indicate the name of the cache.

counter.caches.expire.bytes.written πŸ”—

cumulative

The total number of bytes written to the cache due to expired entries. This metric is reported with the dimension cache.name to indicate the name of the cache.

counter.caches.expire.responses πŸ”—

cumulative

The total number of responses from an origin server due to expired cache entries. This metric is reported with the dimension cache.name to indicate the name of the cache.

counter.caches.expire.responses.written πŸ”—

cumulative

The total number of responses written to the cache due to expired entries. This metric is reported with the dimension cache.name to indicate the name of the cache.

counter.caches.hit.bytes πŸ”—

cumulative

The total number of bytes read from the cache with valid, fresh data. This metric is reported with the dimension cache.name to indicate the name of the cache.

counter.caches.hit.responses πŸ”—

cumulative

The total number of responses read from the cache with valid, fresh data. This metric is reported with the dimension cache.name to indicate the name of the cache.

counter.caches.miss.bytes πŸ”—

cumulative

The total number of bytes from responses not found in the cache and fetched from the origin server. This metric is reported with the dimension cache.name to indicate the name of the cache.

counter.caches.miss.bytes.written πŸ”—

cumulative

The total number of bytes written to the cache after fetching from the origin server due to a missing entry. This metric is reported with the dimension cache.name to indicate the name of the cache.

counter.caches.miss.responses πŸ”—

cumulative

The total number of responses taken from the origin server and not the cache due to a missing entry. This metric is reported with the dimension cache.name to indicate the name of the cache.

counter.caches.miss.responses.written πŸ”—

cumulative

The total number of responses written to the cache after fetch from the origin server due to a missing entry. This metric is reported with the dimension cache.name to indicate the name of the cache.

counter.caches.revalidated.bytes πŸ”—

cumulative

The total number of bytes from revalidated responses read from the cache. This metric is reported with the dimension cache.name to indicate the name of the cache.

counter.caches.revalidated.responses πŸ”—

cumulative

The total number of revalidated responses read from the cache. This metric is reported with the dimension cache.name to indicate the name of the cache.

counter.caches.stale.bytes πŸ”—

cumulative

The total number of bytes from stale responses read from the cache due to the origin server not responding correctly. This metric is reported with the dimension cache.name to indicate the name of the cache.

counter.caches.stale.responses πŸ”—

cumulative

The total number of stale responses read from the cache due to the origin server not responding correctly. This metric is reported with the dimension cache.name to indicate the name of the cache.

counter.caches.updating.bytes πŸ”—

cumulative

The total number of bytes from stale responses read from the cache while the entry was being updated. This metric is reported with the dimension cache.name to indicate the name of the cache.

counter.caches.updating.responses πŸ”—

cumulative

The total number of stale responses read from the cache while the entry was being updated. This metric is reported with the dimension cache.name to indicate the name of the cache.

counter.connections.accepted πŸ”—

cumulative

The total number of accepted client connections. This metric is reported with the dimension nginx.version.

counter.connections.dropped πŸ”—

cumulative

The total number of dropped client connections. This metric is reported with the dimension nginx.version.

counter.processes.respawned πŸ”—

cumulative

The total number of abnormally terminated and respawned child processes. This metric is reported with the dimension nginx.version.

counter.requests.total πŸ”—

cumulative

The total number of client requests. This metric is reported with the dimension nginx.version.

counter.server.zone.bytes.received πŸ”—

cumulative

The total number of bytes received from clients across a single http server status zone. This metric is reported with dimension server.zone.name to indicate the name of the server status zone.

counter.server.zone.bytes.sent πŸ”—

cumulative

The total number of bytes sent to clients across a single http server status zone. This metric is reported with dimension server.zone.name to indicate the name of the server status zone.

counter.server.zone.discarded πŸ”—

cumulative

The total number of requests completed without sending a response across a single http server status zone. This metric is reported with dimension server.zone.name to indicate the name of the server status zone.

counter.server.zone.processing πŸ”—

cumulative

The number of client requests that are currently being processed across a single http server status zone. This metric is reported with dimension server.zone.name to indicate the name of the server status zone.

counter.server.zone.requests πŸ”—

cumulative

The total number of requests received from clients across a single http server status zone. This metric is reported with dimension server.zone.name to indicate the name of the server status zone.

counter.server.zone.responses.1xx πŸ”—

cumulative

The total number of client responses with a 1xx status code across a single http server status zone. This metric is reported with dimension server.zone.name to indicate the name of the server status zone.

counter.server.zone.responses.2xx πŸ”—

cumulative

The total number of client responses with a 2xx status code across a single http server status zone. This metric is reported with dimension server.zone.name to indicate the name of the server status zone.

counter.server.zone.responses.3xx πŸ”—

cumulative

The total number of client responses with a 3xx status code across a single http server status zone. This metric is reported with dimension server.zone.name to indicate the name of the server status zone.

counter.server.zone.responses.4xx πŸ”—

cumulative

The total number of client responses with a 4xx status code across a single http server status zone. This metric is reported with dimension server.zone.name to indicate the name of the server status zone.

counter.server.zone.responses.5xx πŸ”—

cumulative

The total number of client responses with a 5xx status code across a single http server status zone. This metric is reported with dimension server.zone.name to indicate the name of the server status zone.

counter.server.zone.responses.total πŸ”—

cumulative

The total number of responses sent to clients across a single http server status zone. This metric is reported with dimension server.zone.name to indicate the name of the server status zone.

counter.ssl.handshakes.failed πŸ”—

cumulative

The total number of failed SSL handshakes.

counter.ssl.handshakes.successful πŸ”—

cumulative

The total number of successful SSH handshakes.

counter.ssl.sessions.reuses πŸ”—

cumulative

The total number of session reuses during SSL handshake.

counter.stream.server.zone.connections πŸ”—

cumulative

The total number of connections accepted from clients across a single stream server status zone. This metric is reported with dimension stream.server.zone.name to indicate the name of the stream server status zone.

counter.stream.server.zone.discarded πŸ”—

cumulative

The total number of connections completed without creating a session across a single stream server status zone. This metric is reported with dimension stream.server.zone.name to indicate the name of the stream server status zone.

counter.stream.server.zone.processing πŸ”—

cumulative

The number of client connections that are currently being processed across a single stream server status zone. This metric is reported with dimension stream.server.zone.name to indicate the name of the stream server status zone.

counter.stream.server.zone.received πŸ”—

cumulative

The total number of bytes received from clients across a single stream server status zone. This metric is reported with dimension stream.server.zone.name to indicate the name of the stream server status zone.

counter.stream.server.zone.sent πŸ”—

cumulative

The total number of bytes received from clients across a single stream server status zone. This metric is reported with dimension stream.server.zone.name to indicate the name of the stream server status zone.

counter.stream.server.zone.sessions.2xx πŸ”—

cumulative

The total number of sessions completed with a 2xx status code across a single stream server status zone. This metric is reported with dimension stream.server.zone.name to indicate the name of the stream server status zone.

counter.stream.server.zone.sessions.4xx πŸ”—

cumulative

The total number of sessions completed with a 4xx status code across a single stream server status zone. This metric is reported with dimension stream.server.zone.name to indicate the name of the stream server status zone.

counter.stream.server.zone.sessions.5xx πŸ”—

cumulative

The total number of sessions completed with a 5xx status code across a single stream server status zone. This metric is reported with dimension stream.server.zone.name to indicate the name of the stream server status zone.

counter.stream.upstreams.active πŸ”—

cumulative

The current number of connections for a single stream upstream server. This metric is reported with dimensions stream.upstream.name and stream.upstream.peer.name to indicate the name of the upstream group and name of the individual server, respectively.

counter.stream.upstreams.bytes.received πŸ”—

cumulative

The total number of bytes received from a single stream upstream server. This metric is reported with dimensions stream.upstream.name and stream.upstream.peer.name to indicate the name of the upstream group and name of the individual server, respectively.

counter.stream.upstreams.bytes.sent πŸ”—

cumulative

The total number of bytes sent to a single stream upstream server. This metric is reported with dimensions stream.upstream.name and stream.upstream.peer.name to indicate the name of the upstream group and name of the individual server, respectively.

counter.stream.upstreams.connections.max πŸ”—

cumulative

The maximum number of simultaneous connections to a single stream upstream server. This metric is reported with dimensions stream.upstream.name and stream.upstream.peer.name to indicate the name of the upstream group and name of the individual server, respectively.

counter.stream.upstreams.connections πŸ”—

cumulative

The total number of client connections forwarded to a single stream upstream server. This metric is reported with dimensions stream.upstream.name and stream.upstream.peer.name to indicate the name of the upstream group and name of the individual server, respectively.

counter.stream.upstreams.downtime πŸ”—

cumulative

The total time the stream upstream server was in the unavail, checking, and unhealthy states. This metric is reported with dimensions upstream.name and upstream.peer.name to indicate the upstream group name and the individual server name.

counter.stream.upstreams.fails πŸ”—

cumulative

The total number of unsuccessful attempts to communicate with a stream upstream server. This metric is reported with dimensions stream.upstream.name and stream.upstream.peer.name to indicate the name of the upstream group and name of the individual server, respectively.

counter.stream.upstreams.health.checks.checks πŸ”—

cumulative

The total number of health check requests made to a stream upstream server server. This metric is reported with dimensions stream.upstream.name and stream.upstream.peer.name to indicate the name of the upstream group and name of the individual server, respectively.

counter.stream.upstreams.health.checks.fails πŸ”—

cumulative

The total number of failed health check requests made to a stream upstream server server. This metric is reported with dimensions stream.upstream.name and stream.upstream.peer.name to indicate the name of the upstream group and name of the individual server, respectively.

counter.stream.upstreams.health.checks.unhealthy πŸ”—

cumulative

The total number of times a stream upstream server entered the unhealthy state due to failed health checks. This metric is reported with dimensions stream.upstream.name and stream.upstream.peer.name to indicate the name of the upstream group and name of the individual server, respectively.

counter.stream.upstreams.unavailable πŸ”—

cumulative

The total number of times the server became unavailable for client connections due to the number of unsuccessful attempts reaching the max_fails threshold. This metric is reported with dimensions stream.upstream.name and stream.upstream.peer.name to indicate the name of the upstream group and name of the individual server, respectively.

counter.upstreams.active πŸ”—

cumulative

The current number of active connections for a single upstream server. This metric is reported with dimensions upstream.name and upstream.peer.name to indicate the upstream group name and the individual server name.

counter.upstreams.bytes.received πŸ”—

cumulative

The total number of bytes received from a single upstream server. This metric is reported with dimensions upstream.name and upstream.peer.name to indicate the name of the upstream group and name of the individual server, respectively.

counter.upstreams.bytes.sent πŸ”—

cumulative

The total number of bytes sent to a single upstream server. This metric is reported with dimensions stream.upstream.name and stream.upstream.peer.name to indicate the name of the upstream group and name of the individual server, respectively.

counter.upstreams.downtime πŸ”—

cumulative

The total time the server was in the unavail, checking, and unhealthy states. This metric is reported with dimensions upstream.name and upstream.peer.name to indicate the upstream group name and the individual server name.

counter.upstreams.fails πŸ”—

cumulative

The total number of unsuccessful attempts to communicate with a single upstream server. This metric is reported with dimensions upstream.name and upstream.peer.name to indicate the upstream group name and the individual server name.

counter.upstreams.health.checks.checks πŸ”—

cumulative

The total number of health check requests made to an upstream server. This metric is reported with dimensions upstream.name and upstream.peer.name to indicate the upstream group name and the individual server name.

counter.upstreams.health.checks.fails πŸ”—

cumulative

The total number of failed health check requests made to an upstream server. This metric is reported with dimensions upstream.name and upstream.peer.name to indicate the upstream group name and the individual server name.

counter.upstreams.health.checks.unhealthy πŸ”—

cumulative

The total number of times an upstream server entered the unhealthy state due to failed health checks. This metric is reported with dimensions upstream.name and upstream.peer.name to indicate the upstream group name and the individual server name.

counter.upstreams.requests πŸ”—

cumulative

The total number of client requests forwarded to an upstream server. This metric is reported with dimensions upstream.name and upstream.peer.name to indicate the upstream group name and the individual server name.

counter.upstreams.responses.1xx πŸ”—

cumulative

The total number of responses obtained from an upstream server with a 1xx status code. This metric is reported with dimensions upstream.name and upstream.peer.name to indicate the upstream group name and the individual server name.

counter.upstreams.responses.2xx πŸ”—

cumulative

The total number of responses obtained from an upstream server with a 2xx status code. This metric is reported with dimensions upstream.name and upstream.peer.name to indicate the upstream group name and the individual server name.

counter.upstreams.responses.3xx πŸ”—

cumulative

The total number of responses obtained from an upstream server with a 3xx status code. This metric is reported with dimensions upstream.name and upstream.peer.name to indicate the upstream group name and the individual server name.

counter.upstreams.responses.4xx πŸ”—

cumulative

The total number of responses obtained from an upstream server with a 4xx status code. This metric is reported with dimensions upstream.name and upstream.peer.name to indicate the upstream group name and the individual server name.

counter.upstreams.responses.5xx πŸ”—

cumulative

The total number of responses obtained from an upstream server with a 5xx status code. This metric is reported with dimensions upstream.name and upstream.peer.name to indicate the upstream group name and the individual server name.

counter.upstreams.responses.total πŸ”—

cumulative

The total number of responses obtained from an upstream server. This metric is reported with dimensions upstream.name and upstream.peer.name to indicate the upstream group name and the individual server name.

counter.upstreams.unavailable πŸ”—

cumulative

The total number of times the server became unavailable for client connections due to the number of unsuccessful attempts reaching the max_fails threshold. This metric is reported with dimensions upstream.name and upstream.peer.name to indicate the upstream group name and the individual server name.

counter.zone.pages.free πŸ”—

cumulative

The current number of free memory pages for a single shared memory zone. This metric is reported with the dimension memory.zone.name to indicate the name of the shared memory zone.

counter.zone.pages.used πŸ”—

cumulative

The current number of used memory pages for a single shared memory zone. This metric is reported with the dimension memory.zone.name to indicate the name of the shared memory zone.

gauge.caches.size.max πŸ”—

gauge

The limit on the maximum size of the cache in bytes. This metric is reported with the dimension cache.name to indicate the name of the cache.

gauge.caches.size πŸ”—

gauge

The current size of the cache in bytes. This metric is reported with the dimension cache.name to indicate the name of the cache.

gauge.connections.active πŸ”—

gauge

The current number of active client connections. This metric is reported with the dimension nginx.version.

gauge.connections.idle πŸ”—

gauge

The total number of idle client connections. This metric is reported with the dimension nginx.version.

gauge.requests.current πŸ”—

gauge

The current number of client requests. This metric is reported with the dimension nginx.version.

gauge.stream.upstreams.response.time πŸ”—

gauge

The average time to get the full response from the stream upstream server. This metric is reported with dimensions upstream.name and upstream.peer.name to indicate the upstream group name and the individual server name.

gauge.stream.upstreams.zombies πŸ”—

gauge

The current number of servers removed from the stream upstream group but still processing active client requests. This metric is reported with the upstream.name dimension to indicate the upstream group name.

gauge.upstreams.header.time πŸ”—

gauge

The average time to get the response header from the server. This metric is reported with dimensions upstream.name and upstream.peer.name to indicate the upstream group name and the individual server name.

gauge.upstreams.keepalive πŸ”—

gauge

The current number of idle keepalive connections for the entire upstream group. This metric is reported with the upstream.name dimension to indicate the upstream group name.

gauge.upstreams.response.time πŸ”—

gauge

The average time to get the full response from the server. This metric is reported with dimensions upstream.name and upstream.peer.name to indicate the upstream group name and the individual server name.

gauge.upstreams.zombies πŸ”—

gauge

The current number of servers removed from the group but still processing active client requests. This metric is reported with the upstream.name dimension to indicate the upstream group name.

By default only a subset (32) of the available metrics (87) are published by default. The remaining metrics can be enabled by opting-in to additional metric groups.