Package io.opentelemetry.exporter.otlp.http.trace

Class OtlpHttpSpanExporterBuilder

java.lang.Object
io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporterBuilder
public final class OtlpHttpSpanExporterBuilder extends Object
Builder utility for OtlpHttpSpanExporter.
Since:
1.5.0

  • Method Details

    • setTimeout

      public OtlpHttpSpanExporterBuilder setTimeout(long timeout, 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 OtlpHttpSpanExporterBuilder setTimeout(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 OtlpHttpSpanExporterBuilder setConnectTimeout(long timeout, TimeUnit unit)
      Sets the maximum time to wait for new connections to be established. If unset, defaults to 10Ls.
      Since:
      1.33.0

    • setConnectTimeout

      public OtlpHttpSpanExporterBuilder setConnectTimeout(Duration timeout)
      Sets the maximum time to wait for new connections to be established. If unset, defaults to 10Ls.
      Since:
      1.33.0

    • setEndpoint

      public OtlpHttpSpanExporterBuilder setEndpoint(String endpoint)
      Sets the OTLP endpoint to connect to. If unset, defaults to "http://localhost:4318/v1/traces". The endpoint must start with either http:// or https://, and include the full HTTP path.

    • setCompression

      public OtlpHttpSpanExporterBuilder setCompression(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 implementing Compressor and CompressorProvider.

    • addHeader

      public OtlpHttpSpanExporterBuilder addHeader(String key, String value)
      Add a constant header to requests. If the key collides with another constant header name or a one from setHeaders(Supplier), the values from both are included.

    • setHeaders

      public OtlpHttpSpanExporterBuilder setHeaders(Supplier<Map<String,String>> headerSupplier)
      Set the supplier of headers to add to requests. If a key from the map collides with a constant from addHeader(String, String), the values from both are included.
      Since:
      1.33.0

    • setTrustedCertificates

      public OtlpHttpSpanExporterBuilder setTrustedCertificates(byte[] trustedCertificatesPem)
      Sets the certificate chain to use for verifying servers when TLS is enabled. The byte[] should contain an X.509 certificate collection in PEM format. If not set, TLS connections will use the system default trusted certificates.

    • setClientTls

      public OtlpHttpSpanExporterBuilder 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 OtlpHttpSpanExporterBuilder setSslContext(SSLContext sslContext, 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

    • setRetryPolicy

      public OtlpHttpSpanExporterBuilder setRetryPolicy(io.opentelemetry.sdk.common.export.RetryPolicy retryPolicy)
      Ses the retry policy. Retry is disabled by default.
      Since:
      1.28.0

    • setMeterProvider

      public OtlpHttpSpanExporterBuilder setMeterProvider(io.opentelemetry.api.metrics.MeterProvider meterProvider)
      Sets the MeterProvider to use to collect metrics related to export. If not set, uses GlobalOpenTelemetry.getMeterProvider().

    • setMeterProvider

      public OtlpHttpSpanExporterBuilder setMeterProvider(Supplier<io.opentelemetry.api.metrics.MeterProvider> meterProviderSupplier)
      Sets the MeterProvider supplier to use to collect metrics related to export. If not set, uses GlobalOpenTelemetry.getMeterProvider().
      Since:
      1.32.0

    • build

      public OtlpHttpSpanExporter build()
      Constructs a new instance of the exporter based on the builder's values.
      Returns:
      a new exporter's instance