Package io.opentelemetry.contrib.metrics.prometheus.clientbridge

Class PrometheusCollector

java.lang.Object
io.opentelemetry.contrib.metrics.prometheus.clientbridge.PrometheusCollector
All Implemented Interfaces:
io.opentelemetry.sdk.metrics.export.AggregationTemporalitySelector, io.opentelemetry.sdk.metrics.export.DefaultAggregationSelector, io.opentelemetry.sdk.metrics.export.MetricReader, Closeable, AutoCloseable
public final class PrometheusCollector extends Object implements io.opentelemetry.sdk.metrics.export.MetricReader
A reader of OpenTelemetry metrics that exports into Prometheus as a Collector.

Usage: sdkMeterProvider.registerMetricReader(PrometheusCollector.create());

  • Method Summary

    Modifier and Type
    Method
    Description
    static PrometheusCollector
    create()
    Returns a new PrometheusCollector to be registered with a SdkMeterProviderBuilder.
    io.opentelemetry.sdk.common.CompletableResultCode
    forceFlush()
     
    io.opentelemetry.sdk.metrics.data.AggregationTemporality
    getAggregationTemporality(io.opentelemetry.sdk.metrics.InstrumentType instrumentType)
     
    void
    register(io.opentelemetry.sdk.metrics.export.CollectionRegistration registration)
     
    io.opentelemetry.sdk.common.CompletableResultCode
    shutdown()
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface io.opentelemetry.sdk.metrics.export.DefaultAggregationSelector

    with

    Methods inherited from interface io.opentelemetry.sdk.metrics.export.MetricReader

    close, getDefaultAggregation, getMemoryMode

  • Method Details

    • create

      public static PrometheusCollector create()
      Returns a new PrometheusCollector to be registered with a SdkMeterProviderBuilder.

    • register

      public void register(io.opentelemetry.sdk.metrics.export.CollectionRegistration registration)
      Specified by:
      register in interface io.opentelemetry.sdk.metrics.export.MetricReader

    • getAggregationTemporality

      public io.opentelemetry.sdk.metrics.data.AggregationTemporality getAggregationTemporality(io.opentelemetry.sdk.metrics.InstrumentType instrumentType)
      Specified by:
      getAggregationTemporality in interface io.opentelemetry.sdk.metrics.export.AggregationTemporalitySelector

    • forceFlush

      public io.opentelemetry.sdk.common.CompletableResultCode forceFlush()
      Specified by:
      forceFlush in interface io.opentelemetry.sdk.metrics.export.MetricReader

    • shutdown

      public io.opentelemetry.sdk.common.CompletableResultCode shutdown()
      Specified by:
      shutdown in interface io.opentelemetry.sdk.metrics.export.MetricReader