[Docs] prometheus.exporter.[blackbox, snmp] misc. fixes (#5187) (#5220)

* 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 <[email protected]> * Revert "Fix blocks header levels and move 'period and length' section" This reverts commit 93a593a. --------- Co-authored-by: Clayton Cornell <[email protected]> (cherry picked from commit 31999c8) Co-authored-by: Mischa Thompson <[email protected]>
grafana · Sep 14, 2023 · 40407dd · 40407dd
1 parent 37cf7f5
commit 40407dd
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 16 deletions.
diff --git 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
@@ -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
@@ -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