prometheus / prometheus/client_java
OpenTelemetry bridge: classic histograms exported with +Inf boundary included, violating counts == boundaries + 1 contract
Personne n'a encore pris cette issue.
- Langage dominant
- Java
- Étoiles
- 2.3k
- Forks
- 833
- Merge moyen
- 2 j 16 h
- PR mergées (30 j)
- 86
Description
Summary
PrometheusClassicHistogram.toOtelDataPoint() converts a Prometheus classic histogram into an OpenTelemetry HistogramPointData, but it passes the Prometheus bucket boundaries including the final +Inf boundary and emits exactly one count per boundary. The OpenTelemetry data model requires counts.size() == boundaries.size() + 1, with boundaries containing only finite values (the last, +Inf bucket is implicit). The converted point therefore violates the OTel contract that downstream consumers rely on.
Static-analysis finding against current master; not executed here.
Location
- File:
prometheus-metrics-exporter-opentelemetry/src/main/java/io/prometheus/metrics/exporter/opentelemetry/otelmodel/PrometheusClassicHistogram.java - Methods:
makeBoundaries(ClassicHistogramBuckets)(~lines 66-72) andmakeCounts(ClassicHistogramBuckets)(~lines 74-80), called fromtoOtelDataPoint()(~lines 45-58).
Problem
makeBoundaries() iterates all classic buckets and appends every upper bound - for a Prometheus classic histogram the last bucket's upper bound is Double.POSITIVE_INFINITY, so +Inf ends up inside HistogramPointData.getBoundaries(). makeCounts() returns buckets.size() counts, i.e. counts.size() == boundaries.size().
Per the OTel SDK data model (io.opentelemetry.sdk.metrics.data.HistogramPointData), boundaries are the finite bucket edges and there is always one extra count for the implicit last bucket:
getCounts().size() == getBoundaries().size() + 1- boundaries must be finite (
Double.POSITIVE_INFINITYis not a legal explicit bound; the OTLPexplicit_boundsfield likewise expects finite values)
Concretely, a Prometheus histogram with bounds [1, 5, +Inf] and counts [c0, c1, c2] is converted to:
- boundaries
[1.0, 5.0, Infinity] - counts
[c0, c1, c2]
An OTel consumer reading this point interprets it as four buckets: [..,1], [1,5], [5,+Inf] (count c2) plus an implicit trailing (+Inf) bucket with count 0 - misrepresenting both bucket structure and totals. Anything that validates the model (or the OTLP exporter's serialization of infinite explicit bounds) will reject or distort the histogram instead of exporting it faithfully.
Trigger / Reproduction
Based on static analysis; no runtime run was performed:
- Expose any classic histogram through
PrometheusMetricsExporterwith the OpenTelemetry bridge enabled (MetricDataFactoryline ~73 constructsPrometheusClassicHistogramwhenever the snapshot has classic histogram data). - Observe the resulting
HistogramPointData:getBoundaries().contains(Double.POSITIVE_INFINITY)andgetCounts().size() == getBoundaries().size().
Expected Behavior
The conversion should drop the final +Inf upper bound from boundaries and append the total observation count as the extra last element of counts (the implicit overflow bucket), e.g. boundaries [1.0, 5.0], counts [c0, c1, c0+c1+c2]. (calculateCount() already computes this sum when the snapshot lacks an explicit count.)
Actual Behavior
+Inf remains in the boundary list and no implicit-bucket count is appended, producing an out-of-contract HistogramPointData.
Impact
Every classic histogram exported through the OpenTelemetry bridge carries malformed bucket metadata: OTLP exports can fail validation or silently shift all bucket assignments, and aggregation logic built on the OTel model (e.g., heatmap rendering, downstream collectors) computes wrong distributions.
Suggested Direction
In toOtelDataPoint() (or in the two helpers), strip the trailing +Inf boundary when present and build counts as the per-boundary counts followed by the total count. Keeping the helpers symmetric (boundaries.size() == counts.size() - 1) would make the invariant locally verifiable.
Evidence
PrometheusClassicHistogram.makeBoundaries(): unconditionalbuckets.getUpperBound(i)loop;ClassicHistogramBucketssnapshots from the core module always end with+Inffor classic histograms.MetricDataFactory.javaline ~73: result is fed directly into the OTelMetricDatatree consumed by the exporter pipeline.
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 dans prometheus-metrics-exporter-opentelemetry/src/main/java/io/prometheus/metrics/exporter/opentelemetry/otelmodel/PrometheusClassicHistogram.java, en lisant toOtelDataPoint(), makeBoundaries() et makeCounts(); suivez ensuite MetricDataFactory.java pour comprendre le point d’entrée. Vérifiez que la HistogramPointData résultante ne contient que des bornes finies et que counts.size() == boundaries.size() + 1, le dernier compte représentant le bucket de dépassement implicite.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- java
- Domaine
- observability
- Type d'issue
- Bug
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- Active
- Clarté
- Clairement spécifiée
- Accessibilité débutants
- 82/100