From 7aaf0f7d03fa432cecd5eea15386b8292fd41a6d Mon Sep 17 00:00:00 2001 From: hainenber Date: Tue, 21 Nov 2023 23:31:31 +0700 Subject: [PATCH] doc(exporter/elasticsearch): add Basic Auth block desc Signed-off-by: hainenber --- .../prometheus.exporter.elasticsearch.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/sources/flow/reference/components/prometheus.exporter.elasticsearch.md b/docs/sources/flow/reference/components/prometheus.exporter.elasticsearch.md index 4b17ab0602bc..81cf749cc190 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.elasticsearch.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.elasticsearch.md @@ -56,6 +56,21 @@ Omitted fields take their default values. | `data_streams` | `bool` | Export stats for Data Streams. | | no | | `slm` | `bool` | Export stats for SLM (Snapshot Lifecycle Management). | | no | +## Blocks + +The following blocks are supported inside the definition of +`prometheus.exporter.elasticsearch`: + +| Hierarchy | Block | Description | Required | +| ------------------- | ----------------- | -------------------------------------------------------- | -------- | +| basic_auth | [basic_auth][] | Configure basic_auth for authenticating to the endpoint. | no | + +[basic_auth]: #basic_auth-block + +### basic_auth block + +{{< docs/shared lookup="flow/reference/components/basic-auth-block.md" source="agent" version="" >}} + ## Exported fields {{< docs/shared lookup="flow/reference/components/exporter-component-exports.md" source="agent" version="" >}} @@ -84,6 +99,10 @@ from `prometheus.exporter.elasticsearch`: ```river prometheus.exporter.elasticsearch "example" { address = "http://localhost:9200" + basic_auth { + username = USERNAME + password = PASSWORD + } } // Configure a prometheus.scrape component to collect Elasticsearch metrics.