Package io.opentelemetry.exporter.otlp.metrics

Class OtlpGrpcMetricExporterBuilder

java.lang.Object
io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporterBuilder
public final class OtlpGrpcMetricExporterBuilder extends Object
Builder utility for this exporter.
Since:
1.14.0

  • Method Details

    • setChannel

      @Deprecated public OtlpGrpcMetricExporterBuilder setChannel(io.grpc.ManagedChannel channel)
      Deprecated.
      Use setEndpoint(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 over setEndpoint(String) if both are called.
      Parameters:
      channel - the channel to use
      Returns:
      this builder's instance

    • setTimeout

      public OtlpGrpcMetricExporterBuilder setTimeout(long timeout, TimeUnit unit)
      Sets the maximum time to wait for the collector to process an exported batch of metrics. If unset, defaults to 10Ls.

    • setTimeout

      public OtlpGrpcMetricExporterBuilder setTimeout(Duration timeout)
      Sets the maximum time to wait for the collector to process an exported batch of metrics. If unset, defaults to 10Ls.

    • setEndpoint

      public OtlpGrpcMetricExporterBuilder 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 OtlpGrpcMetricExporterBuilder 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 OtlpGrpcMetricExporterBuilder 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 OtlpGrpcMetricExporterBuilder setClientTls(byte[] privateKeyPem, byte[] certificatePem)
      Sets ths client key and the certificate chain to use for verifying client when TLS is enabled.

    • addHeader

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

    • setAggregationTemporalitySelector

      public OtlpGrpcMetricExporterBuilder setAggregationTemporalitySelector(io.opentelemetry.sdk.metrics.export.AggregationTemporalitySelector aggregationTemporalitySelector)
      Set the AggregationTemporalitySelector used for AggregationTemporalitySelector.getAggregationTemporality(InstrumentType).

      If unset, defaults to AggregationTemporalitySelector.alwaysCumulative().

      AggregationTemporalitySelector.deltaPreferred() is a common configuration for delta backends.

    • build

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