prometheus/prometheus

Help/Description entry for recording rules

Aberta

#11.969 aberto em 13 de fev. de 2023

Ver no GitHubGuia do colaborador
 (4 comentários) (0 reação) (0 responsável)Go (10.408 forks)batch import
component/ruleshelp wanted

Métricas do repositório

Stars
 (64.042 estrelas)
Métricas de merge de PR
 (Mesclagem média 11d 5h) (118 fundiu PRs em 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

Guia do colaborador

Direção de pesquisa
Examine como o campo 'help' para métricas e o campo 'description' para regras de alerta são analisados, armazenados e expostos. Em seguida, adicione um campo 'description' semelhante à estrutura da regra de gravação, atualize a análise YAML e garanta que seja acessível via API e documentação.
Pilha de tecnologia
go
Domain
backenddevops
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GoGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75