Package io.opentelemetry.exporter.otlp.metrics

Class OtlpGrpcMetricExporter

java.lang.Object

io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter

All Implemented Interfaces:

AggregationTemporalitySelector, DefaultAggregationSelector, MetricExporter, java.io.Closeable, java.lang.AutoCloseable

@ThreadSafe
public final class OtlpGrpcMetricExporter
extends java.lang.Object
implements MetricExporter

Exports metrics using OTLP via gRPC, using OpenTelemetry's protobuf model.

Since:

1.14.0

Field Summary

Fields

Modifier and Type	Field	Description
private AggregationTemporalitySelector	aggregationTemporalitySelector
private GrpcExporterBuilder<Marshaler>	builder
private DefaultAggregationSelector	defaultAggregationSelector
private GrpcExporter<Marshaler>	delegate
private MetricReusableDataMarshaler	marshaler

Constructor Summary

Constructors

Constructor	Description
OtlpGrpcMetricExporter(GrpcExporterBuilder<Marshaler> builder, GrpcExporter<Marshaler> delegate, AggregationTemporalitySelector aggregationTemporalitySelector, DefaultAggregationSelector defaultAggregationSelector, MemoryMode memoryMode)

Method Summary

Modifier and Type	Method	Description
static OtlpGrpcMetricExporterBuilder	builder()	Returns a new builder instance for this exporter.
CompletableResultCode	export(java.util.Collection<MetricData> metrics)	Submits all the given metrics in a single batch to the OpenTelemetry collector.
CompletableResultCode	flush()	The OTLP exporter does not batch metrics, so this method will immediately return with success.
AggregationTemporality	getAggregationTemporality(InstrumentType instrumentType)	Return the aggregation temporality for the InstrumentType.
static OtlpGrpcMetricExporter	getDefault()	Returns a new OtlpGrpcMetricExporter using the default values.
Aggregation	getDefaultAggregation(InstrumentType instrumentType)	Return the default aggregation for the InstrumentType.
MemoryMode	getMemoryMode()	Returns the memory mode used by this exporter's associated reader.
CompletableResultCode	shutdown()	Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately cancelled.
OtlpGrpcMetricExporterBuilder	toBuilder()	Returns a builder with configuration values equal to those for this exporter.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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

Field Detail

builder

private final GrpcExporterBuilder<Marshaler> builder

delegate

private final GrpcExporter<Marshaler> delegate

aggregationTemporalitySelector

private final AggregationTemporalitySelector aggregationTemporalitySelector

defaultAggregationSelector

private final DefaultAggregationSelector defaultAggregationSelector

marshaler

private final MetricReusableDataMarshaler marshaler

Constructor Detail

OtlpGrpcMetricExporter

OtlpGrpcMetricExporter(GrpcExporterBuilder<Marshaler> builder,
                       GrpcExporter<Marshaler> delegate,
                       AggregationTemporalitySelector aggregationTemporalitySelector,
                       DefaultAggregationSelector defaultAggregationSelector,
                       MemoryMode memoryMode)

Method Detail

getDefault

public static OtlpGrpcMetricExporter getDefault()

Returns a new OtlpGrpcMetricExporter using the default values.

To load configuration values from environment variables and system properties, use opentelemetry-sdk-extension-autoconfigure.

Returns:

a new OtlpGrpcMetricExporter instance.

builder

public static OtlpGrpcMetricExporterBuilder builder()

Returns a new builder instance for this exporter.

Returns:

a new builder instance for this exporter.

toBuilder

public OtlpGrpcMetricExporterBuilder toBuilder()

Returns a builder with configuration values equal to those for this exporter.

IMPORTANT: Be sure to shutdown() this instance if it will no longer be used.

Since:

1.29.0

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: MetricExporter

Return the default aggregation for the InstrumentType.

Specified by:

getDefaultAggregation in interface DefaultAggregationSelector

Specified by:

getDefaultAggregation in interface MetricExporter

See Also:

DefaultAggregationSelector.getDefaultAggregation(InstrumentType)

getMemoryMode

public MemoryMode getMemoryMode()

Description copied from interface: MetricExporter

Returns the memory mode used by this exporter's associated reader.

Specified by:

getMemoryMode in interface MetricExporter

Returns:

The MemoryMode used by this exporter's associated reader

export

public CompletableResultCode export(java.util.Collection<MetricData> metrics)

Submits all the given metrics in a single batch to the OpenTelemetry collector.

Specified by:

export in interface MetricExporter

Parameters:

metrics - the list of Metrics to be exported.

Returns:

the result of the operation

flush

public CompletableResultCode flush()

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

Specified by:

flush in interface MetricExporter

Returns:

always Success

shutdown

public CompletableResultCode shutdown()

Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately cancelled. The channel is forcefully closed after a timeout.

Specified by:

shutdown in interface MetricExporter

Returns:

a CompletableResultCode which is completed when shutdown completes.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object