prometheus/prometheus

Help/Description entry for recording rules

开放

#11,969 创建于 2023年2月13日

在 GitHub 查看贡献者指南
 (4 条评论) (0 个反应) (0 位负责人)Go (10,408 个派生)batch import
component/ruleshelp wanted

仓库指标

星标
 (64,042 个星标)
PR 合并指标
 (平均合并 11天 5小时) (30 天内合并 118 个 PR)

描述

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

贡献者指南

研究方向
检查指标'help'字段和告警规则'description'字段是如何解析、存储和暴露的。然后为记录规则结构体添加类似的'description'字段，更新YAML解析，并确保通过API和文档可访问。
技术栈
go
领域
backenddevops
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
GoGit
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75