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.

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

Update snmp doc #1919

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update snmp doc #1919

wants to merge 3 commits into from

Conversation

wildum
Copy link
Contributor

@wildum wildum commented Oct 18, 2024

It's likely that it won't work if you try to use a snmp.yml file that does not match the snmp exporter version in your Alloy. This change will redirect users to the version of the snmp exporter that matches the one used in Alloy

@wildum wildum requested review from clayton-cornell and a team as code owners October 18, 2024 09:25
@@ -48,7 +48,7 @@ Omitted fields take their default values.
| `targets` | `list(map(string))` | SNMP targets. | | no |

The `config_file` argument points to a YAML file defining which snmp_exporter modules to use.
Refer to [snmp_exporter](https://github.com/prometheus/snmp_exporter#generating-configuration) for details on how to generate a configuration file.
Refer to [snmp_exporter](https://github.com/prometheus/snmp_exporter/tree/v0.26.0?tab=readme-ov-file#configuration) for details on how to generate a configuration file.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be best to add an SNMP_EXP_VERSION to docs/sources/_index.md.t, and to also use it in the link to the upsteram repo at the top of the page, as well as in the {{< admonition type="note" >}}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the suggestion, that's much better indeed. I added a comment in the go.mod also for the windows exporter in case there is an update to also change the version. Btw it seems that it's already out of sync, shouldn't it be v0.27.4 in the doc instead of v0.27.3?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants