Add SNMP exporter explanation
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 717
- Forks
- 1.2k
- Avg merge
- 3d 15h
- Merged PRs (30d)
- 19
Description
Using the SNMP exporter is not easy. It is necessary to understand quite a few concepts to be able to deploy it in a meaningful way. Among them SNMP, Prometheus, relabeling, the proxy exporter pattern, the SNMP exporter and its snmp.yml generator.
Hence an explanation to give people the necessary overview would be good. The purpose is neither a complete step-by-step guide nor a complete reference. It should enable people who have not heard of SNMP before to deploy and configure the exporter and Prometheus to do something useful with and to research meaningful SNMP OID and walks themselves.
Because the proxy exporter pattern is recurring, it will be handled in a separate issue #1193 and explanation. The SNMP exporter explanation will just link to that .
As proposed on the users mailing list and announced on the devs mailing list I want to write those explanations, but help is very welcome.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by organizing the requested explanation around SNMP, Prometheus, relabeling, the SNMP exporter, and its snmp.yml generator. Keep the proxy exporter pattern as a link to issue #1193; done means a newcomer can deploy and configure the exporter and Prometheus, then research useful SNMP OIDs and walks independently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- prometheus
- Domain
- documentation, observability-sre
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100