prometheus/prometheus

Help/Description entry for recording rules

Ouverte

#11 969 ouverte le 13 févr. 2023

Voir sur GitHubGuide contributeur
 (4 commentaires) (0 réaction) (0 personne assignée)Go (10 408 forks)batch import
component/ruleshelp wanted

Métriques du dépôt

Stars
 (64 042 étoiles)
Métriques de merge PR
 (Merge moyen 11j 5h) (118 PRs mergées en 30 j)

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

Guide contributeur

Direction de recherche
Examinez comment le champ 'help' pour les métriques et le champ 'description' pour les règles d'alerte sont analysés, stockés et exposés. Ajoutez ensuite un champ 'description' similaire à la structure de la règle d'enregistrement, mettez à jour l'analyse YAML et assurez vous qu'il est accessible via l'API et la documentation.
Stack technique
go
Domaine
backenddevops
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GoGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75