Package io.opentelemetry.sdk.metrics.export

Class PeriodicMetricReader

java.lang.Object

io.opentelemetry.sdk.metrics.export.PeriodicMetricReader

All Implemented Interfaces:

MetricReader

public final class PeriodicMetricReader
extends Object
implements MetricReader

A MetricReader which wraps a MetricExporter and automatically reads and exports the metrics every export interval. Metrics may also be dropped when it becomes time to export again, and there is an export in progress.

Method Summary

Modifier and Type	Method	Description
static PeriodicMetricReaderBuilder	builder(MetricExporter exporter)	Returns a new PeriodicMetricReaderBuilder.
static PeriodicMetricReader	create(MetricExporter exporter)	Returns a new PeriodicMetricReader which can be registered to a SdkMeterProvider to start a PeriodicMetricReader exporting once every minute on a new daemon thread.
io.opentelemetry.sdk.common.CompletableResultCode	flush()	Flushes metrics read by this reader.
AggregationTemporality	getAggregationTemporality(InstrumentType instrumentType)	Return the default aggregation temporality for the InstrumentType.
void	register(CollectionRegistration registration)	Called by SdkMeterProvider and supplies the MetricReader with a handle to collect metrics.
io.opentelemetry.sdk.common.CompletableResultCode	shutdown()	Shuts down the metric reader.

Methods inherited from class java.lang.Object

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

Method Details

create

public static PeriodicMetricReader create(MetricExporter exporter)

Returns a new PeriodicMetricReader which can be registered to a SdkMeterProvider to start a PeriodicMetricReader exporting once every minute on a new daemon thread.

builder

public static PeriodicMetricReaderBuilder builder(MetricExporter exporter)

Returns a new PeriodicMetricReaderBuilder.

getAggregationTemporality

public AggregationTemporality getAggregationTemporality(InstrumentType instrumentType)

Description copied from interface: MetricReader

Return the default aggregation temporality for the InstrumentType.

Specified by:

getAggregationTemporality in interface MetricReader

flush

public io.opentelemetry.sdk.common.CompletableResultCode flush()

Description copied from interface: MetricReader

Flushes metrics read by this reader.

In all scenarios, the trigger a metrics collection.

For readers associated with push MetricExporters, this should MetricExporter.export(Collection) the collected metrics.

Specified by:

flush in interface MetricReader

Returns:

the result of the flush.

shutdown

public io.opentelemetry.sdk.common.CompletableResultCode shutdown()

Description copied from interface: MetricReader

Shuts down the metric reader.

For pull endpoints, like prometheus, this should shut down the metric hosting endpoint or server doing such a job.

For push endpoints, this should shut down any scheduler threads.

Specified by:

shutdown in interface MetricReader

Returns:

the result of the shutdown.

register

public void register(CollectionRegistration registration)

Description copied from interface: MetricReader

Called by SdkMeterProvider and supplies the MetricReader with a handle to collect metrics.

CollectionRegistration is currently an empty interface because custom implementations of MetricReader are not currently supported.

Specified by:

register in interface MetricReader