Package io.opentelemetry.exporter.otlp.http.metrics

Class OtlpHttpMetricExporterBuilder

java.lang.Object
io.opentelemetry.exporter.otlp.http.metrics.OtlpHttpMetricExporterBuilder
public final class OtlpHttpMetricExporterBuilder extends Object
Builder utility for OtlpHttpMetricExporter.
Since:
1.14.0

  • Method Details

    • setTimeout

      public OtlpHttpMetricExporterBuilder 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 OtlpHttpMetricExporterBuilder 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 OtlpHttpMetricExporterBuilder setEndpoint(String endpoint)
      Sets the OTLP endpoint to connect to. If unset, defaults to "http://localhost:4318/v1/metrics". The endpoint must start with either http:// or https://, and include the full HTTP path.

    • setCompression

      public OtlpHttpMetricExporterBuilder setCompression(String compressionMethod)
      Sets the method used to compress payloads. If unset, compression is disabled. Currently supported compression methods include "gzip" and "none".

    • addHeader

      public OtlpHttpMetricExporterBuilder addHeader(String key, String value)
      Add header to requests.

    • setTrustedCertificates

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

    • setAggregationTemporalitySelector

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

    • setDefaultAggregationSelector

      public OtlpHttpMetricExporterBuilder setDefaultAggregationSelector(io.opentelemetry.sdk.metrics.export.DefaultAggregationSelector defaultAggregationSelector)
      Set the DefaultAggregationSelector used for MetricExporter.getDefaultAggregation(InstrumentType).

      If unset, defaults to DefaultAggregationSelector.getDefault().

      Since:
      1.16.0

    • build

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