PROMETHEUS-NGINX-EXPORTER(1)

💖 PROMETHEUS-NGINX-EXPORTER 💖

okay bestie, gather round, because today we're talking about prometheus-nginx-exporter — it's a Prometheus exporter for NGINX web server metrics, and it's genuinely one of the most lowkey iconic little tools out there. no cap. 🦋

---

✨ NAME ✨

prometheus-nginx-exporter — a Prometheus exporter for NGINX web server metrics. she takes your nginx numbers and serves them up to Prometheus like it's nothing. main character energy fr fr. 👑

---

🌸 SYNOPSIS 🌸

prometheus-nginx-exporter [<flags>]

that's it. that's the whole vibe. just run her and pass some flags. 💅

---

🎀 DESCRIPTION 🎀

so um. the description section is literally empty in the original. nothing here. it's giving silence. 🙈 the flags below do all the talking, and honestly? they ate. ⭐

---

💅 OPTIONS 💅

• -h, --help — shows you the context-sensitive help, like a good friend who actually answers your texts. psst — you can also try --help-long and --help-man if you want the deluxe versions. 💖
• --web.systemd-socket — uses systemd socket activation listeners instead of port listeners. Linux only, bestie, don't try this on your mac. 🍓
• --web.listen-address=:9113 — the address(es) where metrics and the web interface get exposed. it's repeatable so you can stack multiple addresses, go off. examples: :9100 or [::1]:9100 for http, and vsock://:9100 for vsock. 🌈
• --web.config.file="" — path to a config file that can turn on TLS or authentication. the docs live at: https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md — go read them, i'll wait. 🫶
• --web.telemetry-path="/metrics" — the path under which metrics get exposed. classic. iconic. /metrics. ✨
• --nginx.plus — starts the exporter for NGINX Plus. by default the exporter starts for regular NGINX, so flip this if you're fancy. 💜
• --nginx.scrape-uri=http://127.0.0.1:8080/stub_status — a URI or a unix domain socket path for scraping NGINX or NGINX Plus metrics. for NGINX, the stub_status page has to be available through the URI. for NGINX Plus — it's the API. repeatable for multiple URIs, so go wild. 🌸
• --nginx.ssl-verify — performs SSL certificate verification. safety first, babes. 🔥
• --nginx.ssl-ca-cert="" — path to the PEM encoded CA certificate file used to validate the server's 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. keep this one secret ok. 🙈
• --nginx.proxy-protocol — passes the proxy protocol payload to nginx listeners. 📨
• --nginx.timeout=5s — a timeout for scraping metrics from NGINX or NGINX Plus. five seconds and then we move on, periodt. ⏰
• --prometheus.const-label=PROMETHEUS.CONST-LABEL — a label that gets used in every single metric. the format is label=value, and yes you can repeat it multiple times. obsessed. 💖
• --log.level=info — only logs 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]. pick your fighter. 🥊
• --version — shows the application version. slay. 👑

---

heads up bestie: those --web.* and --nginx.* flags are doing real work, so don't just copy-paste them into prod without reading what they do. the stub_status page and the NGINX Plus API are requirements, not suggestions. 💀

---

and that's the whole page, you're welcome. 💜

this was prometheus-nginx-exporter version 1.5.1, brought to you by December 2025. bye bestie, go scrape something pretty. 🧚✨