SNMP exporter: Label targets block as deprecated #2274
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 tasks
wildum
reviewed
Dec 12, 2024
docs/sources/reference/components/prometheus/prometheus.exporter.snmp.md
Outdated
Show resolved
Hide resolved
docs/sources/reference/components/prometheus/prometheus.exporter.snmp.md
Outdated
Show resolved
Hide resolved
docs/sources/reference/components/prometheus/prometheus.exporter.snmp.md
Outdated
Show resolved
Hide resolved
Comment on lines
20
to
21
| ### Recommended usage | ||
|
|
There was a problem hiding this comment.
I'd like to remove this and keep it just Usage to keep it consistent with the other topic layouts.
docs/sources/reference/components/prometheus/prometheus.exporter.snmp.md
Outdated
Show resolved
Hide resolved
|
💻 Deploy preview available: https://deploy-preview-alloy-2274-zb444pucvq-vp.a.run.app/docs/alloy/latest/ |
|
@clayton-cornell @wildum I edited the page to put less emphasis on the deprecated options. I do think it looks better now! Thank you for the feedback. |
| | walk_param | [walk_param][] | SNMP connection profiles to override default SNMP settings. | no | | ||
|
|
||
| [target]: #target-block | ||
| [walk_param]: #walk_param-block | ||
|
|
||
| ### target block | ||
|
|
||
| {{< admonition type="warning" >}} | ||
|
|
||
| Using the `target` block is deprecated because it is less flexible than the `targets` argument: |
There was a problem hiding this comment.
Suggested change
| Using the `target` block is deprecated because it is less flexible than the `targets` argument: | |
| Starting with {{< param "FULL_PRODUCT_NAME" >}} version 1.6, the `target` block is deprecated. | |
| It will be removed in a future release. | |
| The `target` block is deprecated because it is less flexible than the `targets` argument: |
What release is target deprecated in? v1.6? v2.0?
Including the text suggestion from herE: https://grafana.com/docs/writers-toolkit/write/deprecate-remove/#deprecation
| @@ -94,6 +95,19 @@ The `target` block may be specified multiple times to define multiple targets. T | |||
| | `snmp_context` | `string` | Override the `context_name` parameter in the SNMP configuration file. | `""` | no | | |||
| | `labels` | `map(string)` | Map of labels to apply to all metrics captured from the target. | `""` | no | | |||
|
|
|||
| {{< collapse title="Deprecated example using the target block" >}} | |||
There was a problem hiding this comment.
Suggested change
| {{< collapse title="Deprecated example using the target block" >}} | |
| {{< collapse title="Example using the target block (deprecated)" >}} |
| @@ -74,14 +63,26 @@ The following blocks are supported inside the definition of | |||
|
|
|||
| | Hierarchy | Name | Description | Required | | |||
| | ---------- | -------------- | ----------------------------------------------------------- | -------- | | |||
| | target | [target][] | Configures an SNMP target. | no | | |||
| | target | [target][] | (Deprecated) Configures an SNMP target. | no | | |||
| | walk_param | [walk_param][] | SNMP connection profiles to override default SNMP settings. | no | | |||
|
|
|||
| [target]: #target-block | |||
| [walk_param]: #walk_param-block | |||
|
|
|||
| ### target block | |||
There was a problem hiding this comment.
Suggested change
| ### target block | |
| ### target block (deprecated) |
| | walk_param | [walk_param][] | SNMP connection profiles to override default SNMP settings. | no | | ||
|
|
||
| [target]: #target-block | ||
| [walk_param]: #walk_param-block | ||
|
|
||
| ### target block | ||
|
|
||
| {{< admonition type="warning" >}} |
There was a problem hiding this comment.
Suggested change
| {{< admonition type="warning" >}} | |
| {{< admonition type="caution" >}} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since the
targetblock is deprecated, it'd be nice to mention this in the docs #979.In general, it's not ideal how there are so many ways to do the same thing in this components:
targetblock andtargetsargumentconfig_fileargument andconfigargumentI wish we didn't have the
config_fileargument at all. I really don't see the benefit in it.