Interface MetricExporter
-
- All Known Implementing Classes:
InMemoryMetricExporter
public interface MetricExporterMetricExporteris 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
MetricExporterinstance.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description io.opentelemetry.sdk.common.CompletableResultCodeexport(Collection<MetricData> metrics)Exports the collection of givenMetricData.io.opentelemetry.sdk.common.CompletableResultCodeflush()Exports the collection ofMetricDatathat have not yet been exported.io.opentelemetry.sdk.common.CompletableResultCodeshutdown()Called when the associated IntervalMetricReader is shutdown.
-
-
-
Method Detail
-
export
io.opentelemetry.sdk.common.CompletableResultCode export(Collection<MetricData> metrics)
Exports the collection of givenMetricData. Note that export operations can be performed simultaneously depending on the type of metric reader being used. However, theIntervalMetricReaderwill ensure that only one export can occur at a time.- Parameters:
metrics- the collection ofMetricDatato be exported.- Returns:
- the result of the export, which is often an asynchronous operation.
-
flush
io.opentelemetry.sdk.common.CompletableResultCode flush()
Exports the collection ofMetricDatathat have not yet been exported. Note that flush operations can be performed simultaneously depending on the type of metric reader being used. However, theIntervalMetricReaderwill 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
CompletableResultCodewhich is completed when shutdown completes.
-
-