{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/396", "result": {"data":{"issuesJson":{"id":"00cc1fc1-f9f4-55a1-a687-032a1805f705","title":"nginxinc/nginx-prometheus-exporter: 用于 NGINX 和 NGINX Plus 的 NGINX Prometheus Exporter","number":396,"bodyHTML":"
\n



\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Reposnginxinc/nginx-prometheus-exporter
Views\"views\"
Stars\"stars\"
Forks\"forks\"
License\"license\"
UpdatedAt\"last-commit\"
CreatedAt\"create-at\"
\n\n

\"\"

\n\n
\n\n

\"OpenSSFScorecard\"
\n\"CI\"
\n\"FOSSA
\n\"Go
\n\"codecov\"
\n\"GitHub
\n\"GitHub
\n\"GitHub
\n\"nginx-prometheus-exporter\"
\n\"GitHub
\n\"Docker
\n\"Docker
\n\"Project

\n

NGINX Prometheus Exporter

\n

NGINX Prometheus exporter makes it possible to monitor NGINX or NGINX Plus using Prometheus.

\n\n\n

Table of Contents

\n\n\n

Overview

\n

NGINX exposes a handful of metrics via the stub_status
\npage. NGINX
\nPlus provides a richer set of metrics via the
\nAPI and the monitoring
\ndashboard. NGINX Prometheus exporter
\nfetches the metrics from a single NGINX or NGINX Plus, converts the metrics into appropriate Prometheus metrics types
\nand finally exposes them via an HTTP server to be collected by Prometheus.

\n

Getting Started

\n

In this section, we show how to quickly run NGINX Prometheus Exporter for NGINX or NGINX Plus.

\n

A Note about NGINX Ingress Controller

\n

If you’d like to use the NGINX Prometheus Exporter with NGINX Ingress
\nController for Kubernetes, see this
\ndoc for the installation
\ninstructions.

\n

Prerequisites

\n

We assume that you have already installed Prometheus and NGINX or NGINX Plus. Additionally, you need to:

\n\n

Running the Exporter in a Docker Container

\n

To start the exporter we use the docker run command.

\n\n

Running the Exporter Binary

\n\n

Note. The nginx-prometheus-exporter is not a daemon. To run the exporter as a system service (daemon), you can
\nfollow the example in examples/systemd. Alternatively, you can run the exporter
\nin a Docker container.

\n

Usage

\n

Command-line Arguments

\n
usage: nginx-prometheus-exporter [<flags>]\n\n\nFlags:\n  -h, --[no-]help                Show context-sensitive help (also try --help-long and --help-man).\n      --[no-]web.systemd-socket  Use systemd socket activation listeners instead\n                                 of port listeners (Linux only). ($SYSTEMD_SOCKET)\n      --web.listen-address=:9113 ...\n                                 Addresses on which to expose metrics and web interface. Repeatable for multiple addresses. ($LISTEN_ADDRESS)\n      --web.config.file=\"\"       Path to configuration file that can enable TLS or authentication. See: https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md ($CONFIG_FILE)\n      --web.telemetry-path=\"/metrics\"\n                                 Path under which to expose metrics. ($TELEMETRY_PATH)\n      --[no-]nginx.plus          Start the exporter for NGINX Plus. By default, the exporter is started for NGINX. ($NGINX_PLUS)\n      --nginx.scrape-uri=http://127.0.0.1:8080/stub_status ...\n                                 A URI or unix domain socket path for scraping NGINX or NGINX Plus metrics. For NGINX, the stub_status page must be available through the URI. For NGINX Plus -- the API. Repeatable for multiple URIs. ($SCRAPE_URI)\n      --[no-]nginx.ssl-verify    Perform SSL certificate verification. ($SSL_VERIFY)\n      --nginx.ssl-ca-cert=\"\"     Path to the PEM encoded CA certificate file used to validate the servers SSL certificate. ($SSL_CA_CERT)\n      --nginx.ssl-client-cert=\"\"\n                                 Path to the PEM encoded client certificate file to use when connecting to the server. ($SSL_CLIENT_CERT)\n      --nginx.ssl-client-key=\"\"  Path to the PEM encoded client certificate key file to use when connecting to the server. ($SSL_CLIENT_KEY)\n      --nginx.timeout=5s         A timeout for scraping metrics from NGINX or NGINX Plus. ($TIMEOUT)\n      --prometheus.const-label=PROMETHEUS.CONST-LABEL ...\n                                 Label that will be used in every metric. Format is label=value. It can be repeated multiple times. ($CONST_LABELS)\n      --log.level=info           Only log messages with the given severity or above. One of: [debug, info, warn, error]\n      --log.format=logfmt        Output format of log messages. One of: [logfmt, json]\n      --[no-]version             Show application version.
\n

Exported Metrics

\n

Common metrics

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescriptionLabels
nginx_exporter_build_infoGaugeShows the exporter build information.branch, goarch, goos, goversion, revision, tags and version
promhttp_metric_handler_requests_totalCounterTotal number of scrapes by HTTP status code.code (the HTTP status code)
promhttp_metric_handler_requests_in_flightGaugeCurrent number of scrapes being served.[]
go_*MultipleGo runtime metrics.[]
\n

Metrics for NGINX OSS

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescriptionLabels
nginx_upGaugeShows the status of the last metric scrape: 1 for a successful scrape and 0 for a failed one[]
\n

Stub status metrics

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescriptionLabels
nginx_connections_acceptedCounterAccepted client connections.[]
nginx_connections_activeGaugeActive client connections.[]
nginx_connections_handledCounterHandled client connections.[]
nginx_connections_readingGaugeConnections where NGINX is reading the request header.[]
nginx_connections_waitingGaugeIdle client connections.[]
nginx_connections_writingGaugeConnections where NGINX is writing the response back to the client.[]
nginx_http_requests_totalCounterTotal http requests.[]
\n

Metrics for NGINX Plus

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescriptionLabels
nginxplus_upGaugeShows the status of the last metric scrape: 1 for a successful scrape and 0 for a failed one[]
\n

Connections

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescriptionLabels
nginxplus_connections_acceptedCounterAccepted client connections[]
nginxplus_connections_activeGaugeActive client connections[]
nginxplus_connections_droppedCounterDropped client connections dropped[]
nginxplus_connections_idleGaugeIdle client connections[]
\n

HTTP

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescriptionLabels
nginxplus_http_requests_totalCounterTotal http requests[]
nginxplus_http_requests_currentGaugeCurrent http requests[]
\n

SSL

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescriptionLabels
nginxplus_ssl_handshakesCounterSuccessful SSL handshakes[]
nginxplus_ssl_handshakes_failedCounterFailed SSL handshakes[]
nginxplus_ssl_session_reusesCounterSession reuses during SSL handshake[]
\n

HTTP Server Zones

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescriptionLabels
nginxplus_server_zone_processingGaugeClient requests that are currently being processedserver_zone
nginxplus_server_zone_requestsCounterTotal client requestsserver_zone
nginxplus_server_zone_responsesCounterTotal responses sent to clientscode (the response status code. The values are: 1xx, 2xx, 3xx, 4xx and 5xx), server_zone
nginxplus_server_zone_responses_codesCounterTotal responses sent to clients by codecode (the response status code. The possible values are here), server_zone
nginxplus_server_zone_discardedCounterRequests completed without sending a responseserver_zone
nginxplus_server_zone_receivedCounterBytes received from clientsserver_zone
nginxplus_server_zone_sentCounterBytes sent to clientsserver_zone
nginxplus_server_ssl_handshakesCounterSuccessful SSL handshakesserver_zone
nginxplus_server_ssl_handshakes_failedCounterFailed SSL handshakesserver_zone
nginxplus_server_ssl_session_reusesCounterSession reuses during SSL handshakeserver_zone
\n

Stream Server Zones

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescriptionLabels
nginxplus_stream_server_zone_processingGaugeClient connections that are currently being processedserver_zone
nginxplus_stream_server_zone_connectionsCounterTotal connectionsserver_zone
nginxplus_stream_server_zone_sessionsCounterTotal sessions completedcode (the response status code. The values are: 2xx, 4xx, and 5xx), server_zone
nginxplus_stream_server_zone_discardedCounterConnections completed without creating a sessionserver_zone
nginxplus_stream_server_zone_receivedCounterBytes received from clientsserver_zone
nginxplus_stream_server_zone_sentCounterBytes sent to clientsserver_zone
nginxplus_stream_server_ssl_handshakesCounterSuccessful SSL handshakesserver_zone
nginxplus_stream_server_ssl_handshakes_failedCounterFailed SSL handshakesserver_zone
nginxplus_stream_server_ssl_session_reusesCounterSession reuses during SSL handshakeserver_zone
\n

HTTP Upstreams

\n
\n

Note: for the state metric, the string values are converted to float64 using the following rule: \"up\" -> 1.0,
\n\"draining\" -> 2.0, \"down\" -> 3.0, \"unavail\" –> 4.0, \"checking\" –> 5.0, \"unhealthy\" -> 6.0.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescriptionLabels
nginxplus_upstream_server_stateGaugeCurrent stateserver, upstream
nginxplus_upstream_server_activeGaugeActive connectionsserver, upstream
nginxplus_upstream_server_limitGaugeLimit for connections which corresponds to the max_conns parameter of the upstream server. Zero value means there is no limitserver, upstream
nginxplus_upstream_server_requestsCounterTotal client requestsserver, upstream
nginxplus_upstream_server_responsesCounterTotal responses sent to clientscode (the response status code. The values are: 1xx, 2xx, 3xx, 4xx and 5xx), server, upstream
nginxplus_upstream_server_responses_codesCounterTotal responses sent to clients by codecode (the response status code. The possible values are here), server, upstream
nginxplus_upstream_server_sent`CounterBytes sent to this serverserver, upstream
nginxplus_upstream_server_receivedCounterBytes received to this serverserver, upstream
nginxplus_upstream_server_failsCounterNumber of unsuccessful attempts to communicate with the serverserver, upstream
nginxplus_upstream_server_unavailCounterHow many times the server became unavailable for client requests (state 'unavail') due to the number of unsuccessful attempts reaching the max_fails thresholdserver, upstream
nginxplus_upstream_server_header_timeGaugeAverage time to get the response header from the serverserver, upstream
nginxplus_upstream_server_response_timeGaugeAverage time to get the full response from the serverserver, upstream
nginxplus_upstream_server_health_checks_checksCounterTotal health check requestsserver, upstream
nginxplus_upstream_server_health_checks_failsCounterFailed health checksserver, upstream
nginxplus_upstream_server_health_checks_unhealthyCounterHow many times the server became unhealthy (state 'unhealthy')server, upstream
nginxplus_upstream_server_ssl_handshakesCounterSuccessful SSL handshakesserver, upstream
nginxplus_upstream_server_ssl_handshakes_failedCounterFailed SSL handshakesserver, upstream
nginxplus_upstream_server_ssl_session_reusesCounterSession reuses during SSL handshakeserver, upstream
nginxplus_upstream_keepaliveGaugeIdle keepalive connectionsupstream
nginxplus_upstream_zombiesGaugeServers removed from the group but still processing active client requestsupstream
\n

Stream Upstreams

\n
\n

Note: for the state metric, the string values are converted to float64 using the following rule: \"up\" -> 1.0,
\n\"down\" -> 3.0, \"unavail\" –> 4.0, \"checking\" –> 5.0, \"unhealthy\" -> 6.0.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescriptionLabels
nginxplus_stream_upstream_server_stateGaugeCurrent stateserver, upstream
nginxplus_stream_upstream_server_activeGaugeActive connectionsserver , upstream
nginxplus_stream_upstream_server_limitGaugeLimit for connections which corresponds to the max_conns parameter of the upstream server. Zero value means there is no limitserver , upstream
nginxplus_stream_upstream_server_connectionsCounterTotal number of client connections forwarded to this serverserver, upstream
nginxplus_stream_upstream_server_connect_timeGaugeAverage time to connect to the upstream serverserver, upstream
nginxplus_stream_upstream_server_first_byte_timeGaugeAverage time to receive the first byte of dataserver, upstream
nginxplus_stream_upstream_server_response_timeGaugeAverage time to receive the last byte of dataserver, upstream
nginxplus_stream_upstream_server_sentCounterBytes sent to this serverserver, upstream
nginxplus_stream_upstream_server_receivedCounterBytes received from this serverserver, upstream
nginxplus_stream_upstream_server_failsCounterNumber of unsuccessful attempts to communicate with the serverserver, upstream
nginxplus_stream_upstream_server_unavailCounterHow many times the server became unavailable for client connections (state 'unavail') due to the number of unsuccessful attempts reaching the max_fails thresholdserver, upstream
nginxplus_stream_upstream_server_health_checks_checksCounterTotal health check requestsserver, upstream
nginxplus_stream_upstream_server_health_checks_failsCounterFailed health checksserver, upstream
nginxplus_stream_upstream_server_health_checks_unhealthyCounterHow many times the server became unhealthy (state 'unhealthy')server, upstream
nginxplus_stream_upstream_server_ssl_handshakesCounterSuccessful SSL handshakesserver, upstream
nginxplus_stream_upstream_server_ssl_handshakes_failedCounterFailed SSL handshakesserver, upstream
nginxplus_stream_upstream_server_ssl_session_reusesCounterSession reuses during SSL handshakeserver, upstream
nginxplus_stream_upstream_zombiesGaugeServers removed from the group but still processing active client connectionsupstream
\n

Stream Zone Sync

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescriptionLabels
nginxplus_stream_zone_sync_zone_records_pendingGaugeThe number of records that need to be sent to the clusterzone
nginxplus_stream_zone_sync_zone_records_totalGaugeThe total number of records stored in the shared memory zonezone
nginxplus_stream_zone_sync_zone_bytes_inCounterBytes received by this node[]
nginxplus_stream_zone_sync_zone_bytes_outCounterBytes sent by this node[]
nginxplus_stream_zone_sync_zone_msgs_inCounterTotal messages received by this node[]
nginxplus_stream_zone_sync_zone_msgs_outCounterTotal messages sent by this node[]
nginxplus_stream_zone_sync_zone_nodes_onlineGaugeNumber of peers this node is connected to[]
\n

Location Zones

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescriptionLabels
nginxplus_location_zone_requestsCounterTotal client requestslocation_zone
nginxplus_location_zone_responsesCounterTotal responses sent to clientscode (the response status code. The values are: 1xx, 2xx, 3xx, 4xx and 5xx), location_zone
nginxplus_location_zone_responses_codesCounterTotal responses sent to clients by codecode (the response status code. The possible values are here), location_zone
nginxplus_location_zone_discardedCounterRequests completed without sending a responselocation_zone
nginxplus_location_zone_receivedCounterBytes received from clientslocation_zone
nginxplus_location_zone_sentCounterBytes sent to clientslocation_zone
\n

Resolver

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescriptionLabels
nginxplus_resolver_nameCounterTotal requests to resolve names to addressesresolver
nginxplus_resolver_srvCounterTotal requests to resolve SRV recordsresolver
nginxplus_resolver_addrCounterTotal requests to resolve addresses to namesresolver
nginxplus_resolver_noerrorCounterTotal number of successful responsesresolver
nginxplus_resolver_formerrCounterTotal number of FORMERR responsesresolver
nginxplus_resolver_servfailCounterTotal number of SERVFAIL responsesresolver
nginxplus_resolver_nxdomainCounterTotal number of NXDOMAIN responsesresolver
nginxplus_resolver_notimpCounterTotal number of NOTIMP responsesresolver
nginxplus_resolver_refusedCounterTotal number of REFUSED responsesresolver
nginxplus_resolver_timedoutCounterTotal number of timed out requestresolver
nginxplus_resolver_unknownCounterTotal requests completed with an unknown errorresolver
\n

HTTP Requests Rate Limiting

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescriptionLabels
nginxplus_limit_request_passedCounterTotal number of requests that were neither limited nor accounted as limitedzone
nginxplus_limit_request_rejectedCounterTotal number of requests that were rejectedzone
nginxplus_limit_request_delayedCounterTotal number of requests that were delayedzone
nginxplus_limit_request_rejected_dry_runCounterTotal number of requests accounted as rejected in the dry run modezone
nginxplus_limit_request_delayed_dry_runCounterTotal number of requests accounted as delayed in the dry run modezone
\n

HTTP Connections Limiting

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescriptionLabels
nginxplus_limit_connection_passedCounterTotal number of connections that were neither limited nor accounted as limitedzone
nginxplus_limit_connection_rejectedCounterTotal number of connections that were rejectedzone
nginxplus_limit_connection_rejected_dry_runCounterTotal number of connections accounted as rejected in the dry run modezone
\n

Stream Connections Limiting

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescriptionLabels
nginxplus_stream_limit_connection_passedCounterTotal number of connections that were neither limited nor accounted as limitedzone
nginxplus_stream_limit_connection_rejectedCounterTotal number of connections that were rejectedzone
nginxplus_stream_limit_connection_rejected_dry_runCounterTotal number of connections accounted as rejected in the dry run modezone
\n

Cache

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescriptionLabels
nginxplus_cache_sizeGaugeTotal size of the cachecache
nginxplus_cache_max_sizeGaugeMaximum size of the cachecache
nginxplus_cache_coldGaugeIs the cache considered coldcache
nginxplus_cache_hit_responsesCounterTotal number of cache hitscache
nginxplus_cache_hit_bytesCounterTotal number of bytes returned from cache hitscache
nginxplus_cache_stale_responsesCounterTotal number of stale cache hitscache
nginxplus_cache_stale_bytesCounterTotal number of bytes returned from stale cache hitscache
nginxplus_cache_updating_responsesCounterTotal number of cache hits while cache is updatingcache
nginxplus_cache_updating_bytesCounterTotal number of bytes returned from cache while cache is updatingcache
nginxplus_cache_revalidated_responsesCounterTotal number of cache revalidationscache
nginxplus_cache_revalidated_bytesCounterTotal number of bytes returned from cache revalidationscache
nginxplus_cache_miss_responsesCounterTotal number of cache missescache
nginxplus_cache_miss_bytesCounterTotal number of bytes returned from cache missescache
nginxplus_cache_expired_responsesCounterTotal number of cache hits with expired TTLcache
nginxplus_cache_expired_bytesCounterTotal number of bytes returned from cache hits with expired TTLcache
nginxplus_cache_expired_responses_writtenCounterTotal number of cache hits with expired TTL written to cachecache
nginxplus_cache_expired_bytes_writtenCounterTotal number of bytes written to cache from cache hits with expired TTLcache
nginxplus_cache_bypass_responsesCounterTotal number of cache bypassescache
nginxplus_cache_bypass_bytesCounterTotal number of bytes returned from cache bypassescache
nginxplus_cache_bypass_responses_writtenCounterTotal number of cache bypasses written to cachecache
nginxplus_cache_bypass_bytes_writtenCounterTotal number of bytes written to cache from cache bypassescache
\n

Worker

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescriptionLabels
nginxplus_worker_connection_acceptedCounterThe total number of accepted client connectionsid, pid
nginxplus_worker_connection_droppedCounterThe total number of dropped client connectionsid, pid
nginxplus_worker_connection_activeGaugeThe current number of active client connectionsid, pid
nginxplus_worker_connection_idleGaugeThe current number of idle client connectionid, pid
nginxplus_worker_http_requests_totalCounterThe total number of client requests receivedid, pid
nginxplus_worker_http_requests_currentGaugeThe current number of client requests that are currently being processedid, pid
\n

Connect to the /metrics page of the running exporter to see the complete list of metrics along with their
\ndescriptions. Note: to see server zones related metrics you must configure status
\nzones and to see upstream related metrics you
\nmust configure upstreams with a shared memory zone.

\n

Troubleshooting

\n

The exporter logs errors to the standard output. When using Docker, if the exporter doesn’t work as expected, check its
\nlogs using docker logs command.

\n

Releases

\n

Docker images

\n

We publish the Docker image on DockerHub,
\nGitHub Container,
\nAmazon ECR Public Gallery and
\nQuay.io.

\n

As an alternative, you can choose the edge version built from the latest commit
\nfrom the main branch. The edge version is useful for experimenting with new features that are not yet published in a
\nstable release.

\n

Binaries

\n

We publish the binaries for multiple Operating Systems and architectures on the GitHub releases page.

\n

Homebrew

\n

You can add the NGINX homebrew tap with

\n
brew tap nginx/tap
\n

and then install the formula with

\n
brew install nginx-prometheus-exporter
\n

Snap

\n

You can install the NGINX Prometheus Exporter from the Snap Store.

\n
snap install nginx-prometheus-exporter
\n

Scoop

\n

You can add the NGINX Scoop bucket with

\n
scoop bucket add nginx https://github.com/nginx/scoop-bucket.git
\n

and then install the package with

\n
scoop install nginx-prometheus-exporter
\n

Nix

\n

First include NUR in your packageOverrides as explained in the NUR documentation.

\n

Then you can use the exporter with the following command:

\n
nix-shell --packages nur.repos.nginx.nginx-prometheus-exporter
\n

or install it with:

\n
nix-env -f '<nixpkgs>' -iA nur.repos.nginx.nginx-prometheus-exporter
\n

Building the Exporter

\n

You can build the exporter using the provided Makefile. Before building the exporter, make sure the following software
\nis installed on your machine:

\n\n

Building the Docker Image

\n

To build the Docker image with the exporter, run:

\n
make container
\n

Note: go is not required, as the exporter binary is built in a Docker container. See the Dockerfile.

\n

Building the Binary

\n

To build the binary, run:

\n
make
\n

Note: the binary is built for the OS/arch of your machine. To build binaries for other platforms, see the
\nMakefile.

\n

The binary is built with the name nginx-prometheus-exporter.

\n

Grafana Dashboard

\n

The official Grafana dashboard is provided with the exporter for NGINX. Check the Grafana
\nDashboard documentation for more information.

\n

SBOM (Software Bill of Materials)

\n

We generate SBOMs for the binaries and the Docker image.

\n

Binaries

\n

The SBOMs for the binaries are available in the releases page. The SBOMs are generated using
\nsyft and are available in SPDX format.

\n

Docker Image

\n

The SBOM for the Docker image is available in the
\nDockerHub,
\nGitHub Container registry,
\nAmazon ECR Public Gallery and
\nQuay.io repositories. The SBOMs are generated using
\nsyft and stored as an attestation in the image manifest.

\n

For example to retrieve the SBOM for linux/amd64 from Docker Hub and analyze it using
\ngrype you can run the following command:

\n
docker buildx imagetools inspect nginx/nginx-prometheus-exporter:edge --format '{{ json (index .SBOM \"linux/amd64\").SPDX }}' | grype
\n

Provenance

\n

We generate provenance for the Docker image and it's available in the
\nDockerHub,
\nGitHub Container registry,
\nAmazon ECR Public Gallery and
\nQuay.io repositories, stored as an attestation in the
\nimage manifest.

\n

For example to retrieve the provenance for linux/amd64 from Docker Hub you can run the following command:

\n
docker buildx imagetools inspect nginx/nginx-prometheus-exporter:edge --format '{{ json (index .Provenance \"linux/amd64\").SLSA }}'
\n

Contacts

\n

We’d like to hear your feedback! If you have any suggestions or experience issues with the NGINX Prometheus Exporter,
\nplease create an issue or send a pull request on GitHub. You can contact us on the NGINX Community Forums.

\n

Contributing

\n

If you'd like to contribute to the project, please read our Contributing guide.

\n

Support

\n

The commercial support is available for NGINX Plus customers when the NGINX Prometheus Exporter is used with NGINX
\nIngress Controller.

\n

License

\n

Apache License, Version 2.0.

","updatedAt":"2025-05-21T16:13:11Z","upvoteCount":null,"author":{"login":"eryajf","avatarUrl":"https://avatars.githubusercontent.com/u/33259379?u=e4a4090a38ac2473aaed4ef9945233636776c6c3&v=4","url":"https://github.com/eryajf"},"category":null,"labels":{"edges":[{"node":{"name":"更多","color":"25B472"}},{"node":{"name":"Prometheus-Exporter","color":"367acb"}},{"node":{"name":"nginxinc","color":"0234ae"}}]},"comments":{"edges":[]}}},"pageContext":{"number":396,"previous":{"title":"goreleaser/nfpm: 一个用 Go 编写的简单且 0 依赖项的 deb、rpm、apk 和 arch Linux 打包器","number":395},"next":{"title":"NginxProxyManager/nginx-proxy-manager: 该项目是一个预构建的Docker镜像，可以让您轻松地将您在家中或其他地方运行的网站转发出去，包括免费SSL，而无需对Nginx或Letsencrypt有太多了解。","number":397}}}, "staticQueryHashes": ["151096407","2861350382"]}