Package io.opentelemetry.exporter.otlp.trace

Class OtlpGrpcSpanExporterBuilder

java.lang.Object
io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporterBuilder
public final class OtlpGrpcSpanExporterBuilder extends Object
Builder utility for this exporter.

  • Method Details

    • setChannel

      public OtlpGrpcSpanExporterBuilder setChannel(io.grpc.ManagedChannel channel)
      Sets the managed chanel to use when communicating with the backend. Takes precedence over setEndpoint(String) if both are called.
      Parameters:
      channel - the channel to use
      Returns:
      this builder's instance

    • setTimeout

      public OtlpGrpcSpanExporterBuilder 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 OtlpGrpcSpanExporterBuilder setTimeout(Duration timeout)
      Sets the maximum time to wait for the collector to process an exported batch of spans. If unset, defaults to 10Ls.

    • setEndpoint

      public OtlpGrpcSpanExporterBuilder setEndpoint(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(String compressionMethod)
      Sets the method used to compress payloads. If unset, compression is disabled. Currently supported compression methods include "gzip" and "none".

    • setTrustedCertificates

      public OtlpGrpcSpanExporterBuilder 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.

    • addHeader

      public OtlpGrpcSpanExporterBuilder addHeader(String key, String value)
      Add header to request. Optional. Applicable only if setChannel(ManagedChannel) is not called.
      Parameters:
      key - header key
      value - header value
      Returns:
      this builder's instance

    • setMeterProvider

      public OtlpGrpcSpanExporterBuilder setMeterProvider(io.opentelemetry.api.metrics.MeterProvider meterProvider)
      Sets the MeterProvider to use to collect metrics related to export. If not set, metrics will not be collected.

    • build

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