prometheus / prometheus/client_python
Metric without `labelnames` causes issues in when MULTIPROC is enabled
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
Hello,
I noticed (see https://github.com/prometheus/client_python/issues/902#issuecomment-3013566209 for example ) that when
- having a metric defined without a label
- multiprocess mode is enabled (i.e.
PROMETHEUS_MULTIPROC_DIRis set ) - an app has a single process
then this causes issues, and some metrics will not be reported.
It's not exactly clear to me what is happening, but an indication that something is wrong is that a prometheus db file is created at load time (i.e. when metrics are defined, before they are set).
Here's what I have in more details:
Observations in a prod application:
- Some histogram metrics set in a threaded celery worker where
PROMETHEUS_MULTIPROC_DIRare not reported - No such issue in pre-fork workers
- The issue was resolved by adding the
labelnamesargument to a metric where it was missing (which was an histogram as well)
Other observations:
- When starting the app, a prom db file is created for the metric that was missing labelnames (before any measurement is made)
Hypothesis:
- in a celery worker in pre-fork mode, the process creating the first db file is not the same process were metrics are set afterwards, so there is no "collision" (because of the pid suffix)
- in a celery worker in threaded mode, there is a single process creating the first db file and setting the metrics, and somehow collisions happens and some metrics are not reported
Values set at startup:
$ curl localhost:8000
# HELP test_histogram_no_label test Histogram
# TYPE test_histogram_no_label histogram
test_histogram_no_label_sum 0.0
test_histogram_no_label_bucket{le="1.0"} 0.0
test_histogram_no_label_bucket{le="2.0"} 0.0
test_histogram_no_label_bucket{le="+Inf"} 0.0
test_histogram_no_label_count 0.0
It seems to me that a simple way to address this would be to raise when a metric is defined without labelnames, as labelnames are mandatory anyway.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par reproduire la configuration à processus unique avec threads et PROMETHEUS_MULTIPROC_DIR activé, puis comparez les métriques définies avec et sans labelnames. Observez l’initialisation des métriques, les fichiers de base de données créés et la sortie d’exposition, puis retracez le traitement multiprocessus impliqué. Le travail est terminé lorsque le comportement est compris et que les métriques sont rapportées de manière cohérente, avec une décision claire concernant la validation de labelnames manquants.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- observability-sre
- Type d'issue
- Bug
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100