prometheus / prometheus/client_python

Improve documentation for Enum and Info classes

Ouverte
#499 5 commentaires 7 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Python
Étoiles
4.4k
Forks
876
Merge moyen
8 j 4 h
PR mergées (30 j)
1

Description

In Instrumenting section of documentation (https://github.com/prometheus/client_python#instrumenting) there is written:

Four types of metric are offered: Counter, Gauge, Summary and Histogram.

Classes for exposing these metrics are then described and in addition there are mentioned also Info and Enum classes without explanation how these classes should be used and what type of metrics they expose. These should be documented in more detail.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par la section de documentation « Instrumenting » du dépôt et examinez la façon dont les classes de métriques existantes sont décrites. Documentez l’utilisation des classes Info et Enum ainsi que les types de métriques qu’elles exposent ; la section est complète lorsque les deux classes disposent d’explications comparables à celles des autres types de métriques.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.