Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 1 commit into from
Sep 14, 2023
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions docs/sources/flow/reference/components/prometheus.exporter.blackbox.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/reference/components/prometheus.exporter.cloudwatch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
|-------------------|----------|-------------------------------------------------------------------------|---------|----------|
Expand Down
17 changes: 8 additions & 9 deletions docs/sources/flow/reference/components/prometheus.exporter.snmp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down