prometheus / prometheus/prometheus
Help/Description entry for recording rules
Open
Nobody has claimed this yet.
component/rules
help wanted
- Dominant language
- Go
- Stars
- 66.1k
- Forks
- 10.8k
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 131
Description
Proposal
Today we have
HELPentry for metricsDescriptionandSummaryfor Alerting rules
But nothing for Recording rules, I think it will be beneficial to have/support a description entry for it
Example:
groups:
- name: rules
rules:
- record: xxx:yyyy_yyy:zzzz
expr: <PromQL expression>
description: "foo bar"
This will help understanding the rule, generating automatic documentations etc
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 tracing how recording rules are parsed and represented, then compare that path with the existing Description and Summary support for alerting rules. Review the related rule tests and documentation-generation behavior. Done means a recording rule can accept a description such as the proposed YAML field and that the value is available for automatic documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- observability-sre
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100