prometheus / prometheus/graphite_exporter
Expand documentation of mapping
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 405
- Forks
- 113
- Avg merge
- 9d 5h
- Merged PRs (30d)
- 5
Description
Breakout from #80:
- Provide examples using regex not just glob in the documentation
- Provide an example using a catch-all regex for metrics not matching an existing regex.
- Explain the difference between using the configuration for dropping all non match metrics versus using a catch all regex to provide an indication that metrics are not matching and would have been dropped.
The mapping is closely related to that of the statsd exporter – the main difference is that all Graphite metrics are considered a gauge.
Maybe it makes sense to have a unified mapping documentation, but for now, the statsd exporter readme can serve as an inspiration for this one.
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 with the existing mapping documentation and the statsd exporter README, which the issue identifies as related and useful inspiration. Add regex examples, a catch-all regex example, and a clear comparison of dropping unmatched metrics versus exposing them through a catch-all; done means all three requested explanations are present.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, observability
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100