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: README.md
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,7 +45,7 @@ To start the exporter we use the [docker run](https://docs.docker.com/engine/ref
45
45
46
46
## Usage
47
47
48
-
### Command-line Arguments
48
+
### Command-line Arguments
49
49
50
50
```
51
51
Usage of ./nginx-prometheus-exporter:
@@ -54,13 +54,15 @@ Usage of ./nginx-prometheus-exporter:
54
54
-nginx.scrape-uri string
55
55
A URI for scraping NGINX or NGINX Plus metrics.
56
56
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")
57
+
-nginx.ssl-verify
58
+
Perform SSL certificate verification. The default value can be overwritten by SSL_VERIFY environment variable.
57
59
-web.listen-address string
58
60
An address to listen on for web interface and telemetry. The default value can be overwritten by LISTEN_ADDRESS environment variable. (default ":9113")
59
61
-web.telemetry-path string
60
62
A path under which to expose metrics. The default value can be overwritten by TELEMETRY_PATH environment variable. (default "/metrics")
61
63
```
62
64
63
-
### Exported Metrics
65
+
### Exported Metrics
64
66
65
67
* For NGINX, all stub_status metrics are exported. Connect to the `/metrics` page of the running exporter to see the complete list of metrics along with their descriptions.
66
68
* For NGINX Plus, the following metrics are exported:
@@ -69,7 +71,7 @@ Usage of ./nginx-prometheus-exporter:
* [HTTP Server Zones](http://nginx.org/en/docs/http/ngx_http_api_module.html#def_nginx_http_server_zone).
71
73
* [HTTP Upsteams](http://nginx.org/en/docs/http/ngx_http_api_module.html#def_nginx_http_upstream). Note: for the `state` metric, the string values are converted to float64 using the following rule: `"up"` -> `1.0`, `"draining"` -> `2.0`, `"down"` -> `3.0`, `"unavail"` –> `4.0`, `"checking"` –> `5.0`, `"unhealthy"` -> `6.0`.
72
-
74
+
73
75
Connect to the `/metrics` page of the running exporter to see the complete list of metrics along with their descriptions. Note: to see server zones related metrics you must configure [status zones](https://nginx.org/en/docs/http/ngx_http_status_module.html#status_zone) and to see upstream related metrics you must configure upstreams with a [shared memory zone](http://nginx.org/en/docs/http/ngx_http_upstream_module.html#zone).
74
76
75
77
### Troubleshooting
@@ -86,10 +88,10 @@ You can build the exporter image using the provided Makefile. Before building th
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.`)
0 commit comments