OS Manuals

/usr/bin/nginx-prometheus-exporter

NGINX Prometheus Exporter for NGINX and NGINX Plus

From nginx-prometheus-exporter-fips 1.5.3-r6 (enterprise-packages), captured 2026-11-08 by running nginx-prometheus-exporter --help (exit 0). permalink

usage: nginx-prometheus-exporter [<flags>]


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. Examples: `:9100` or `[::1]:9100` for http,
                                 `vsock://:9100` for vsock ($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.
Options (12)
OptionDescriptionSource
-hShow context-sensitive help (also try --help-long and --help-man).help
--web.listen-address :9113Addresses on which to expose metrics and web interface.help
--web.config.file ""Path to configuration file that can enable TLS or authentication.help
--web.telemetry-path "/metrics"Path under which to expose metrics.help
--nginx.scrape-uri http://127.0.0.1:8080/stub_statusA URI or unix domain socket path for scraping NGINX or NGINX Plus metrics.help
--nginx.ssl-ca-cert ""Path to the PEM encoded CA certificate file used to validate the servers SSL certificate.help
--nginx.ssl-client-cert ""Path to the PEM encoded client certificate file to use when connecting to the server.help
--nginx.ssl-client-key ""Path to the PEM encoded client certificate key file to use when connecting to the server.help
--nginx.timeout 5sA timeout for scraping metrics from NGINX or NGINX Plus.help
--prometheus.const-label PROMETHEUS.CONST-LABELLabel that will be used in every metric.help
--log.level infoOnly log messages with the given severity or above.help
--log.format logfmtOutput format of log messages.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.