prometheus / prometheus/client_python

Provide APIs to help application developers test their Histogram-using code

Ouverte
#736 1 commentaire 1 réaction 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

I have an application that uses Histogram. I want to write some tests that assert that my application is putting values into the right buckets of that histogram.

To read values out of the Histogram it seems that need to either:

  • look at the Histogram's private _buckets attribute, or
  • call Histogram.collectand look at the resulting Metric objects which are documented as "intended only for internal use" and then look at its Samples which aren't documented at all.

Neither of these seems particularly satisfactory. It would be very helpful if client_python provided some way to read bucket counts and the total sum from a Histogram, using documented APIs clearly marked as intended for external use (perhaps only in test suites).

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 examiner l’implémentation de Histogram du client Python, en particulier son attribut _buckets et sa méthode collect, ainsi que les objets Metric et Samples qu’elle renvoie. Définissez et testez une API externe documentée permettant de lire les nombres d’éléments des buckets et la somme totale, avec une couverture montrant que les tests de l’application peuvent vérifier les valeurs sans utiliser d’objets privés ou réservés à un usage interne.

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

Évaluation

Stack technique
python
Domaine
observability
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

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