|
1 |
| -# Nginx Receiver |
| 1 | +# NGINX Receiver |
2 | 2 |
|
3 | 3 | <!-- status autogenerated section -->
|
4 | 4 | | Status | |
|
|
12 | 12 | [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
|
13 | 13 | <!-- end autogenerated section -->
|
14 | 14 |
|
15 |
| -This receiver can fetch stats from a Nginx instance using the `ngx_http_stub_status_module` module's `status` endpoint. |
16 |
| - |
17 |
| -## Details |
| 15 | +This receiver can fetch stats from a NGINX instance using the `ngx_http_stub_status_module` module's `status` endpoint. |
18 | 16 |
|
19 | 17 | ## Configuration
|
20 | 18 |
|
21 |
| -### Nginx Module |
| 19 | +### NGINX Module |
| 20 | + |
22 | 21 | You must configure NGINX to expose status information by editing the NGINX
|
23 | 22 | configuration. Please see
|
24 | 23 | [ngx_http_stub_status_module](http://nginx.org/en/docs/http/ngx_http_stub_status_module.html)
|
25 | 24 | for a guide to configuring the NGINX stats module `ngx_http_stub_status_module`.
|
26 | 25 |
|
27 | 26 | ### Receiver Config
|
28 | 27 |
|
29 |
| -> :information_source: This receiver is in beta and configuration fields are subject to change. |
30 |
| -
|
31 | 28 | The following settings are required:
|
32 | 29 |
|
33 |
| -- `endpoint` (default: `http://localhost:80/status`): The URL of the nginx status endpoint |
| 30 | +- `endpoint` (default: `http://localhost:80/status`): The URL of the NGINX status endpoint |
34 | 31 |
|
35 | 32 | The following settings are optional:
|
36 | 33 |
|
37 |
| -- `collection_interval` (default = `10s`): This receiver runs on an interval. |
38 |
| -Each time it runs, it queries nginx, creates metrics, and sends them to the |
39 |
| -next consumer. The `collection_interval` configuration option tells this |
40 |
| -receiver the duration between runs. This value must be a string readable by |
41 |
| -Golang's `ParseDuration` function (example: `1h30m`). Valid time units are |
42 |
| -`ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`. |
| 34 | +- `collection_interval` (default = `10s`): This receiver collects metrics on an interval. This value must be a string readable by Golang's [time.ParseDuration](https://pkg.go.dev/time#ParseDuration). Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`. |
| 35 | + |
43 | 36 | - `initial_delay` (default = `1s`): defines how long this receiver waits before starting.
|
44 | 37 |
|
45 | 38 | Example:
|
|
0 commit comments