prometheus / prometheus/client_python
Metric without `labelnames` causes issues in when MULTIPROC is enabled
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 4.4k
- Forks
- 876
- Ø Merge
- 8 T. 4 Std.
- Gemergte PRs (30 T.)
- 1
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, das Single-Process-Setup mit Threads und aktiviertem PROMETHEUS_MULTIPROC_DIR zu reproduzieren, und vergleiche Metriken, die mit bzw. ohne labelnames definiert wurden. Beobachte die Metrikinitialisierung, die erstellten Datenbankdateien und die Expositionsausgabe, und verfolge anschließend die beteiligte Multiprocess-Verarbeitung. Als abgeschlossen gilt die Untersuchung, wenn das Verhalten verstanden ist und Metriken konsistent ausgegeben werden, mit einer klaren Entscheidung darüber, ob fehlende labelnames validiert werden sollen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- observability-sre
- Issue-Typ
- Bug
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100