1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
|
.TH PROMETHEUS\-NGINX\-EXPORTER 1 "October 2018" "0.1.0" Prometheus
.SH NAME
prometheus\-nginx\-exporter \- NGINX Prometheus exporter.
.SH SYNOPSIS
.B prometheus-nginx-exporter
.RI [ option ...]
.SH DESCRIPTION
NGINX Prometheus exporter makes it possible to monitor NGINX or NGINX Plus
using Prometheus.
.PP
\f[B]NGINX\f[] exposes a handful of metrics via the \f[I]stub_status\f[] page.
NGINX Plus provides a richer set of metrics via the API and the monitoring
dashboard. \f[B]NGINX Prometheus exporter\f[] fetches the metrics from a single
NGINX or NGINX Plus, converts the metrics into appropriate \f[B]Prometheus\f[]
metrics types and finally exposes them via an HTTP server to be collected by
Prometheus.
.SH OPTIONS
.TP
\f[B]\-nginx.plus\f[]
Start the exporter for NGINX Plus. By default, the exporter is started for
NGINX.
.TP
\f[B]\-nginx.scrape\-uri\f[] \f[I]string\f[]
A URI for scraping NGINX or NGINX Plus metrics. For NGINX, the stub_status
page must be available through the URI. For NGINX Plus -- the API. (default
"http://127.0.0.1:8080/stub_status")
.TP
\f[B]\-web.listen\-address\f[] \f[I]string\f[]
An address to listen on for web interface and telemetry. (default ":9113")
.TP
\f[B]\-web.telemetry\-path\f[] \f[I]string\f[]
The path under which to expose metrics. (default "/metrics")
.SH SEE ALSO
\f[B]nginx\f[](8), \f[B]prometheus\f[](1)
.SH AUTHOR
NGINX, Inc.
|
