Install nginx-prometheus-exporter using Winget - wingetCollections

nginx-prometheus-exporter nginx

Use this command to install nginx-prometheus-exporter:

winget install --id=nginx.nginx-prometheus-exporter -e

NGINX Prometheus Exporter for NGINX and NGINX Plus

NGINX Prometheus Exporter is a monitoring tool designed to collect and expose metrics from NGINX and NGINX Plus servers for Prometheus. It converts these metrics into appropriate types and makes them available via an HTTP server, enabling effective monitoring and analysis.

Key Features:

Support for NGINX and NGINX Plus: Works seamlessly with both NGINX OSS and NGINX Plus.
Metric Conversion: Converts NGINX/NGINX Plus metrics into Prometheus-compatible formats.
HTTP Exposure: Exposes metrics via an HTTP server to facilitate easy scraping by Prometheus.
Command-Line Configuration: Adjustable settings through command-line arguments for flexibility.
Unix Domain Sockets: Supports scraping metrics using Unix domain sockets for enhanced security.

Audience & Benefit: Ideal for DevOps engineers, system administrators, and anyone responsible for monitoring NGINX-based infrastructure. This tool provides actionable insights to troubleshoot issues, optimize performance, and ensure high availability of web services.

Install via winget for straightforward setup and integration into your existing Prometheus ecosystem.

README

NGINX Prometheus Exporter

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

Versions

1.4.1

1.3.0

1.2.0

1.1.0

Website

github.com

License

Last Updated

5/15/2025

To export NGINX metrics, run:

docker run -p 9113:9113 nginx/nginx-prometheus-exporter:1.5.0 --nginx.scrape-uri=http://:8080/stub_status

where `` is the IP address/DNS name, through which NGINX is available.

To export NGINX Plus metrics, run:

docker run -p 9113:9113 nginx/nginx-prometheus-exporter:1.5.0 --nginx.plus --nginx.scrape-uri=http://:8080/api

where `` is the IP address/DNS name, through which NGINX Plus is available.

To export NGINX metrics, run:
```
nginx-prometheus-exporter --nginx.scrape-uri=http://:8080/stub_status
```
where `` is the IP address/DNS name, through which NGINX is available.
To export NGINX Plus metrics:
```
nginx-prometheus-exporter --nginx.plus --nginx.scrape-uri=http://:8080/api
```
where `` is the IP address/DNS name, through which NGINX Plus is available.
To scrape NGINX metrics with unix domain sockets, run:
```
nginx-prometheus-exporter --nginx.scrape-uri=unix::/stub_status
```
where `` is the path to unix domain socket, through which NGINX stub status is available.

usage: nginx-prometheus-exporter []


Flags:
  -h, --[no-]help                Show context-sensitive help (also try --help-long and --help-man).
      --[no-]web.systemd-socket  Use systemd socket activation listeners instead
                                 of port listeners (Linux only). ($SYSTEMD_SOCKET)
      --web.listen-address=:9113 ...
                                 Addresses on which to expose metrics and web interface. Repeatable for multiple addresses. ($LISTEN_ADDRESS)
      --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)
      --web.telemetry-path="/metrics"
                                 Path under which to expose metrics. ($TELEMETRY_PATH)
      --[no-]nginx.plus          Start the exporter for NGINX Plus. By default, the exporter is started for NGINX. ($NGINX_PLUS)
      --nginx.scrape-uri=http://127.0.0.1:8080/stub_status ...
                                 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)
      --[no-]nginx.ssl-verify    Perform SSL certificate verification. ($SSL_VERIFY)
      --nginx.ssl-ca-cert=""     Path to the PEM encoded CA certificate file used to validate the servers SSL certificate. ($SSL_CA_CERT)
      --nginx.ssl-client-cert=""
                                 Path to the PEM encoded client certificate file to use when connecting to the server. ($SSL_CLIENT_CERT)
      --nginx.ssl-client-key=""  Path to the PEM encoded client certificate key file to use when connecting to the server. ($SSL_CLIENT_KEY)
      --[no-]nginx.proxy-protocol
                                 Pass proxy protocol payload to nginx listeners. ($PROXY_PROTOCOL)
      --nginx.timeout=5s         A timeout for scraping metrics from NGINX or NGINX Plus. ($TIMEOUT)
      --prometheus.const-label=PROMETHEUS.CONST-LABEL ...
                                 Label that will be used in every metric. Format is label=value. It can be repeated multiple times. ($CONST_LABELS)
      --log.level=info           Only log messages with the given severity or above. One of: [debug, info, warn, error]
      --log.format=logfmt        Output format of log messages. One of: [logfmt, json]
      --[no-]version             Show application version.

