prometheus/prometheus

Help/Description entry for recording rules

Open

#11,969 opened on Feb 13, 2023

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Go (10,408 forks)batch import
component/ruleshelp wanted

Repository metrics

Stars
 (64,042 stars)
PR merge metrics
 (Avg merge 11d 5h) (118 merged PRs in 30d)

Description

Proposal

Today we have

  • HELP entry for metrics
  • Description and Summary for 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

Research direction
Examine how the 'help' field for metrics and 'description' field for alerting rules are parsed, stored, and exposed. Then add a similar 'description' field to the recording rule struct, update YAML parsing, and ensure it is accessible via the API and documentation.
Tech stack
go
Domain
backenddevops
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75