Skip to content

Commit 72c9a72

Browse files
committed
Use equal sign in cli args examples
This should help prevent confusion like in this issue #153 , where no '=' was used for the value of a boolean arg. For boolean args, it is necessary to use '='
1 parent 579a953 commit 72c9a72

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,33 +30,33 @@ To start the exporter we use the [docker run](https://docs.docker.com/engine/ref
3030

3131
* To export NGINX metrics, run:
3232
```
33-
$ docker run -p 9113:9113 nginx/nginx-prometheus-exporter:0.8.0 -nginx.scrape-uri http://<nginx>:8080/stub_status
33+
$ docker run -p 9113:9113 nginx/nginx-prometheus-exporter:0.8.0 -nginx.scrape-uri=http://<nginx>:8080/stub_status
3434
```
3535
where `<nginx>` is the IP address/DNS name, through which NGINX is available.
3636
3737
* To export NGINX Plus metrics, run:
3838
```
39-
$ docker run -p 9113:9113 nginx/nginx-prometheus-exporter:0.8.0 -nginx.plus -nginx.scrape-uri http://<nginx-plus>:8080/api
39+
$ docker run -p 9113:9113 nginx/nginx-prometheus-exporter:0.8.0 -nginx.plus -nginx.scrape-uri=http://<nginx-plus>:8080/api
4040
```
4141
where `<nginx-plus>` is the IP address/DNS name, through which NGINX Plus is available.
4242
4343
### Running the Exporter Binary
4444
4545
* To export NGINX metrics, run:
4646
```
47-
$ nginx-prometheus-exporter -nginx.scrape-uri http://<nginx>:8080/stub_status
47+
$ nginx-prometheus-exporter -nginx.scrape-uri=http://<nginx>:8080/stub_status
4848
```
4949
where `<nginx>` is the IP address/DNS name, through which NGINX is available.
5050
5151
* To export NGINX Plus metrics:
5252
```
53-
$ nginx-prometheus-exporter -nginx.plus -nginx.scrape-uri http://<nginx-plus>:8080/api
53+
$ nginx-prometheus-exporter -nginx.plus -nginx.scrape-uri=http://<nginx-plus>:8080/api
5454
```
5555
where `<nginx-plus>` is the IP address/DNS name, through which NGINX Plus is available.
5656
5757
* To export and scrape NGINX metrics with unix domain sockets, run:
5858
```
59-
$ nginx-prometheus-exporter -nginx.scrape-uri unix:<nginx>:/stub_status -web.listen-address unix:/path/to/socket.sock
59+
$ nginx-prometheus-exporter -nginx.scrape-uri=unix:<nginx>:/stub_status -web.listen-address=unix:/path/to/socket.sock
6060
```
6161
where `<nginx>` is the path to unix domain socket, through which NGINX stub status is available.
6262

0 commit comments

Comments
 (0)