Name	Type	Description	Labels
`nginx_exporter_build_info`	Gauge	Shows the exporter build information.	`branch`, `goarch`, `goos`, `goversion`, `revision`, `tags` and `version`
`promhttp_metric_handler_requests_total`	Counter	Total number of scrapes by HTTP status code.	`code` (the HTTP status code)
`promhttp_metric_handler_requests_in_flight`	Gauge	Current number of scrapes being served.	[]
`go_*`	Multiple	Go runtime metrics.	[]

Name	Type	Description	Labels
`nginx_connections_accepted`	Counter	Accepted client connections.	[]
`nginx_connections_active`	Gauge	Active client connections.	[]
`nginx_connections_handled`	Counter	Handled client connections.	[]
`nginx_connections_reading`	Gauge	Connections where NGINX is reading the request header.	[]
`nginx_connections_waiting`	Gauge	Idle client connections.	[]
`nginx_connections_writing`	Gauge	Connections where NGINX is writing the response back to the client.	[]
`nginx_http_requests_total`	Counter	Total http requests.	[]

Name	Type	Description	Labels
`nginxplus_connections_accepted`	Counter	Accepted client connections	[]
`nginxplus_connections_active`	Gauge	Active client connections	[]
`nginxplus_connections_dropped`	Counter	Dropped client connections dropped	[]
`nginxplus_connections_idle`	Gauge	Idle client connections	[]

Name	Type	Description	Labels
`nginxplus_ssl_handshakes`	Counter	Successful SSL handshakes	[]
`nginxplus_ssl_handshakes_failed`	Counter	Failed SSL handshakes	[]
`nginxplus_ssl_session_reuses`	Counter	Session reuses during SSL handshake	[]

Name	Type	Description	Labels
`nginxplus_server_zone_processing`	Gauge	Client requests that are currently being processed	`server_zone`
`nginxplus_server_zone_requests`	Counter	Total client requests	`server_zone`
`nginxplus_server_zone_responses`	Counter	Total responses sent to clients	`code` (the response status code. The values are: `1xx`, `2xx`, `3xx`, `4xx` and `5xx`), `server_zone`
`nginxplus_server_zone_responses_codes`	Counter	Total responses sent to clients by code	`code` (the response status code. The possible values are available on the NGINX Wiki), `server_zone`
`nginxplus_server_zone_discarded`	Counter	Requests completed without sending a response	`server_zone`
`nginxplus_server_zone_received`	Counter	Bytes received from clients	`server_zone`
`nginxplus_server_zone_sent`	Counter	Bytes sent to clients	`server_zone`
`nginxplus_server_ssl_handshakes`	Counter	Successful SSL handshakes	`server_zone`
`nginxplus_server_ssl_handshakes_failed`	Counter	Failed SSL handshakes	`server_zone`
`nginxplus_server_ssl_session_reuses`	Counter	Session reuses during SSL handshake	`server_zone`

Name	Type	Description	Labels
`nginxplus_stream_server_zone_processing`	Gauge	Client connections that are currently being processed	`server_zone`
`nginxplus_stream_server_zone_connections`	Counter	Total connections	`server_zone`
`nginxplus_stream_server_zone_sessions`	Counter	Total sessions completed	`code` (the response status code. The values are: `2xx`, `4xx`, and `5xx`), `server_zone`
`nginxplus_stream_server_zone_discarded`	Counter	Connections completed without creating a session	`server_zone`
`nginxplus_stream_server_zone_received`	Counter	Bytes received from clients	`server_zone`
`nginxplus_stream_server_zone_sent`	Counter	Bytes sent to clients	`server_zone`
`nginxplus_stream_server_ssl_handshakes`	Counter	Successful SSL handshakes	`server_zone`
`nginxplus_stream_server_ssl_handshakes_failed`	Counter	Failed SSL handshakes	`server_zone`
`nginxplus_stream_server_ssl_session_reuses`	Counter	Session reuses during SSL handshake	`server_zone`

