Package io.micrometer.dynatrace

Interface DynatraceConfig

All Superinterfaces:
io.micrometer.core.instrument.config.MeterRegistryConfig, io.micrometer.core.instrument.push.PushRegistryConfig, io.micrometer.core.instrument.step.StepRegistryConfig
public interface DynatraceConfig extends io.micrometer.core.instrument.step.StepRegistryConfig
Configuration for DynatraceMeterRegistry
Since:
1.1.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final DynatraceConfig
    DEFAULT
    Accept configuration defaults.

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    apiToken()
     
    default DynatraceApiVersion
    apiVersion()
    Return the version of the target Dynatrace API.
    default Map<String,String>
    defaultDimensions()
    Return default dimensions.
    default String
    deviceId()
     
    default boolean
    enrichWithDynatraceMetadata()
    Return whether to enrich with Dynatrace metadata.
    default boolean
    exportMeterMetadata()
    Toggle whether to export meter metadata (unit and description) to the Dynatrace backend for the V2 version of this exporter.
    default String
    group()
    Return device group name.
    default String
    metricKeyPrefix()
    Return metric key prefix.
    default String
    prefix()
     
    default String
    technologyType()
     
    default String
    uri()
     
    default boolean
    useDynatraceSummaryInstruments()
    Return whether to fall back to the built-in micrometer instruments for Timer and DistributionSummary.
    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, step

  • Field Details

    • DEFAULT

      static final DynatraceConfig DEFAULT
      Accept configuration defaults.
      Since:
      1.10.0

  • Method Details

    • prefix

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

    • apiToken

      default String apiToken()

    • uri

      default String uri()

    • deviceId

      default String deviceId()

    • technologyType

      default String technologyType()

    • group

      @Nullable default String group()
      Return device group name.
      Returns:
      device group name
      Since:
      1.2.0

    • apiVersion

      default DynatraceApiVersion apiVersion()
      Return the version of the target Dynatrace API. Defaults to v1 if not provided.
      Returns:
      a DynatraceApiVersion containing the version of the targeted Dynatrace API.
      Since:
      1.8.0

    • metricKeyPrefix

      default String metricKeyPrefix()
      Return metric key prefix.
      Returns:
      metric key prefix
      Since:
      1.8.0

    • defaultDimensions

      default Map<String,String> defaultDimensions()
      Return default dimensions.
      Returns:
      default dimensions
      Since:
      1.8.0

    • enrichWithDynatraceMetadata

      default boolean enrichWithDynatraceMetadata()
      Return whether to enrich with Dynatrace metadata. Dynatrace metadata is provided by the Dynatrace OneAgent or Dynatrace Kubernetes Operator and helps put metrics emitted via the Micrometer exporter in context more easily.
      Returns:
      whether to enrich with Dynatrace metadata
      Since:
      1.8.0

    • useDynatraceSummaryInstruments

      default boolean useDynatraceSummaryInstruments()
      Return whether to fall back to the built-in micrometer instruments for Timer and DistributionSummary.
      Returns:
      true if the resetting Dynatrace instruments should be used, and false if the registry should fall back to the built-in Micrometer instruments.
      Since:
      1.9.0

    • exportMeterMetadata

      default boolean exportMeterMetadata()
      Toggle whether to export meter metadata (unit and description) to the Dynatrace backend for the V2 version of this exporter. Metadata will be exported by default from Micrometer version 1.12.0. This setting has no effect for the (legacy) Dynatrace Exporter v1. Setting this toggle to false has a similar effect to registering a MeterFilter that removes unit and description from all registered meters.
      Returns:
      true if metadata should be exported, false otherwise.
      Since:
      1.12.0

    • 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