io.opentelemetry.sdk.metrics.export

Class IntervalMetricReader

java.lang.Object

io.opentelemetry.sdk.metrics.export.IntervalMetricReader

public final class IntervalMetricReader
extends Object

Wraps a list of MetricProducers and automatically reads and exports the metrics every export interval.

Configuration options for IntervalMetricReader can be read from system properties, environment variables, or Properties objects.

For system properties and Properties objects, IntervalMetricReader will look for the following names:

• otel.imr.export.interval: sets the export interval between pushes to the exporter.

For environment variables, IntervalMetricReader will look for the following names:

• OTEL_IMR_EXPORT_INTERVAL: sets the export interval between pushes to the exporter.

Since:

0.3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IntervalMetricReader.Builder Builder for IntervalMetricReader.

Method Summary

Modifier and Type	Method and Description
static IntervalMetricReader.Builder	builder() Returns a new IntervalMetricReader.Builder for IntervalMetricReader.
static IntervalMetricReader.Builder	builderFromDefaultSources() Returns a new IntervalMetricReader.Builder for IntervalMetricReader reading the configuration values from the environment and from system properties.
void	shutdown() Stops the scheduled task and calls export one more time.

Methods inherited from class java.lang.Object

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

Method Detail

shutdown

public void shutdown()

Stops the scheduled task and calls export one more time.

Since:

0.3.0

builder

public static IntervalMetricReader.Builder builder()

Returns a new IntervalMetricReader.Builder for IntervalMetricReader.

Returns:

a new IntervalMetricReader.Builder for IntervalMetricReader.

builderFromDefaultSources

public static IntervalMetricReader.Builder builderFromDefaultSources()

Returns a new IntervalMetricReader.Builder for IntervalMetricReader reading the configuration values from the environment and from system properties. System properties override values defined in the environment. If a configuration value is missing, it uses the default value.

Returns:

a new IntervalMetricReader.Builder for IntervalMetricReader.

Since:

0.4.0