Name	Type	Description	Labels
`nginxplus_upstream_server_state`	Gauge	Current state	`server`, `upstream`
`nginxplus_upstream_server_active`	Gauge	Active connections	`server`, `upstream`
`nginxplus_upstream_server_limit`	Gauge	Limit for connections which corresponds to the max_conns parameter of the upstream server. Zero value means there is no limit	`server`, `upstream`
`nginxplus_upstream_server_requests`	Counter	Total client requests	`server`, `upstream`
`nginxplus_upstream_server_responses`	Counter	Total responses sent to clients	`code` (the response status code. The values are: `1xx`, `2xx`, `3xx`, `4xx` and `5xx`), `server`, `upstream`
`nginxplus_upstream_server_responses_codes`	Counter	Total responses sent to clients by code	`code` (the response status code. The possible values are available on the NGINX Wiki), `server`, `upstream`
`nginxplus_upstream_server_sent`	Counter	Bytes sent to this server	`server`, `upstream`
`nginxplus_upstream_server_received`	Counter	Bytes received to this server	`server`, `upstream`
`nginxplus_upstream_server_fails`	Counter	Number of unsuccessful attempts to communicate with the server	`server`, `upstream`
`nginxplus_upstream_server_unavail`	Counter	How many times the server became unavailable for client requests (state 'unavail') due to the number of unsuccessful attempts reaching the max_fails threshold	`server`, `upstream`
`nginxplus_upstream_server_header_time`	Gauge	Average time to get the response header from the server	`server`, `upstream`
`nginxplus_upstream_server_response_time`	Gauge	Average time to get the full response from the server	`server`, `upstream`
`nginxplus_upstream_server_health_checks_checks`	Counter	Total health check requests	`server`, `upstream`
`nginxplus_upstream_server_health_checks_fails`	Counter	Failed health checks	`server`, `upstream`
`nginxplus_upstream_server_health_checks_unhealthy`	Counter	How many times the server became unhealthy (state 'unhealthy')	`server`, `upstream`
`nginxplus_upstream_server_ssl_handshakes`	Counter	Successful SSL handshakes	`server`, `upstream`
`nginxplus_upstream_server_ssl_handshakes_failed`	Counter	Failed SSL handshakes	`server`, `upstream`
`nginxplus_upstream_server_ssl_session_reuses`	Counter	Session reuses during SSL handshake	`server`, `upstream`
`nginxplus_upstream_keepalive`	Gauge	Idle keepalive connections	`upstream`
`nginxplus_upstream_zombies`	Gauge	Servers removed from the group but still processing active client requests	`upstream`

Name	Type	Description	Labels
`nginxplus_stream_upstream_server_state`	Gauge	Current state	`server`, `upstream`
`nginxplus_stream_upstream_server_active`	Gauge	Active connections	`server` , `upstream`
`nginxplus_stream_upstream_server_limit`	Gauge	Limit for connections which corresponds to the max_conns parameter of the upstream server. Zero value means there is no limit	`server` , `upstream`
`nginxplus_stream_upstream_server_connections`	Counter	Total number of client connections forwarded to this server	`server`, `upstream`
`nginxplus_stream_upstream_server_connect_time`	Gauge	Average time to connect to the upstream server	`server`, `upstream`
`nginxplus_stream_upstream_server_first_byte_time`	Gauge	Average time to receive the first byte of data	`server`, `upstream`
`nginxplus_stream_upstream_server_response_time`	Gauge	Average time to receive the last byte of data	`server`, `upstream`
`nginxplus_stream_upstream_server_sent`	Counter	Bytes sent to this server	`server`, `upstream`
`nginxplus_stream_upstream_server_received`	Counter	Bytes received from this server	`server`, `upstream`
`nginxplus_stream_upstream_server_fails`	Counter	Number of unsuccessful attempts to communicate with the server	`server`, `upstream`
`nginxplus_stream_upstream_server_unavail`	Counter	How many times the server became unavailable for client connections (state 'unavail') due to the number of unsuccessful attempts reaching the max_fails threshold	`server`, `upstream`
`nginxplus_stream_upstream_server_health_checks_checks`	Counter	Total health check requests	`server`, `upstream`
`nginxplus_stream_upstream_server_health_checks_fails`	Counter	Failed health checks	`server`, `upstream`
`nginxplus_stream_upstream_server_health_checks_unhealthy`	Counter	How many times the server became unhealthy (state 'unhealthy')	`server`, `upstream`
`nginxplus_stream_upstream_server_ssl_handshakes`	Counter	Successful SSL handshakes	`server`, `upstream`
`nginxplus_stream_upstream_server_ssl_handshakes_failed`	Counter	Failed SSL handshakes	`server`, `upstream`
`nginxplus_stream_upstream_server_ssl_session_reuses`	Counter	Session reuses during SSL handshake	`server`, `upstream`
`nginxplus_stream_upstream_zombies`	Gauge	Servers removed from the group but still processing active client connections	`upstream`

