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

Docs feedback: Error in prometheus.exporter.snmp component documentation #2013

Open
clayton-cornell opened this issue Oct 31, 2024 · 1 comment
Assignees
Labels
type/docs Docs Squad label across all Grafana Labs repos

Comments

@clayton-cornell
Copy link
Contributor

clayton-cornell commented Oct 31, 2024

URL

https://grafana.com/docs/alloy/latest/reference/components/prometheus/prometheus.exporter.snmp/

Feedback

Slack discussion: https://raintank-corp.slack.com/archives/C5PG2JK8W/p1730395307519059

There is an error with this alloy doc for snmp. The line
targets = encoding.from_yaml(local.file.targets.content)
is wrong. encoding.from_yaml does not return an array ( as you can see from here), which is what targets expect. Instead, file based discovery should be used here.

@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Oct 31, 2024
@clayton-cornell clayton-cornell self-assigned this Oct 31, 2024
@ptodev
Copy link
Contributor

ptodev commented Oct 31, 2024

I do think encoding.from_yaml should produce an array actually, since the yaml example file also has an array. Are we sure this is a problem?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Docs Squad label across all Grafana Labs repos
Projects
None yet
Development

No branches or pull requests

2 participants