Package io.opentelemetry.sdk.testing.exporter

Class InMemoryMetricExporter

java.lang.Object

io.opentelemetry.sdk.testing.exporter.InMemoryMetricExporter

All Implemented Interfaces:

io.opentelemetry.sdk.metrics.export.AggregationTemporalitySelector, io.opentelemetry.sdk.metrics.export.DefaultAggregationSelector, io.opentelemetry.sdk.metrics.export.MetricExporter, Closeable, AutoCloseable

public final class InMemoryMetricExporter
extends Object
implements io.opentelemetry.sdk.metrics.export.MetricExporter

A MetricExporter implementation that can be used to test OpenTelemetry integration.

Can be created using InMemoryMetricExporter.create()

Example usage:

 public class InMemoryMetricExporterExample {

   // creating InMemoryMetricExporter
   private final InMemoryMetricExporter exporter = InMemoryMetricExporter.create();
   private final MeterSdkProvider meterSdkProvider = OpenTelemetrySdk.getMeterProvider();
   private final Meter meter = meterSdkProvider.get("InMemoryMetricExporterExample");
   private IntervalMetricReader intervalMetricReader;

   void setup() {
     intervalMetricReader =
         IntervalMetricReader.builder()
             .setMetricExporter(exporter)
             .setMetricProducers(Collections.singletonList(meterSdkProvider.getMetricProducer()))
             .setExportIntervalMillis(1000)
             .build();
   }

   LongCounter generateLongCounterMeter(String name) {
     return meter.longCounterBuilder(name).setDescription("Sample LongCounter").build();
   }

   public static void main(String[] args) throws InterruptedException {
     InMemoryMetricExporterExample example = new InMemoryMetricExporterExample();
     example.setup();
     example.generateLongCounterMeter("counter-1");
   }
 }
 

Since:

1.14.0

Method Summary

Modifier and Type	Method	Description
static InMemoryMetricExporter	create()	Returns a new InMemoryMetricExporter with a aggregation temporality of AggregationTemporality.CUMULATIVE.
static InMemoryMetricExporter	create(io.opentelemetry.sdk.metrics.data.AggregationTemporality aggregationTemporality)	Returns a new InMemoryMetricExporter with the given aggregationTemporality.
io.opentelemetry.sdk.common.CompletableResultCode	export(Collection<io.opentelemetry.sdk.metrics.data.MetricData> metrics)	Exports the collection of Metrics into the inmemory queue.
io.opentelemetry.sdk.common.CompletableResultCode	flush()	The InMemory exporter does not batch metrics, so this method will immediately return with success.
io.opentelemetry.sdk.metrics.data.AggregationTemporality	getAggregationTemporality(io.opentelemetry.sdk.metrics.InstrumentType instrumentType)
List<io.opentelemetry.sdk.metrics.data.MetricData>	getFinishedMetricItems()	Returns a List of the finished Metrics, represented by MetricData.
void	reset()	Clears the internal List of finished Metrics.
io.opentelemetry.sdk.common.CompletableResultCode	shutdown()	Clears the internal List of finished Metrics.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.opentelemetry.sdk.metrics.export.DefaultAggregationSelector

with

Methods inherited from interface io.opentelemetry.sdk.metrics.export.MetricExporter

close, getDefaultAggregation, getMemoryMode

Method Details

create

public static InMemoryMetricExporter create()

Returns a new InMemoryMetricExporter with a aggregation temporality of AggregationTemporality.CUMULATIVE.

create

public static InMemoryMetricExporter create(io.opentelemetry.sdk.metrics.data.AggregationTemporality aggregationTemporality)

Returns a new InMemoryMetricExporter with the given aggregationTemporality.

getFinishedMetricItems

public List<io.opentelemetry.sdk.metrics.data.MetricData> getFinishedMetricItems()

Returns a List of the finished Metrics, represented by MetricData.

Returns:

a List of the finished Metrics.

reset

public void reset()

Clears the internal List of finished Metrics.

Does not reset the state of this exporter if already shutdown.

getAggregationTemporality

public io.opentelemetry.sdk.metrics.data.AggregationTemporality getAggregationTemporality(io.opentelemetry.sdk.metrics.InstrumentType instrumentType)

Specified by:

getAggregationTemporality in interface io.opentelemetry.sdk.metrics.export.AggregationTemporalitySelector

export

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

Exports the collection of Metrics into the inmemory queue.

If this is called after shutdown, this will return ResultCode.FAILURE.

Specified by:

export in interface io.opentelemetry.sdk.metrics.export.MetricExporter

flush

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

The InMemory exporter does not batch metrics, so this method will immediately return with success.

Specified by:

flush in interface io.opentelemetry.sdk.metrics.export.MetricExporter

Returns:

always Success

shutdown

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

Clears the internal List of finished Metrics.

Any subsequent call to export() function on this MetricExporter, will return CompletableResultCode.ofFailure()

Specified by:

shutdown in interface io.opentelemetry.sdk.metrics.export.MetricExporter