Package io.opentelemetry.sdk.metrics.export

Interface MetricExporter

All Superinterfaces:

AutoCloseable, Closeable

public interface MetricExporter
extends Closeable

MetricExporter is the interface that all "push based" metric libraries should use to export metrics to the OpenTelemetry exporters.

All OpenTelemetry exporters should allow access to a MetricExporter instance.

Method Summary

Modifier and Type	Method	Description
static AggregationTemporality	alwaysCumulative(InstrumentType unused)	A common implementation of getAggregationTemporality(InstrumentType) which returns AggregationTemporality.CUMULATIVE for all instruments.
default void	close()	Closes this MetricExporter, releasing any resources.
static AggregationTemporality	deltaPreferred(InstrumentType instrumentType)	A common implementation of getAggregationTemporality(InstrumentType) which indicates delta preference.
io.opentelemetry.sdk.common.CompletableResultCode	export(Collection<MetricData> metrics)	Exports the collection of given MetricData.
io.opentelemetry.sdk.common.CompletableResultCode	flush()	Exports the collection of MetricData that have not yet been exported.
AggregationTemporality	getAggregationTemporality(InstrumentType instrumentType)	Return the default aggregation temporality for the InstrumentType.
io.opentelemetry.sdk.common.CompletableResultCode	shutdown()	Called when the associated IntervalMetricReader is shutdown.

Method Details

alwaysCumulative

static AggregationTemporality alwaysCumulative(InstrumentType unused)

A common implementation of getAggregationTemporality(InstrumentType) which returns AggregationTemporality.CUMULATIVE for all instruments.

deltaPreferred

static AggregationTemporality deltaPreferred(InstrumentType instrumentType)

A common implementation of getAggregationTemporality(InstrumentType) which indicates delta preference.

AggregationTemporality.DELTA is returned for InstrumentType.COUNTER, InstrumentType.OBSERVABLE_COUNTER, and InstrumentType.HISTOGRAM. AggregationTemporality.CUMULATIVE is returned for InstrumentType.UP_DOWN_COUNTER and InstrumentType.OBSERVABLE_UP_DOWN_COUNTER.

getAggregationTemporality

AggregationTemporality getAggregationTemporality(InstrumentType instrumentType)

Return the default aggregation temporality for the InstrumentType.

export

io.opentelemetry.sdk.common.CompletableResultCode export(Collection<MetricData> metrics)

Exports the collection of given MetricData. Note that export operations can be performed simultaneously depending on the type of metric reader being used. However, the caller MUST ensure that only one export can occur at a time.

Parameters:

metrics - the collection of MetricData to be exported.

Returns:

the result of the export, which is often an asynchronous operation.

flush

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

Exports the collection of MetricData that have not yet been exported. Note that flush operations can be performed simultaneously depending on the type of metric reader being used. However, the caller MUST ensure that only one export can occur at a time.

Returns:

the result of the flush, which is often an asynchronous operation.

shutdown

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

Called when the associated IntervalMetricReader is shutdown.

Returns:

a CompletableResultCode which is completed when shutdown completes.

close

default void close()

Closes this MetricExporter, releasing any resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable