Class PeriodicMetricReader

java.lang.Object

io.opentelemetry.sdk.metrics.export.PeriodicMetricReader

All Implemented Interfaces:

AggregationTemporalitySelector, DefaultAggregationSelector, MetricReader, Closeable, AutoCloseable

public final class PeriodicMetricReader
extends Object
implements MetricReader

A MetricReader which wraps a MetricExporter and automatically reads and exports the metrics every export interval.

Register with SdkMeterProvider via SdkMeterProviderBuilder.registerMetricReader(MetricReader).

Since:

1.14.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private final class	PeriodicMetricReader.Scheduled

Field Summary

Fields

Modifier and Type	Field	Description
private CollectionRegistration	collectionRegistration
private final MetricExporter	exporter
private final long	intervalNanos
private final Object	lock
private static final Logger	logger
private final PeriodicMetricReader.Scheduled	scheduled
private ScheduledFuture<?>	scheduledFuture
private final ScheduledExecutorService	scheduler

Constructor Summary

Constructors

Constructor	Description
PeriodicMetricReader(MetricExporter exporter, long intervalNanos, ScheduledExecutorService scheduler)

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 exports to the exporter once every minute.
CompletableResultCode	forceFlush()	Read and export the metrics.
AggregationTemporality	getAggregationTemporality(InstrumentType instrumentType)	Return the aggregation temporality for the InstrumentType.
Aggregation	getDefaultAggregation(InstrumentType instrumentType)	Return the default aggregation for the InstrumentType.
MemoryMode	getMemoryMode()	Returns the memory mode used by this reader.
void	register(CollectionRegistration collectionRegistration)	Called by SdkMeterProvider on initialization to supply the MetricReader with MetricProducers used to collect metrics.
CompletableResultCode	shutdown()	Shuts down the metric reader.
(package private) void	start()
String	toString()

Methods inherited from class Object

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

Methods inherited from interface DefaultAggregationSelector

with

Methods inherited from interface MetricReader

close

Field Details

logger

private static final Logger logger

exporter

private final MetricExporter exporter

intervalNanos

private final long intervalNanos

scheduler

private final ScheduledExecutorService scheduler

scheduled

private final PeriodicMetricReader.Scheduled scheduled

lock

private final Object lock

collectionRegistration

private volatile CollectionRegistration collectionRegistration

scheduledFuture

@Nullable
private volatile ScheduledFuture<?> scheduledFuture

Constructor Details

PeriodicMetricReader

PeriodicMetricReader(MetricExporter exporter,
 long intervalNanos,
 ScheduledExecutorService scheduler)

Method Details

create

public static PeriodicMetricReader create(MetricExporter exporter)

Returns a new PeriodicMetricReader which exports to the exporter once every minute.

builder

public static PeriodicMetricReaderBuilder builder(MetricExporter exporter)

Returns a new PeriodicMetricReaderBuilder.

getAggregationTemporality

public AggregationTemporality getAggregationTemporality(InstrumentType instrumentType)

Description copied from interface: AggregationTemporalitySelector

Return the aggregation temporality for the InstrumentType.

Specified by:

getAggregationTemporality in interface AggregationTemporalitySelector

getDefaultAggregation

public Aggregation getDefaultAggregation(InstrumentType instrumentType)

Description copied from interface: MetricReader

Return the default aggregation for the InstrumentType.

Specified by:

getDefaultAggregation in interface DefaultAggregationSelector

Specified by:

getDefaultAggregation in interface MetricReader

See Also:

• DefaultAggregationSelector.getDefaultAggregation(InstrumentType)

getMemoryMode

public MemoryMode getMemoryMode()

Description copied from interface: MetricReader

Returns the memory mode used by this reader.

Specified by:

getMemoryMode in interface MetricReader

Returns:

The MemoryMode used by this instance

forceFlush

public CompletableResultCode forceFlush()

Description copied from interface: MetricReader

Read and export the metrics.

Called when SdkMeterProvider.forceFlush() is called.

Specified by:

forceFlush in interface MetricReader

Returns:

the result of the flush.

shutdown

public CompletableResultCode shutdown()

Description copied from interface: MetricReader

Shuts down the metric reader.

Called when SdkMeterProvider.shutdown() is called.

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

For push based readers like MetricExporter, this should shut down any scheduler threads.

Specified by:

shutdown in interface MetricReader

Returns:

the result of the shutdown.

register

public void register(CollectionRegistration collectionRegistration)

Description copied from interface: MetricReader

Called by SdkMeterProvider on initialization to supply the MetricReader with MetricProducers used to collect metrics. MetricReader implementations call CollectionRegistration.collectAllMetrics() to read metrics.

Specified by:

register in interface MetricReader

toString

public String toString()

Overrides:

toString in class Object

start

void start()