From 3148002d737fbcb88f067149c6e71ca31bd0f69e Mon Sep 17 00:00:00 2001 From: Andrzej Stencel Date: Fri, 18 Aug 2023 17:40:10 +0200 Subject: [PATCH] [chore][receiver/httpcheck] fix configuration docs (#25881) Replaces `endpoint` with `targets` in README as changed in https://github.com/open-telemetry/opentelemetry-collector-contrib/pull/23439. --- receiver/httpcheckreceiver/README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/receiver/httpcheckreceiver/README.md b/receiver/httpcheckreceiver/README.md index 413ca3082300..caac67130fc3 100644 --- a/receiver/httpcheckreceiver/README.md +++ b/receiver/httpcheckreceiver/README.md @@ -27,15 +27,16 @@ httpcheck.status{http.status_class:5xx, http.status_code:200,...} = 0 ## Configuration -The following configuration settings are required: +The following configuration settings are available: -- `endpoint`: The URL of the endpoint to be monitored. +- `targets` (required): The list of targets to be monitored. +- `collection_interval` (optional, default = `60s`): This receiver collects metrics on an interval. Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`. +- `initial_delay` (optional, default = `1s`): defines how long this receiver waits before starting. -The following configuration settings are optional: +Each target has the following properties: -- `method` (default: `GET`): The method used to call the endpoint. -- `collection_interval` (default = `60s`): This receiver collects metrics on an interval. Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`. -- `initial_delay` (default = `1s`): defines how long this receiver waits before starting. +- `endpoint` (required): the URL to be monitored +- `method` (optional, default: `GET`): The HTTP method used to call the endpoint ### Example Configuration