Package io.micrometer.registry.otlp

Interface OtlpConfig

All Superinterfaces:
io.micrometer.core.instrument.config.MeterRegistryConfig, io.micrometer.core.instrument.push.PushRegistryConfig
public interface OtlpConfig extends io.micrometer.core.instrument.push.PushRegistryConfig
Config for OtlpMeterRegistry.
Since:
1.9.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final OtlpConfig
    DEFAULT
    Configuration with default values.

  • Method Summary

    Modifier and Type
    Method
    Description
    default AggregationTemporality
    aggregationTemporality()
    AggregationTemporality of the OtlpMeterRegistry.
    default TimeUnit
    baseTimeUnit()
     
    default Map<String,String>
    headers()
    Additional headers to send with exported metrics.
    default HistogramFlavor
    histogramFlavor()
    Histogram type to be preferred when histogram publishing is enabled.
    default int
    maxBucketCount()
    Maximum number of buckets to be used for exponential histograms, if configured.
    default int
    maxScale()
    Max scale to use for exponential histograms, if configured.
    default String
    prefix()
     
    default Map<String,String>
    resourceAttributes()
    Attributes to set on the Resource that will be used for all metrics published.
    default Duration
    step()
    Default implementation supports the environment variable OTEL_METRIC_EXPORT_INTERVAL when the step value is not provided by the MeterRegistryConfig.get(String) implementation.
    default String
    url()
    If no value is returned by MeterRegistryConfig.get(String), environment variables OTEL_EXPORTER_OTLP_METRICS_ENDPOINT and OTEL_EXPORTER_OTLP_ENDPOINT environment variables will be checked, in that order, by the default implementation.
    default io.micrometer.core.instrument.config.validate.Validated<?>
    validate()
     

    Methods inherited from interface io.micrometer.core.instrument.config.MeterRegistryConfig

    get, requireValid

    Methods inherited from interface io.micrometer.core.instrument.push.PushRegistryConfig

    batchSize, connectTimeout, enabled, numThreads, readTimeout

  • Field Details

    • DEFAULT

      static final OtlpConfig DEFAULT
      Configuration with default values.

  • Method Details

    • prefix

      default String prefix()
      Specified by:
      prefix in interface io.micrometer.core.instrument.config.MeterRegistryConfig

    • url

      default String url()
      If no value is returned by MeterRegistryConfig.get(String), environment variables OTEL_EXPORTER_OTLP_METRICS_ENDPOINT and OTEL_EXPORTER_OTLP_ENDPOINT environment variables will be checked, in that order, by the default implementation.
      Returns:
      address to where metrics will be published. Default is http://localhost:4318/v1/metrics
      See Also:

    • step

      default Duration step()
      Default implementation supports the environment variable OTEL_METRIC_EXPORT_INTERVAL when the step value is not provided by the MeterRegistryConfig.get(String) implementation.
      Specified by:
      step in interface io.micrometer.core.instrument.push.PushRegistryConfig
      Returns:
      step size (reporting frequency) to use. The default is 1 minute.
      See Also:

    • resourceAttributes

      default Map<String,String> resourceAttributes()
      Attributes to set on the Resource that will be used for all metrics published. This should include a service.name attribute that identifies your service.

      By default, resource attributes will load using the MeterRegistryConfig.get(String) method, extracting key values from a comma-separated list in the format key1=value1,key2=value2. Resource attributes will be loaded from the OTEL_RESOURCE_ATTRIBUTES environment variable and the service name from the OTEL_SERVICE_NAME environment variable if they are set and MeterRegistryConfig.get(String) does not return a value.

      Returns:
      map of key value pairs to use as resource attributes
      See Also:

    • aggregationTemporality

      default AggregationTemporality aggregationTemporality()
      AggregationTemporality of the OtlpMeterRegistry. This determines whether the meters should be cumulative(AGGREGATION_TEMPORALITY_CUMULATIVE) or step/delta(AGGREGATION_TEMPORALITY_DELTA). Default implementation supports the environment variable OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE when a value is not provided by MeterRegistryConfig.get(String).
      Returns:
      the aggregationTemporality; default is Cumulative
      Since:
      1.11.0
      See Also:

    • headers

      default Map<String,String> headers()
      Additional headers to send with exported metrics. This may be needed for authorization headers, for example.

      By default, headers will be loaded from MeterRegistryConfig.get(String). If that is not set, they will be taken from the environment variables OTEL_EXPORTER_OTLP_HEADERS and OTEL_EXPORTER_OTLP_METRICS_HEADERS. The header key-value pairs are expected to be in a comma-separated list in the format key1=value1,key2=value2. If a header is set in both OTEL_EXPORTER_OTLP_HEADERS and OTEL_EXPORTER_OTLP_METRICS_HEADERS, the header in the latter will overwrite the former.

      Returns:
      a map of the headers' key-value pairs
      Since:
      1.11.0
      See Also:

    • histogramFlavor

      default HistogramFlavor histogramFlavor()
      Histogram type to be preferred when histogram publishing is enabled. By default HistogramFlavor.EXPLICIT_BUCKET_HISTOGRAM is used for the supported meters. When this is set to HistogramFlavor.BASE2_EXPONENTIAL_BUCKET_HISTOGRAM and publishPercentileHistogram is enabled Base2ExponentialHistogram is used for recording distributions.

      Note: If specific SLO's are configured, this property is not honored and HistogramFlavor.EXPLICIT_BUCKET_HISTOGRAM is used for those meters.

      Returns:
      - histogram flavor to be used
      Since:
      1.14.0

    • maxScale

      default int maxScale()
      Max scale to use for exponential histograms, if configured.
      Returns:
      maxScale
      Since:
      1.14.0
      See Also:

    • maxBucketCount

      default int maxBucketCount()
      Maximum number of buckets to be used for exponential histograms, if configured. This has no effect on explicit bucket histograms.
      Returns:
      - maxBuckets
      Since:
      1.14.0
      See Also:

    • validate

      default io.micrometer.core.instrument.config.validate.Validated<?> validate()
      Specified by:
      validate in interface io.micrometer.core.instrument.config.MeterRegistryConfig
      Specified by:
      validate in interface io.micrometer.core.instrument.push.PushRegistryConfig

    • baseTimeUnit

      default TimeUnit baseTimeUnit()