influxdata / influxdata/telegraf
`prometheus_metric_version` is not documented in prometheus parser docs
- Dominant language
- Go
- Stars
- 17.8k
- Forks
- 5.8k
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 161
Description
The documentation for the prometheus parser does not mention that there are two different versions of the parser that would parse the same metric differently. This leads to confusion, especially since the current [README.md](https://github.com/influxdata/telegraf/tree/master/plugins/parsers/prometheus) states that the parser does not support any additional configuration options. Meanwhile, there does exist the option `prometheus_metric_version` which is currently not documented and allows switching between v1 and v2 of the parser.
Contributor guide
Research direction
Start with plugins/parsers/prometheus/README.md, linked in the issue. Document that the parser has v1 and v2 behavior and describe the prometheus_metric_version option, including that it selects between them. Done means the README no longer says the parser has no additional configuration options and clearly explains this setting.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- prometheus
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100