PrometheusHttpServer (OpenTelemetry Prometheus Exporter)

java.lang.Object

io.opentelemetry.exporter.prometheus.PrometheusHttpServer

All Implemented Interfaces:: io.opentelemetry.sdk.metrics.export.MetricReader, Closeable, AutoCloseable

public final class PrometheusHttpServer extends Object implements Closeable, io.opentelemetry.sdk.metrics.export.MetricReader

A MetricReader that starts an HTTP server that will collect metrics and serialize to Prometheus text format on request.

Method Summary

Modifier and Type

Method

Description

static PrometheusHttpServerBuilder

builder()

Returns a new PrometheusHttpServerBuilder.

void

close()

static PrometheusHttpServer

create()

Returns a new PrometheusHttpServer which can be registered to an SdkMeterProvider to expose Prometheus metrics on port 9464.

io.opentelemetry.sdk.common.CompletableResultCode

flush()

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

Method Details
- create
  
  public static PrometheusHttpServer create()
  
  Returns a new PrometheusHttpServer which can be registered to an SdkMeterProvider to expose Prometheus metrics on port 9464.
- builder
  
  public static PrometheusHttpServerBuilder builder()
  
  Returns a new PrometheusHttpServerBuilder.
- 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.MetricReader
- flush
  
  public io.opentelemetry.sdk.common.CompletableResultCode flush()
  
  Specified by:
  
  flush 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
- close
  
  public void close()
  
  Specified by:
  
  close in interface AutoCloseable
  
  Specified by:
  
  close in interface Closeable