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

* 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 · 0650e0f · 0650e0f
1 parent c1d08c4
commit 0650e0f
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 15 deletions.
diff --git a/docs/sources/flow/reference/components/prometheus.exporter.blackbox.md b/docs/sources/flow/reference/components/prometheus.exporter.blackbox.md
@@ -49,13 +49,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
@@ -322,6 +322,20 @@ is exported to CloudWatch.
 
 ![](https://grafana.com/media/docs/agent/cloudwatch-multiple-period-time-model.png)
 
+## decoupled scraping block
+
+The decoupled scraping block configures an optional feature that scrapes CloudWatch metrics in the background on a
+scheduled interval. When this feature is enabled, CloudWatch metrics are gathered asynchronously at the scheduled interval instead
+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.
+
+| Name              | Type     | Description                                                             | Default | Required |
+| ----------------- | -------- | ----------------------------------------------------------------------- | ------- | -------- |
+| `enabled`         | `bool`   | Controls whether the decoupled scraping featured is enabled             | false   | no       |
+| `scrape_interval` | `string` | Controls how frequently to asynchronously gather new CloudWatch metrics | 5m      | no       |
+
 ## Exported fields
 
 {{< docs/shared lookup="flow/reference/components/exporter-component-exports.md" source="agent" version="<AGENT VERSION>" >}}

diff --git a/docs/sources/flow/reference/components/prometheus.exporter.snmp.md b/docs/sources/flow/reference/components/prometheus.exporter.snmp.md
@@ -53,15 +53,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