From ad094d4c8e1a1fc9092e0c119bdb1afd1cf8a86d Mon Sep 17 00:00:00 2001 From: Curtis Robert Date: Thu, 29 Aug 2024 09:48:18 -0700 Subject: [PATCH] [chore][receiver/nginx] Update README for consistency --- receiver/nginxreceiver/README.md | 21 +++++++-------------- 1 file changed, 7 insertions(+), 14 deletions(-) diff --git a/receiver/nginxreceiver/README.md b/receiver/nginxreceiver/README.md index b346f8b6986a..f2a5517c6eeb 100644 --- a/receiver/nginxreceiver/README.md +++ b/receiver/nginxreceiver/README.md @@ -1,4 +1,4 @@ -# Nginx Receiver +# NGINX Receiver | Status | | @@ -12,13 +12,12 @@ [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib -This receiver can fetch stats from a Nginx instance using the `ngx_http_stub_status_module` module's `status` endpoint. - -## Details +This receiver can fetch stats from a NGINX instance using the `ngx_http_stub_status_module` module's `status` endpoint. ## Configuration -### Nginx Module +### NGINX Module + You must configure NGINX to expose status information by editing the NGINX configuration. Please see [ngx_http_stub_status_module](http://nginx.org/en/docs/http/ngx_http_stub_status_module.html) @@ -26,20 +25,14 @@ for a guide to configuring the NGINX stats module `ngx_http_stub_status_module`. ### Receiver Config -> :information_source: This receiver is in beta and configuration fields are subject to change. - The following settings are required: -- `endpoint` (default: `http://localhost:80/status`): The URL of the nginx status endpoint +- `endpoint` (default: `http://localhost:80/status`): The URL of the NGINX status endpoint The following settings are optional: -- `collection_interval` (default = `10s`): This receiver runs on an interval. -Each time it runs, it queries nginx, creates metrics, and sends them to the -next consumer. The `collection_interval` configuration option tells this -receiver the duration between runs. This value must be a string readable by -Golang's `ParseDuration` function (example: `1h30m`). Valid time units are -`ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`. +- `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`. + - `initial_delay` (default = `1s`): defines how long this receiver waits before starting. Example: