Class OtlpGrpcMetricExporterBuilder
java.lang.Object
io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporterBuilder
Builder utility for this exporter.
- Since:
- 1.14.0
-
Method Summary
Modifier and TypeMethodDescriptionAdd header to request.build()
Constructs a new instance of the exporter based on the builder's values.setAggregationTemporalitySelector
(io.opentelemetry.sdk.metrics.export.AggregationTemporalitySelector aggregationTemporalitySelector) Set theAggregationTemporalitySelector
used forAggregationTemporalitySelector.getAggregationTemporality(InstrumentType)
.setChannel
(io.grpc.ManagedChannel channel) Deprecated.setClientTls
(byte[] privateKeyPem, byte[] certificatePem) Sets ths client key and the certificate chain to use for verifying client when TLS is enabled.setCompression
(String compressionMethod) Sets the method used to compress payloads.setDefaultAggregationSelector
(io.opentelemetry.sdk.metrics.export.DefaultAggregationSelector defaultAggregationSelector) Set theDefaultAggregationSelector
used forMetricExporter.getDefaultAggregation(InstrumentType)
.setEndpoint
(String endpoint) Sets the OTLP endpoint to connect to.setTimeout
(long timeout, TimeUnit unit) Sets the maximum time to wait for the collector to process an exported batch of metrics.setTimeout
(Duration timeout) Sets the maximum time to wait for the collector to process an exported batch of metrics.setTrustedCertificates
(byte[] trustedCertificatesPem) Sets the certificate chain to use for verifying servers when TLS is enabled.
-
Method Details
-
setChannel
Deprecated.UsesetEndpoint(String)
. If you have a use case not satisfied by the methods on this builder, please file an issue to let us know what it is.Sets the managed chanel to use when communicating with the backend. Takes precedence oversetEndpoint(String)
if both are called.- Parameters:
channel
- the channel to use- Returns:
- this builder's instance
-
setTimeout
Sets the maximum time to wait for the collector to process an exported batch of metrics. If unset, defaults to 10Ls. -
setTimeout
Sets the maximum time to wait for the collector to process an exported batch of metrics. If unset, defaults to 10Ls. -
setEndpoint
Sets the OTLP endpoint to connect to. If unset, defaults to "http://localhost:4317". The endpoint must start with either http:// or https://. -
setCompression
Sets the method used to compress payloads. If unset, compression is disabled. Currently supported compression methods include "gzip" and "none". -
setTrustedCertificates
Sets the certificate chain to use for verifying servers when TLS is enabled. Thebyte[]
should contain an X.509 certificate collection in PEM format. If not set, TLS connections will use the system default trusted certificates. -
setClientTls
Sets ths client key and the certificate chain to use for verifying client when TLS is enabled. The key must be PKCS8, and both must be in PEM format. -
addHeader
Add header to request. Optional. Applicable only ifsetChannel(ManagedChannel)
is not used to set channel.- Parameters:
key
- header keyvalue
- header value- Returns:
- this builder's instance
-
setAggregationTemporalitySelector
public OtlpGrpcMetricExporterBuilder setAggregationTemporalitySelector(io.opentelemetry.sdk.metrics.export.AggregationTemporalitySelector aggregationTemporalitySelector) Set theAggregationTemporalitySelector
used forAggregationTemporalitySelector.getAggregationTemporality(InstrumentType)
.If unset, defaults to
AggregationTemporalitySelector.alwaysCumulative()
.AggregationTemporalitySelector.deltaPreferred()
is a common configuration for delta backends. -
setDefaultAggregationSelector
public OtlpGrpcMetricExporterBuilder setDefaultAggregationSelector(io.opentelemetry.sdk.metrics.export.DefaultAggregationSelector defaultAggregationSelector) Set theDefaultAggregationSelector
used forMetricExporter.getDefaultAggregation(InstrumentType)
.If unset, defaults to
DefaultAggregationSelector.getDefault()
.- Since:
- 1.16.0
-
build
Constructs a new instance of the exporter based on the builder's values.- Returns:
- a new exporter's instance
-
setEndpoint(String)
.