Interface OtlpPublisherConfig

All Superinterfaces:
MetricsPublisherConfig, Prototype.Api, Prototype.Factory<OtlpPublisher>
All Known Implementing Classes:
OtlpPublisherConfig.BuilderBase.OtlpPublisherConfigImpl
public interface OtlpPublisherConfig extends Prototype.Api
Settings for an OTLP publisher.
See Also:

  • Method Details

    • builder

      static OtlpPublisherConfig.Builder builder()
      Create a new fluent API builder to customize configuration.
      Returns:
      a new builder

    • builder

      static OtlpPublisherConfig.Builder builder(OtlpPublisherConfig instance)
      Create a new fluent API builder from an existing instance.
      Parameters:
      instance - an existing instance used as a base for the builder
      Returns:
      a builder based on an instance

    • create

      static OtlpPublisherConfig create(Config config)
      Create a new instance from configuration.
      Parameters:
      config - used to configure the new instance
      Returns:
      a new instance configured from configuration

    • enabled

      boolean enabled()
      Whether the configured publisher is enabled.
      Returns:
      true if enabled, false otherwise

    • prefix

      Optional<String> prefix()
      The prefix for settings.
      Returns:
      prefix

    • url

      Optional<String> url()
      URL to which to send metrics telemetry.
      Returns:
      backend URL

    • interval

      Optional<Duration> interval()
      Interval between successive transmissions of metrics data.
      Returns:
      step interval

    • resourceAttributes

      Map<String,String> resourceAttributes()
      Attribute name/value pairs to be associated with all metrics transmissions.
      Returns:
      name/value pairs of attribute settings

    • aggregationTemporality

      Optional<io.micrometer.registry.otlp.AggregationTemporality> aggregationTemporality()
      Algorithm to use for adjusting values before transmission.
      Returns:
      aggregation strategy

    • batchSize

      Optional<Integer> batchSize()
      Number of measurements to send in a single request to the backend.
      Returns:
      transmission batch size

    • headers

      Map<String,String> headers()
      Headers to add to each transmission message.
      Returns:
      headers

    • maxScale

      Optional<Integer> maxScale()
      Maximum scale value to apply to statistical histogram.
      Returns:
      maximum scale

    • maxBucketCount

      Optional<Integer> maxBucketCount()
      Maximum bucket count to apply to statistical histogram.
      Returns:
      maximum bucket count

    • maxBucketsPerMeter

      Map<String,Integer> maxBucketsPerMeter()
      Maximum number of buckets to use for specific meters.
      Returns:
      meter-specific maxBucket values

    • baseTimeUnit

      Optional<TimeUnit> baseTimeUnit()
      Base time unit for timers.
      Returns:
      base time unit

    • config

      Config config()
      Metrics configuration node.
      Returns:
      metrics configuration

    • properties

      Map<String,String> properties()
      Property values to be returned by the OTLP meter registry configuration.
      Returns:
      properties