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

Update snmp doc #1919

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+7 −5
Open

Update snmp doc #1919

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9412ebb
update snmp doc
wildum Oct 18, 2024
8d49144
add version for snmp exporter in _index file
wildum Oct 18, 2024
e3e3250
add comments in go.mod to help keeping the doc in sync
wildum Oct 18, 2024
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
2 changes: 1 addition & 1 deletion docs/sources/reference/components/prometheus/prometheus.exporter.snmp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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?


The `config` argument must be a YAML document as string defining which SNMP modules and auths to use.
`config` is typically loaded by using the exports of another component. For example,
Expand Down
2 changes: 1 addition & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ require (
github.com/prometheus/node_exporter v1.6.0
github.com/prometheus/procfs v0.15.1
github.com/prometheus/prometheus v0.54.1 // a.k.a. v2.51.2
github.com/prometheus/snmp_exporter v0.26.0
github.com/prometheus/snmp_exporter v0.26.0 // if you update the snmp_exporter version, make sure to update the links in prometheus.exporter.snmp
github.com/prometheus/statsd_exporter v0.22.8
github.com/richardartoul/molecule v1.0.1-0.20221107223329-32cfee06a052
github.com/rogpeppe/go-internal v1.12.0
Expand Down
Loading