Reference

prometheus-nginx-exporter(1)

Prometheus exporter for NGINX web server metrics

NAME

prometheus-nginx-exporter - Prometheus exporter for NGINX web server metrics

SYNOPSIS

prometheus-nginx-exporter [<flags>]

DESCRIPTION

OPTIONS

-h, --help

Show context-sensitive help (also try --help-long and --help-man).

--web.systemd-socket

Use systemd socket activation listeners instead of port listeners (Linux only).

--web.listen-address=:9113

Addresses on which to expose metrics and web interface. Repeatable for multiple addresses. Examples: `:9100` or `[::1]:9100` for http, `vsock://:9100` for vsock

--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

--web.telemetry-path="/metrics"

Path under which to expose metrics.

--nginx.plus

Start the exporter for NGINX Plus. By default, the exporter is started for NGINX.

--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.

--nginx.ssl-verify

Perform SSL certificate verification.

--nginx.ssl-ca-cert=""

Path to the PEM encoded CA certificate file used to validate the servers SSL certificate.

--nginx.ssl-client-cert=""

Path to the PEM encoded client certificate file to use when connecting to the server.

--nginx.ssl-client-key=""

Path to the PEM encoded client certificate key file to use when connecting to the server.

--nginx.timeout=5s

A timeout for scraping metrics from NGINX or NGINX Plus.

--prometheus.const-label=PROMETHEUS.CONST-LABEL

Label that will be used in every metric. Format is label=value. It can be repeated multiple times.

--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]

--version

Show application version.

History

--help since Debian 13 (Trixie); --log.format since Debian 13 (Trixie); --log.level since Debian 13 (Trixie); --nginx.plus since Debian 13 (Trixie); --nginx.scrape-uri since Debian 13 (Trixie); --nginx.ssl-ca-cert since Debian 13 (Trixie); --nginx.ssl-client-cert since Debian 13 (Trixie); --nginx.ssl-client-key since Debian 13 (Trixie); --nginx.ssl-verify since Debian 13 (Trixie); --nginx.timeout since Debian 13 (Trixie); --prometheus.const-label since Debian 13 (Trixie); --version since Debian 13 (Trixie); --web.config.file since Debian 13 (Trixie); --web.listen-address since Debian 13 (Trixie); --web.systemd-socket since Debian 13 (Trixie); --web.telemetry-path since Debian 13 (Trixie); -h since Debian 13 (Trixie).

-nginx.plus until Debian 12 (Bookworm); -nginx.retries until Debian 12 (Bookworm); -nginx.retry-interval until Debian 12 (Bookworm); -nginx.scrape-uri until Debian 12 (Bookworm); -nginx.ssl-ca-cert until Debian 12 (Bookworm); -nginx.ssl-client-cert until Debian 12 (Bookworm); -nginx.ssl-client-key until Debian 12 (Bookworm); -nginx.ssl-verify until Debian 12 (Bookworm); -nginx.timeout until Debian 12 (Bookworm); -prometheus.const-labels until Debian 12 (Bookworm); -web.listen-address until Debian 12 (Bookworm); -web.secured-metrics until Debian 12 (Bookworm); -web.ssl-server-cert until Debian 12 (Bookworm); -web.telemetry-path until Debian 11 (Bullseye).