Class OtlpGrpcMetricExporter
java.lang.Object
io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter
- All Implemented Interfaces:
AggregationTemporalitySelector
,DefaultAggregationSelector
,MetricExporter
,Closeable
,AutoCloseable
Exports metrics using OTLP via gRPC, using OpenTelemetry's protobuf model.
- Since:
- 1.14.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final AggregationTemporalitySelector
private final GrpcExporterBuilder
<Marshaler> private final DefaultAggregationSelector
private final GrpcExporter
<Marshaler> private final MetricReusableDataMarshaler
-
Constructor Summary
ConstructorsConstructorDescriptionOtlpGrpcMetricExporter
(GrpcExporterBuilder<Marshaler> builder, GrpcExporter<Marshaler> delegate, AggregationTemporalitySelector aggregationTemporalitySelector, DefaultAggregationSelector defaultAggregationSelector, MemoryMode memoryMode) -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Returns a new builder instance for this exporter.export
(Collection<MetricData> metrics) Submits all the given metrics in a single batch to the OpenTelemetry collector.flush()
The OTLP exporter does not batch metrics, so this method will immediately return with success.getAggregationTemporality
(InstrumentType instrumentType) Return the aggregation temporality for theInstrumentType
.static OtlpGrpcMetricExporter
Returns a newOtlpGrpcMetricExporter
using the default values.getDefaultAggregation
(InstrumentType instrumentType) Return the default aggregation for theInstrumentType
.Returns the memory mode used by this exporter's associated reader.shutdown()
Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately cancelled.Returns a builder with configuration values equal to those for this exporter.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 Details
-
builder
-
delegate
-
aggregationTemporalitySelector
-
defaultAggregationSelector
-
marshaler
-
-
Constructor Details
-
OtlpGrpcMetricExporter
OtlpGrpcMetricExporter(GrpcExporterBuilder<Marshaler> builder, GrpcExporter<Marshaler> delegate, AggregationTemporalitySelector aggregationTemporalitySelector, DefaultAggregationSelector defaultAggregationSelector, MemoryMode memoryMode)
-
-
Method Details
-
getDefault
Returns a newOtlpGrpcMetricExporter
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
Returns a new builder instance for this exporter.- Returns:
- a new builder instance for this exporter.
-
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
Description copied from interface:AggregationTemporalitySelector
Return the aggregation temporality for theInstrumentType
.- Specified by:
getAggregationTemporality
in interfaceAggregationTemporalitySelector
-
getDefaultAggregation
Description copied from interface:MetricExporter
Return the default aggregation for theInstrumentType
.- Specified by:
getDefaultAggregation
in interfaceDefaultAggregationSelector
- Specified by:
getDefaultAggregation
in interfaceMetricExporter
- See Also:
-
getMemoryMode
Description copied from interface:MetricExporter
Returns the memory mode used by this exporter's associated reader.- Specified by:
getMemoryMode
in interfaceMetricExporter
- Returns:
- The
MemoryMode
used by this exporter's associated reader
-
export
Submits all the given metrics in a single batch to the OpenTelemetry collector.- Specified by:
export
in interfaceMetricExporter
- Parameters:
metrics
- the list of Metrics to be exported.- Returns:
- the result of the operation
-
flush
The OTLP exporter does not batch metrics, so this method will immediately return with success.- Specified by:
flush
in interfaceMetricExporter
- Returns:
- always Success
-
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 interfaceMetricExporter
- Returns:
- a
CompletableResultCode
which is completed when shutdown completes.
-
toString
-