vectordotdev / vectordotdev/vector
bug(docs): fix wording of `distributions_as_summaries` field in`prometheus_exporter` sink docs
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 22.6k
- Forks
- 2.3k
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 146
Description
Currently, the documentation for the distributions_as_summaries configuration field links to the sections for Vector's own metrics model in terms of what a user can expect to see emitted by the sink. In reality, the intent is to say that Vector will either emit distributions as an aggregated histogram or aggregated summary, where sum and count are always present, and either the histogram buckets or summary quantiles will be emitted, respectively.
We should change the two links in the documentation for that field to point to the appropriate Prometheus documentation for aggregated histograms and aggregated summaries, respectively.
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 documentation for the prometheus_exporter sink and locate the distributions_as_summaries field. Replace its two links with the appropriate Prometheus documentation for aggregated histograms and aggregated summaries, then verify that the wording describes sum and count plus either buckets or quantiles.
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
- 72/100