You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+1-11
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,6 @@
1
1
# Changelog
2
2
3
-
## 0.11.0
4
-
5
-
A list of changes can be found on Github at: [Release v0.11.0](https://github.com/nginxinc/nginx-prometheus-exporter/releases/tag/v0.11.0)
6
-
7
-
## 0.10.0
8
-
9
-
A list of changes can be found on Github at: [Release v0.10.0](https://github.com/nginxinc/nginx-prometheus-exporter/releases/tag/v0.10.0)
10
-
11
-
## 0.9.0
12
-
13
-
A list of changes can be found on Github at: [Release v0.9.0](https://github.com/nginxinc/nginx-prometheus-exporter/releases/tag/v0.9.0)
3
+
Starting with version 0.9.0 an automatically generated list of changes can be found on the [GitHub Releases page](https://github.com/nginxinc/nginx-prometheus-exporter/releases).
[](https://www.repostatus.org/#active)
14
15
15
16
# NGINX Prometheus Exporter
16
17
@@ -56,15 +57,15 @@ To start the exporter we use the [docker run](https://docs.docker.com/engine/ref
56
57
- To export NGINX metrics, run:
57
58
58
59
```console
59
-
docker run -p 9113:9113 nginx/nginx-prometheus-exporter:0.10.0 -nginx.scrape-uri=http://<nginx>:8080/stub_status
60
+
docker run -p 9113:9113 nginx/nginx-prometheus-exporter:1.0.0 --nginx.scrape-uri=http://<nginx>:8080/stub_status
60
61
```
61
62
62
63
where `<nginx>` is the IP address/DNS name, through which NGINX is available.
63
64
64
65
- To export NGINX Plus metrics, run:
65
66
66
67
```console
67
-
docker run -p 9113:9113 nginx/nginx-prometheus-exporter:0.10.0 -nginx.plus -nginx.scrape-uri=http://<nginx-plus>:8080/api
68
+
docker run -p 9113:9113 nginx/nginx-prometheus-exporter:1.0.0 --nginx.plus --nginx.scrape-uri=http://<nginx-plus>:8080/api
68
69
```
69
70
70
71
where `<nginx-plus>` is the IP address/DNS name, through which NGINX Plus is available.
@@ -74,71 +75,60 @@ To start the exporter we use the [docker run](https://docs.docker.com/engine/ref
where `<nginx>` is the path to unix domain socket, through which NGINX stub status is available.
97
98
98
-
**Note**. The `nginx-prometheus-exporter` is not a daemon. To run the exporter as a system service (daemon), configure
99
-
the init system of your Linux server (such as systemd or Upstart) accordingly. Alternatively, you can run the exporter
99
+
**Note**. The `nginx-prometheus-exporter` is not a daemon. To run the exporter as a system service (daemon), you can
100
+
follow the example in [examples/systemd](./examples/systemd/README.md). Alternatively, you can run the exporter
100
101
in a Docker container.
101
102
102
103
## Usage
103
104
104
105
### Command-line Arguments
105
106
106
107
```console
107
-
Usage of ./nginx-prometheus-exporter:
108
-
-nginx.plus
109
-
Start the exporter for NGINX Plus. By default, the exporter is started for NGINX. The default value can be overwritten by NGINX_PLUS environment variable.
110
-
-nginx.retries int
111
-
A number of retries the exporter will make on start to connect to the NGINX stub_status page/NGINX Plus API before exiting with an error. The default value can be overwritten by NGINX_RETRIES environment variable.
112
-
-nginx.retry-interval duration
113
-
An interval between retries to connect to the NGINX stub_status page/NGINX Plus API on start. The default value can be overwritten by NGINX_RETRY_INTERVAL environment variable. (default 5s)
114
-
-nginx.scrape-uri string
115
-
A URI or unix domain socket path for scraping NGINX or NGINX Plus metrics.
116
-
For NGINX, the stub_status page must be available through the URI. For NGINX Plus -- the API. The default value can be overwritten by SCRAPE_URI environment variable. (default "http://127.0.0.1:8080/stub_status")
117
-
Configure this option with the URI for every nginx instance to scrape.
118
-
-nginx.ssl-ca-cert string
119
-
Path to the PEM encoded CA certificate file used to validate the servers SSL certificate. The default value can be overwritten by SSL_CA_CERT environment variable.
120
-
-nginx.ssl-client-cert string
121
-
Path to the PEM encoded client certificate file to use when connecting to the server. The default value can be overwritten by SSL_CLIENT_CERT environment variable.
122
-
-nginx.ssl-client-key string
123
-
Path to the PEM encoded client certificate key file to use when connecting to the server. The default value can be overwritten by SSL_CLIENT_KEY environment variable.
124
-
-nginx.ssl-verify
125
-
Perform SSL certificate verification. The default value can be overwritten by SSL_VERIFY environment variable. (default true)
126
-
-nginx.timeout duration
127
-
A timeout for scraping metrics from NGINX or NGINX Plus. The default value can be overwritten by TIMEOUT environment variable. (default 5s)
128
-
-prometheus.const-labels value
129
-
A comma separated list of constant labels that will be used in every metric. Format is label1=value1,label2=value2... The default value can be overwritten by CONST_LABELS environment variable.
130
-
-web.listen-address string
131
-
An address or unix domain socket path to listen on for web interface and telemetry. The default value can be overwritten by LISTEN_ADDRESS environment variable. (default ":9113")
132
-
-web.telemetry-path string
133
-
A path under which to expose metrics. The default value can be overwritten by TELEMETRY_PATH environment variable. (default "/metrics")
134
-
-web.secured-metrics
135
-
Expose metrics using https. The default value can be overwritten by SECURED_METRICS variable. (default false)
136
-
-web.ssl-server-cert string
137
-
Path to the PEM encoded certificate for the nginx-exporter metrics server(when web.secured-metrics=true). The default value can be overwritten by SSL_SERVER_CERT variable.
138
-
-web.ssl-server-key string
139
-
Path to the PEM encoded key for the nginx-exporter metrics server (when web.secured-metrics=true). The default value can be overwritten by SSL_SERVER_KEY variable.
140
-
-version
141
-
Display the NGINX exporter version. (default false)
108
+
usage: nginx-prometheus-exporter [<flags>]
109
+
110
+
111
+
Flags:
112
+
-h, --[no-]help Show context-sensitive help (also try --help-long and --help-man).
113
+
--web.listen-address=:9113 ...
114
+
Addresses on which to expose metrics and web interface. Repeatable for multiple addresses.
115
+
--web.config.file="" [EXPERIMENTAL] Path to configuration file that can enable TLS or authentication. See: https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md
116
+
--web.telemetry-path="/metrics"
117
+
Path under which to expose metrics. ($TELEMETRY_PATH)
118
+
--[no-]nginx.plus Start the exporter for NGINX Plus. By default, the exporter is started for NGINX. ($NGINX_PLUS)
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.
As an alternative, you can choose the *edge* version built from the [latest
398
-
commit](https://github.com/nginxinc/nginx-prometheus-exporter/commits/main)from the main branch. The edge version is
399
-
useful for experimenting with new features that are not yet published in a stable release.
397
+
As an alternative, you can choose the *edge* version built from the [latest commit](https://github.com/nginxinc/nginx-prometheus-exporter/commits/main)
398
+
from the main branch. The edge version is useful for experimenting with new features that are not yet published in a
metricsPath=kingpin.Flag("web.telemetry-path", "Path under which to expose metrics.").Default("/metrics").Envar("TELEMETRY_PATH").String()
87
87
nginxPlus=kingpin.Flag("nginx.plus", "Start the exporter for NGINX Plus. By default, the exporter is started for NGINX.").Default("false").Envar("NGINX_PLUS").Bool()
88
-
scrapeURIs=kingpin.Flag("nginx.scrape-uri", "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.").Default("http://127.0.0.1:8080/stub_status").Strings()
88
+
scrapeURIs=kingpin.Flag("nginx.scrape-uri", "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.").Default("http://127.0.0.1:8080/stub_status").Strings()
sslCaCert=kingpin.Flag("nginx.ssl-ca-cert", "Path to the PEM encoded CA certificate file used to validate the servers SSL certificate.").Default("").Envar("SSL_CA_CERT").String()
91
91
sslClientCert=kingpin.Flag("nginx.ssl-client-cert", "Path to the PEM encoded client certificate file to use when connecting to the server.").Default("").Envar("SSL_CLIENT_CERT").String()
0 commit comments