From 72e9c4725368ffdbfad027e1d94be9421ec48aaf Mon Sep 17 00:00:00 2001 From: Mischa Thompson Date: Thu, 14 Sep 2023 12:27:14 -0700 Subject: [PATCH] [Docs] prometheus.exporter.[blackbox, snmp] misc. fixes (#5187) * Remove name from block arguments and add a sentence that a label is required * Fix blocks header levels and move 'period and length' section * Add suggested change Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com> * Revert "Fix blocks header levels and move 'period and length' section" This reverts commit 93a593aad79e1a88eac4e6d5e3e63107866156c2. --------- Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com> (cherry picked from commit 31999c8224d3d6cbf848fa441e5862a03abd5837) --- .../components/prometheus.exporter.blackbox.md | 11 +++++------ .../prometheus.exporter.cloudwatch.md | 2 +- .../components/prometheus.exporter.snmp.md | 17 ++++++++--------- 3 files changed, 14 insertions(+), 16 deletions(-) diff --git a/docs/sources/flow/reference/components/prometheus.exporter.blackbox.md b/docs/sources/flow/reference/components/prometheus.exporter.blackbox.md index 05c4605722ec..1d15fb25913b 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.blackbox.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.blackbox.md @@ -53,13 +53,12 @@ target | [target][] | Configures a blackbox target. | yes ### target block The `target` block defines an individual blackbox target. -The `target` block may be specified multiple times to define multiple targets. +The `target` block may be specified multiple times to define multiple targets. The label of the block is required and will be used in the target's `job` label. -Name | Type | Description | Default | Required ----- | ---- | ----------- | ------- | -------- -`name` | `string` | Name of the target. | | yes -`address` | `string` | The address of the target to probe. | | yes -`module`| `string` | Blackbox module to use to probe. | `""` | no +| Name | Type | Description | Default | Required | +| --------- | -------- | ----------------------------------- | ------- | -------- | +| `address` | `string` | The address of the target to probe. | | yes | +| `module` | `string` | Blackbox module to use to probe. | `""` | no | ## Exported fields diff --git a/docs/sources/flow/reference/components/prometheus.exporter.cloudwatch.md b/docs/sources/flow/reference/components/prometheus.exporter.cloudwatch.md index 724b63b5857e..5274d8978335 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.cloudwatch.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.cloudwatch.md @@ -337,7 +337,7 @@ scheduled interval. When this feature is enabled, CloudWatch metrics are gathere of synchronously when the CloudWatch component is scraped. The decoupled scraping feature reduces the number of API requests sent to AWS. -This feature also prevents component scrape timeouts when you gather high volumes of CloudWatch metrics +This feature also prevents component scrape timeouts when you gather high volumes of CloudWatch metrics. | Name | Type | Description | Default | Required | |-------------------|----------|-------------------------------------------------------------------------|---------|----------| diff --git a/docs/sources/flow/reference/components/prometheus.exporter.snmp.md b/docs/sources/flow/reference/components/prometheus.exporter.snmp.md index f9585598187e..6f72abe2d2d3 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.snmp.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.snmp.md @@ -57,15 +57,14 @@ walk_param | [walk_param][] | SNMP connection profiles to override default SNMP ### target block The `target` block defines an individual SNMP target. -The `target` block may be specified multiple times to define multiple targets. - -Name | Type | Description | Default | Required ----- | ---- | ----------- | ------- | -------- -`name` | `string` | Name of a snmp_target. | | yes -`address` | `string` | The address of SNMP device. | | yes -`module`| `string` | SNMP module to use for polling. | `""` | no -`auth` | `string` | SNMP authentication profile to use. | `""` | no -`walk_params`| `string` | Config to use for this target. | `""` | no +The `target` block may be specified multiple times to define multiple targets. The label of the block is required and will be used in the target's `job` label. + +| Name | Type | Description | Default | Required | +| ------------- | -------- | ----------------------------------- | ------- | -------- | +| `address` | `string` | The address of SNMP device. | | yes | +| `module` | `string` | SNMP module to use for polling. | `""` | no | +| `auth` | `string` | SNMP authentication profile to use. | `""` | no | +| `walk_params` | `string` | Config to use for this target. | `""` | no | ### walk_param block