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

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.
io.opentelemetry.sdk.common.CompletableResultCode	flush()	Flushes metrics read by this reader.
AggregationTemporality	getPreferredTemporality()	Return The preferred temporality for metrics.
static MetricReaderFactory	newMetricReaderFactory(MetricExporter exporter)	Returns a new MetricReaderFactory 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	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

newMetricReaderFactory

public static MetricReaderFactory newMetricReaderFactory(MetricExporter exporter)

Returns a new MetricReaderFactory 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.

getPreferredTemporality

@Nullable
public AggregationTemporality getPreferredTemporality()

Description copied from interface: MetricReader

Return The preferred temporality for metrics.

Specified by:

getPreferredTemporality 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 associated MetricProducer should have its MetricProducer.collectAllMetrics() method called.

For push endpoints, this should collect and report metrics as normal.

Specified by:

flush in interface MetricReader

Returns:

the result of the shutdown.

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.