Name	Type	Description	Labels
`nginxplus_stream_zone_sync_zone_records_pending`	Gauge	The number of records that need to be sent to the cluster	`zone`
`nginxplus_stream_zone_sync_zone_records_total`	Gauge	The total number of records stored in the shared memory zone	`zone`
`nginxplus_stream_zone_sync_zone_bytes_in`	Counter	Bytes received by this node	[]
`nginxplus_stream_zone_sync_zone_bytes_out`	Counter	Bytes sent by this node	[]
`nginxplus_stream_zone_sync_zone_msgs_in`	Counter	Total messages received by this node	[]
`nginxplus_stream_zone_sync_zone_msgs_out`	Counter	Total messages sent by this node	[]
`nginxplus_stream_zone_sync_zone_nodes_online`	Gauge	Number of peers this node is connected to	[]

Name	Type	Description	Labels
`nginxplus_location_zone_requests`	Counter	Total client requests	`location_zone`
`nginxplus_location_zone_responses`	Counter	Total responses sent to clients	`code` (the response status code. The values are: `1xx`, `2xx`, `3xx`, `4xx` and `5xx`), `location_zone`
`nginxplus_location_zone_responses_codes`	Counter	Total responses sent to clients by code	`code` (the response status code. The possible values are available on the NGINX Wiki), `location_zone`
`nginxplus_location_zone_discarded`	Counter	Requests completed without sending a response	`location_zone`
`nginxplus_location_zone_received`	Counter	Bytes received from clients	`location_zone`
`nginxplus_location_zone_sent`	Counter	Bytes sent to clients	`location_zone`

Name	Type	Description	Labels
`nginxplus_resolver_name`	Counter	Total requests to resolve names to addresses	`resolver`
`nginxplus_resolver_srv`	Counter	Total requests to resolve SRV records	`resolver`
`nginxplus_resolver_addr`	Counter	Total requests to resolve addresses to names	`resolver`
`nginxplus_resolver_noerror`	Counter	Total number of successful responses	`resolver`
`nginxplus_resolver_formerr`	Counter	Total number of FORMERR responses	`resolver`
`nginxplus_resolver_servfail`	Counter	Total number of SERVFAIL responses	`resolver`
`nginxplus_resolver_nxdomain`	Counter	Total number of NXDOMAIN responses	`resolver`
`nginxplus_resolver_notimp`	Counter	Total number of NOTIMP responses	`resolver`
`nginxplus_resolver_refused`	Counter	Total number of REFUSED responses	`resolver`
`nginxplus_resolver_timedout`	Counter	Total number of timed out request	`resolver`
`nginxplus_resolver_unknown`	Counter	Total requests completed with an unknown error	`resolver`

Name	Type	Description	Labels
`nginxplus_limit_request_passed`	Counter	Total number of requests that were neither limited nor accounted as limited	`zone`
`nginxplus_limit_request_rejected`	Counter	Total number of requests that were rejected	`zone`
`nginxplus_limit_request_delayed`	Counter	Total number of requests that were delayed	`zone`
`nginxplus_limit_request_rejected_dry_run`	Counter	Total number of requests accounted as rejected in the dry run mode	`zone`
`nginxplus_limit_request_delayed_dry_run`	Counter	Total number of requests accounted as delayed in the dry run mode	`zone`

Name	Type	Description	Labels
`nginxplus_limit_connection_passed`	Counter	Total number of connections that were neither limited nor accounted as limited	`zone`
`nginxplus_limit_connection_rejected`	Counter	Total number of connections that were rejected	`zone`
`nginxplus_limit_connection_rejected_dry_run`	Counter	Total number of connections accounted as rejected in the dry run mode	`zone`

