Document partial remote read failures / warnings
Open
Nobody has claimed this yet.
help-wanted
kind/enhancement
priority/p3
- Dominant language
- TypeScript
- Stars
- 717
- Forks
- 1.2k
- Avg merge
- 3d 15h
- Merged PRs (30d)
- 19
Description
See https://github.com/prometheus/prometheus/pull/4832.
We should document:
- in the remote write config docs: how exactly does the partial failure behavior work? (or is there a better place to document this?)
- in the query API docs: document the new warnings field that can be returned.
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 reading pull request 4832 and the existing remote write configuration and query API documentation. Document the exact partial failure behavior for remote writes and the query API warnings field, with both topics covered in the appropriate documentation sections.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100