Skip to content

Commit 8706e23

Browse files
crobert-1f7o
authored andcommitted
[chore][receiver/nginx] Update README for consistency (open-telemetry#34923)
**Description:** <Describe what has changed.> <!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> This just cleans up the README a bit: 1. Make case of `NGINX` consistent. Happy to change it to `nginx` if that's preferred. 2. Remove empty `Details` section 3. Cleanup description of the `collection_interval` config option. This is the same config option many other receivers have, so I don't think the concept needs explained in-depth here. 4. Remove disclaimer that the component's status is beta and configuration is subject to change. The README's header states this component is beta, so I don't think it needs to be repeated.
1 parent 78e49b2 commit 8706e23

File tree

1 file changed

+7
-14
lines changed

1 file changed

+7
-14
lines changed

receiver/nginxreceiver/README.md

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Nginx Receiver
1+
# NGINX Receiver
22

33
<!-- status autogenerated section -->
44
| Status | |
@@ -12,34 +12,27 @@
1212
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
1313
<!-- end autogenerated section -->
1414

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.
1816

1917
## Configuration
2018

21-
### Nginx Module
19+
### NGINX Module
20+
2221
You must configure NGINX to expose status information by editing the NGINX
2322
configuration. Please see
2423
[ngx_http_stub_status_module](http://nginx.org/en/docs/http/ngx_http_stub_status_module.html)
2524
for a guide to configuring the NGINX stats module `ngx_http_stub_status_module`.
2625

2726
### Receiver Config
2827

29-
> :information_source: This receiver is in beta and configuration fields are subject to change.
30-
3128
The following settings are required:
3229

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
3431

3532
The following settings are optional:
3633

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+
4336
- `initial_delay` (default = `1s`): defines how long this receiver waits before starting.
4437

4538
Example:

0 commit comments

Comments
 (0)