Name	Type	Description	Labels
`nginxplus_stream_limit_connection_passed`	Counter	Total number of connections that were neither limited nor accounted as limited	`zone`
`nginxplus_stream_limit_connection_rejected`	Counter	Total number of connections that were rejected	`zone`
`nginxplus_stream_limit_connection_rejected_dry_run`	Counter	Total number of connections accounted as rejected in the dry run mode	`zone`

Name	Type	Description	Labels
`nginxplus_cache_size`	Gauge	Total size of the cache	`cache`
`nginxplus_cache_max_size`	Gauge	Maximum size of the cache	`cache`
`nginxplus_cache_cold`	Gauge	Is the cache considered cold	`cache`
`nginxplus_cache_hit_responses`	Counter	Total number of cache hits	`cache`
`nginxplus_cache_hit_bytes`	Counter	Total number of bytes returned from cache hits	`cache`
`nginxplus_cache_stale_responses`	Counter	Total number of stale cache hits	`cache`
`nginxplus_cache_stale_bytes`	Counter	Total number of bytes returned from stale cache hits	`cache`
`nginxplus_cache_updating_responses`	Counter	Total number of cache hits while cache is updating	`cache`
`nginxplus_cache_updating_bytes`	Counter	Total number of bytes returned from cache while cache is updating	`cache`
`nginxplus_cache_revalidated_responses`	Counter	Total number of cache revalidations	`cache`
`nginxplus_cache_revalidated_bytes`	Counter	Total number of bytes returned from cache revalidations	`cache`
`nginxplus_cache_miss_responses`	Counter	Total number of cache misses	`cache`
`nginxplus_cache_miss_bytes`	Counter	Total number of bytes returned from cache misses	`cache`
`nginxplus_cache_expired_responses`	Counter	Total number of cache hits with expired TTL	`cache`
`nginxplus_cache_expired_bytes`	Counter	Total number of bytes returned from cache hits with expired TTL	`cache`
`nginxplus_cache_expired_responses_written`	Counter	Total number of cache hits with expired TTL written to cache	`cache`
`nginxplus_cache_expired_bytes_written`	Counter	Total number of bytes written to cache from cache hits with expired TTL	`cache`
`nginxplus_cache_bypass_responses`	Counter	Total number of cache bypasses	`cache`
`nginxplus_cache_bypass_bytes`	Counter	Total number of bytes returned from cache bypasses	`cache`
`nginxplus_cache_bypass_responses_written`	Counter	Total number of cache bypasses written to cache	`cache`
`nginxplus_cache_bypass_bytes_written`	Counter	Total number of bytes written to cache from cache bypasses	`cache`

Name	Type	Description	Labels
`nginxplus_worker_connection_accepted`	Counter	The total number of accepted client connections	`id`, `pid`
`nginxplus_worker_connection_dropped`	Counter	The total number of dropped client connections	`id`, `pid`
`nginxplus_worker_connection_active`	Gauge	The current number of active client connections	`id`, `pid`
`nginxplus_worker_connection_idle`	Gauge	The current number of idle client connection	`id`, `pid`
`nginxplus_worker_http_requests_total`	Counter	The total number of client requests received	`id`, `pid`
`nginxplus_worker_http_requests_current`	Gauge	The current number of client requests that are currently being processed	`id`, `pid`

brew tap nginx/tap

brew install nginx-prometheus-exporter

snap install nginx-prometheus-exporter

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

scoop install nginx-prometheus-exporter

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

nix-env -f '' -iA nur.repos.nginx.nginx-prometheus-exporter

make container

make

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

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

Name	Type	Description	Labels
`nginxplus_http_requests_total`	Counter	Total http requests	[]
`nginxplus_http_requests_current`	Gauge	Current http requests	[]

nginx-prometheus-exporter nginx

README

NGINX Prometheus Exporter

Table of Contents

Overview

Getting Started

A Note about NGINX Ingress Controller

Prerequisites

Running the Exporter in a Docker Container

Running the Exporter Binary

Usage

Command-line Arguments

Exported Metrics

Common metrics

Metrics for NGINX OSS

Metrics for NGINX Plus

Troubleshooting

Releases

Docker images

Binaries

Homebrew

Snap

Scoop

Nix

Building the Exporter

Building the Docker Image

Building the Binary

Grafana Dashboard

SBOM (Software Bill of Materials)

Binaries

Docker Image

Provenance

Contacts

Contributing

Support

License