Class OtlpGrpcSpanExporterBuilder
- java.lang.Object
-
- io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporterBuilder
-
public final class OtlpGrpcSpanExporterBuilder extends java.lang.Object
Builder utility for this exporter.
-
-
Field Summary
Fields Modifier and Type Field Description private static java.net.URI
DEFAULT_ENDPOINT
private static java.lang.String
DEFAULT_ENDPOINT_URL
private static MemoryMode
DEFAULT_MEMORY_MODE
private static long
DEFAULT_TIMEOUT_SECS
(package private) GrpcExporterBuilder<Marshaler>
delegate
(package private) static java.lang.String
GRPC_ENDPOINT_PATH
(package private) static java.lang.String
GRPC_SERVICE_NAME
private MemoryMode
memoryMode
-
Constructor Summary
Constructors Constructor Description OtlpGrpcSpanExporterBuilder()
OtlpGrpcSpanExporterBuilder(GrpcExporterBuilder<Marshaler> delegate, MemoryMode memoryMode)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description OtlpGrpcSpanExporterBuilder
addHeader(java.lang.String key, java.lang.String value)
Add a constant header to requests.OtlpGrpcSpanExporter
build()
Constructs a new instance of the exporter based on the builder's values.OtlpGrpcSpanExporterBuilder
setChannel(io.grpc.ManagedChannel channel)
Deprecated.UsesetEndpoint(String)
.OtlpGrpcSpanExporterBuilder
setClientTls(byte[] privateKeyPem, byte[] certificatePem)
Sets ths client key and the certificate chain to use for verifying client when TLS is enabled.OtlpGrpcSpanExporterBuilder
setCompression(java.lang.String compressionMethod)
Sets the method used to compress payloads.OtlpGrpcSpanExporterBuilder
setConnectTimeout(long timeout, java.util.concurrent.TimeUnit unit)
Sets the maximum time to wait for new connections to be established.OtlpGrpcSpanExporterBuilder
setConnectTimeout(java.time.Duration timeout)
Sets the maximum time to wait for new connections to be established.OtlpGrpcSpanExporterBuilder
setEndpoint(java.lang.String endpoint)
Sets the OTLP endpoint to connect to.OtlpGrpcSpanExporterBuilder
setHeaders(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.String>> headerSupplier)
Set the supplier of headers to add to requests.OtlpGrpcSpanExporterBuilder
setMemoryMode(MemoryMode memoryMode)
Set theMemoryMode
.OtlpGrpcSpanExporterBuilder
setMeterProvider(MeterProvider meterProvider)
Sets theMeterProvider
to use to collect metrics related to export.OtlpGrpcSpanExporterBuilder
setMeterProvider(java.util.function.Supplier<MeterProvider> meterProviderSupplier)
Sets theMeterProvider
supplier used to collect metrics related to export.OtlpGrpcSpanExporterBuilder
setRetryPolicy(RetryPolicy retryPolicy)
Set the retry policy, ornull
to disable retry.OtlpGrpcSpanExporterBuilder
setSslContext(javax.net.ssl.SSLContext sslContext, javax.net.ssl.X509TrustManager trustManager)
Sets the "bring-your-own" SSLContext for use with TLS.OtlpGrpcSpanExporterBuilder
setTimeout(long timeout, java.util.concurrent.TimeUnit unit)
Sets the maximum time to wait for the collector to process an exported batch of spans.OtlpGrpcSpanExporterBuilder
setTimeout(java.time.Duration timeout)
Sets the maximum time to wait for the collector to process an exported batch of spans.OtlpGrpcSpanExporterBuilder
setTrustedCertificates(byte[] trustedCertificatesPem)
Sets the certificate chain to use for verifying servers when TLS is enabled.
-
-
-
Field Detail
-
GRPC_SERVICE_NAME
static final java.lang.String GRPC_SERVICE_NAME
- See Also:
- Constant Field Values
-
GRPC_ENDPOINT_PATH
static final java.lang.String GRPC_ENDPOINT_PATH
- See Also:
- Constant Field Values
-
DEFAULT_ENDPOINT_URL
private static final java.lang.String DEFAULT_ENDPOINT_URL
- See Also:
- Constant Field Values
-
DEFAULT_ENDPOINT
private static final java.net.URI DEFAULT_ENDPOINT
-
DEFAULT_TIMEOUT_SECS
private static final long DEFAULT_TIMEOUT_SECS
- See Also:
- Constant Field Values
-
DEFAULT_MEMORY_MODE
private static final MemoryMode DEFAULT_MEMORY_MODE
-
delegate
final GrpcExporterBuilder<Marshaler> delegate
-
memoryMode
private MemoryMode memoryMode
-
-
Constructor Detail
-
OtlpGrpcSpanExporterBuilder
OtlpGrpcSpanExporterBuilder(GrpcExporterBuilder<Marshaler> delegate, MemoryMode memoryMode)
-
OtlpGrpcSpanExporterBuilder
OtlpGrpcSpanExporterBuilder()
-
-
Method Detail
-
setChannel
@Deprecated public OtlpGrpcSpanExporterBuilder setChannel(io.grpc.ManagedChannel channel)
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.Note: calling this overrides the spec compliant
User-Agent
header. To ensure spec compliance, setManagedChannelBuilder.userAgent(String)
toOtlpUserAgent.getUserAgent()
when building the channel.- Parameters:
channel
- the channel to use- Returns:
- this builder's instance
-
setTimeout
public OtlpGrpcSpanExporterBuilder setTimeout(long timeout, java.util.concurrent.TimeUnit unit)
Sets the maximum time to wait for the collector to process an exported batch of spans. If unset, defaults to 10Ls.
-
setTimeout
public OtlpGrpcSpanExporterBuilder setTimeout(java.time.Duration timeout)
Sets the maximum time to wait for the collector to process an exported batch of spans. If unset, defaults to 10Ls.
-
setConnectTimeout
public OtlpGrpcSpanExporterBuilder setConnectTimeout(long timeout, java.util.concurrent.TimeUnit unit)
Sets the maximum time to wait for new connections to be established. If unset, defaults to 10Ls.- Since:
- 1.36.0
-
setConnectTimeout
public OtlpGrpcSpanExporterBuilder setConnectTimeout(java.time.Duration timeout)
Sets the maximum time to wait for new connections to be established. If unset, defaults to 10Ls.- Since:
- 1.36.0
-
setEndpoint
public OtlpGrpcSpanExporterBuilder setEndpoint(java.lang.String endpoint)
Sets the OTLP endpoint to connect to. If unset, defaults to "http://localhost:4317". The endpoint must start with either http:// or https://.
-
setCompression
public OtlpGrpcSpanExporterBuilder setCompression(java.lang.String compressionMethod)
Sets the method used to compress payloads. If unset, compression is disabled. Compression method "gzip" and "none" are supported out of the box. Support for additional compression methods is available by implementingCompressor
andCompressorProvider
.
-
setTrustedCertificates
public OtlpGrpcSpanExporterBuilder setTrustedCertificates(byte[] trustedCertificatesPem)
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
public OtlpGrpcSpanExporterBuilder setClientTls(byte[] privateKeyPem, byte[] certificatePem)
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.
-
setSslContext
public OtlpGrpcSpanExporterBuilder setSslContext(javax.net.ssl.SSLContext sslContext, javax.net.ssl.X509TrustManager trustManager)
Sets the "bring-your-own" SSLContext for use with TLS. Users should call this _or_ set raw certificate bytes, but not both.- Since:
- 1.26.0
-
addHeader
public OtlpGrpcSpanExporterBuilder addHeader(java.lang.String key, java.lang.String value)
Add a constant header to requests. If thekey
collides with another constant header name or a one fromsetHeaders(Supplier)
, the values from both are included. Applicable only ifsetChannel(ManagedChannel)
is not used to set channel.- Parameters:
key
- header keyvalue
- header value- Returns:
- this builder's instance
-
setHeaders
public OtlpGrpcSpanExporterBuilder setHeaders(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.String>> headerSupplier)
Set the supplier of headers to add to requests. If a key from the map collides with a constant fromaddHeader(String, String)
, the values from both are included. Applicable only ifsetChannel(ManagedChannel)
is not used to set channel.- Since:
- 1.33.0
-
setRetryPolicy
public OtlpGrpcSpanExporterBuilder setRetryPolicy(@Nullable RetryPolicy retryPolicy)
Set the retry policy, ornull
to disable retry. Retry policy isRetryPolicy.getDefault()
by default- Since:
- 1.28.0
-
setMeterProvider
public OtlpGrpcSpanExporterBuilder setMeterProvider(MeterProvider meterProvider)
Sets theMeterProvider
to use to collect metrics related to export. If not set, usesGlobalOpenTelemetry.getMeterProvider()
.
-
setMeterProvider
public OtlpGrpcSpanExporterBuilder setMeterProvider(java.util.function.Supplier<MeterProvider> meterProviderSupplier)
Sets theMeterProvider
supplier used to collect metrics related to export. If not set, usesGlobalOpenTelemetry.getMeterProvider()
.- Since:
- 1.32.0
-
setMemoryMode
public OtlpGrpcSpanExporterBuilder setMemoryMode(MemoryMode memoryMode)
Set theMemoryMode
. If unset, defaults toDEFAULT_MEMORY_MODE
.When memory mode is
MemoryMode.REUSABLE_DATA
, serialization is optimized to reduce memory allocation.- Since:
- 1.39.0
-
build
public OtlpGrpcSpanExporter build()
Constructs a new instance of the exporter based on the builder's values.- Returns:
- a new exporter's instance
-
-