io.opentelemetry.exporter.prometheus.PrometheusMetricReader Maven / Gradle / Ivy

Go to download
/*
 * Copyright The OpenTelemetry Authors
 * SPDX-License-Identifier: Apache-2.0
 */

package io.opentelemetry.exporter.prometheus;

import io.opentelemetry.sdk.common.CompletableResultCode;
import io.opentelemetry.sdk.metrics.InstrumentType;
import io.opentelemetry.sdk.metrics.data.AggregationTemporality;
import io.opentelemetry.sdk.metrics.export.CollectionRegistration;
import io.opentelemetry.sdk.metrics.export.MetricReader;
import io.prometheus.metrics.model.registry.MultiCollector;
import io.prometheus.metrics.model.snapshots.MetricSnapshots;
import java.util.function.Predicate;
import javax.annotation.Nullable;

/**
 * This is the bridge between Prometheus and OpenTelemetry.
 *
 * The {@link PrometheusMetricReader} is a Prometheus {@link MultiCollector} and can be
 * registered with the {@link io.prometheus.metrics.model.registry.PrometheusRegistry
 * PrometheusRegistry}. It's also an OpenTelemetry {@link MetricReader} and can be registered with a
 * {@link io.opentelemetry.sdk.metrics.SdkMeterProvider SdkMeterProvider}.
 */
public class PrometheusMetricReader implements MetricReader, MultiCollector {

  private volatile CollectionRegistration collectionRegistration = CollectionRegistration.noop();
  private final Otel2PrometheusConverter converter;

  // TODO: refactor to public static create or builder pattern to align with project style
  /** See {@link Otel2PrometheusConverter#Otel2PrometheusConverter(boolean, Predicate)}. */
  public PrometheusMetricReader(
      boolean otelScopeEnabled, @Nullable Predicate allowedResourceAttributesFilter) {
    this.converter =
        new Otel2PrometheusConverter(otelScopeEnabled, allowedResourceAttributesFilter);
  }

  @Override
  public AggregationTemporality getAggregationTemporality(InstrumentType instrumentType) {
    return AggregationTemporality.CUMULATIVE;
  }

  @Override
  public void register(CollectionRegistration registration) {
    this.collectionRegistration = registration;
  }

  @Override
  public CompletableResultCode forceFlush() {
    return CompletableResultCode.ofSuccess();
  }

  @Override
  public CompletableResultCode shutdown() {
    return CompletableResultCode.ofSuccess();
  }

  @Override
  public MetricSnapshots collect() {
    return converter.convert(collectionRegistration.collectAllMetrics());
  }
}