Send Micrometer metrics to Dynatrace

yamlcopydownload
management:
  metrics:
    export:
      dynatrace:
        v2:
          metric-key-prefix: "service.component"
          enrich-with-dynatrace-metadata: true
          default-dimensions:
            stack: "prod"
            region: "us-east-1"

propertiescopydownload
management.metrics.export.dynatrace.v2.metric-key-prefix=service.component
management.metrics.export.dynatrace.v2.enrich-with-dynatrace-metadata=true
management.metrics.export.dynatrace.v2.default-dimensions.stack=prod
management.metrics.export.dynatrace.v2.default-dimensions.region=us-east-1

yamlcopydownload
management:
  metrics:
    export:
      dynatrace:
        v2:
          metric-key-prefix: "service.component"
          enrich-with-dynatrace-metadata: true
          default-dimensions:
            stack: "prod"
            region: "us-east-1"

propertiescopydownload
management.metrics.export.dynatrace.v2.metric-key-prefix=service.component
management.metrics.export.dynatrace.v2.enrich-with-dynatrace-metadata=true
management.metrics.export.dynatrace.v2.default-dimensions.stack=prod
management.metrics.export.dynatrace.v2.default-dimensions.region=us-east-1

yamlcopydownload
management:
  metrics:
    export:
      dynatrace:
        uri: "https://mySampleEnv.live.dynatrace.com/api/v2/metrics/ingest"
        # Read the environment variable YOUR_METRICS_INGEST_API_TOKEN and supply the value of the env var instead.
        api-token: ${YOUR_METRICS_INGEST_API_TOKEN}
        v2:
          metric-key-prefix: "service.component"
          enrich-with-dynatrace-metadata: true
          default-dimensions:
            stack: "prod"
            region: "us-east-1"

propertiescopydownload
management.metrics.export.dynatrace.uri=https://mySampleEnv.live.dynatrace.com/api/v2/metrics/ingest
management.metrics.export.dynatrace.api-token=${YOUR_METRICS_INGEST_API_TOKEN}
management.metrics.export.dynatrace.v2.metric-key-prefix=service.component
management.metrics.export.dynatrace.v2.enrich-with-dynatrace-metadata=true
management.metrics.export.dynatrace.v2.default-dimensions.stack=prod
management.metrics.export.dynatrace.v2.default-dimensions.region=us-east-1

javacopydownload
DynatraceConfig dynatraceConfig = new DynatraceConfig() {
    @Override
    @Nullable
    public String get(String k) {
        // This method can be used for retrieving arbitrary config items;
        // null means accepting the defaults defined in DynatraceConfig
        return null;
    }
};
DynatraceMeterRegistry registry = DynatraceMeterRegistry.builder(config).build();
// Add the Dynatrace registry to Micrometer's global registry.
Metrics.addRegistry(registry);

javacopydownload
DynatraceConfig dynatraceConfig = new DynatraceConfig() {
    @Override
    @Nullable
    public String get(String k) {
        // This method can be used for retrieving arbitrary config items;
        // null means accepting the defaults defined in DynatraceConfig
        return null;
    }
};
DynatraceMeterRegistry registry = DynatraceMeterRegistry.builder(config).build();
// Add the Dynatrace registry to Micrometer's global registry.
Metrics.addRegistry(registry);

In this example, the metrics ingest URL and access token are read from environment variables YOUR_METRICS_INGEST_URL and YOUR_METRICS_INGEST_TOKEN. You should never store secrets in the code directly, but read them from a secure source.

javacopydownload
DynatraceConfig dynatraceConfig = new DynatraceConfig() {
    @Override
    public DynatraceApiVersion apiVersion() {
        // Not strictly required, but makes the code more clear/explicit
        return DynatraceApiVersion.V2;
    }

    @Override
    public String uri() {
        // The endpoint of the Dynatrace Metrics API v2 including path:
        // "https://{your-environment-id}.live.dynatrace.com/api/v2/metrics/ingest"
        String endpoint = System.getenv("YOUR_METRICS_INGEST_URL");
        return endpoint != null ? endpoint : DynatraceConfig.super.uri();
    }

    @Override
    public String apiToken() {
        // Should be read from a secure source
        String token = System.getenv("YOUR_METRICS_INGEST_TOKEN");
        return token != null ? token : "";
    }

    @Override
    @Nullable
    public String get(String k) {
        // This method can be used for retrieving arbitrary config items;
        // null means accepting the defaults defined in DynatraceConfig
        return null;
    }
};
DynatraceMeterRegistry registry = DynatraceMeterRegistry.builder(config).build();
// Add the Dynatrace registry to Micrometer's global registry.
Metrics.addRegistry(registry);

javacopydownload
DynatraceConfig dynatraceConfig = new DynatraceConfig() {
    @Override
    public DynatraceApiVersion apiVersion() {
        // Defaults to V2 if not set explicitly.
        return DynatraceApiVersion.V2;
    }

    @Override
    public String uri() {
        // The endpoint of the Dynatrace Metrics API v2 including path. For example:
        // "https://{your-environment-id}.live.dynatrace.com/api/v2/metrics/ingest".
        String endpoint = System.getenv("YOUR_METRICS_INGEST_URL");
        return endpoint != null ? endpoint : DynatraceConfig.super.uri();
    }

    @Override
    public String apiToken() {
        // Should be read from a secure source
        String token = System.getenv("YOUR_METRICS_INGEST_API_TOKEN");
        return token != null ? token : "";
    }

    @Override
    public String metricKeyPrefix() {
        // Will be prepended to all metric keys
        return "service.component";
    }

    @Override
    public boolean enrichWithDynatraceMetadata() {
        // On by default, but can be turned off explicitly.
        return true;
    }

    @Override
    public Map<String, String> defaultDimensions() {
        // Create and return a map containing the desired key-value pairs.
        Map<String, String> dims = new HashMap<>();
        dims.put("dimensionKey", "dimensionValue");
        return dims;
    }

    // Only available in Micrometer 1.9.0 and above.
    @Override
    public boolean useDynatraceSummaryInstruments() {
        return false;
    }

    @Override
    @Nullable
    public String get(String k) {
        return null; // Accept the rest of the defaults
    }
};

yamlcopydownload
management.metrics.enable:
  # disable jvm.memory metrics
  jvm.memory: false
  # disable all jvm metrics:
  jvm: false

propertiescopydownload
# disable jvm.memory metrics
management.metrics.enable.jvm.memory=false
# disable all jvm metrics
management.metrics.enable.jvm=false

javacopydownload
@Configuration(proxyBeanMethods = false)
public class MyMeterRegistryConfiguration {

    @Bean
    public MeterRegistryCustomizer<MeterRegistry> metricsCommonTags() {
        return registry -> registry.config()
            .meterFilter(MeterFilter.denyNameStartsWith("jvm.gc"));
    }
}

javacopydownload
// Disable all metrics with metric names starting with jvm.gc
registry.config()
    .meterFilter(MeterFilter.denyNameStartsWith("jvm.gc"));

yamlcopydownload
logging.level.io.micrometer.dynatrace: DEBUG

propertiescopydownload
logging.level.io.micrometer.dynatrace=DEBUG

When using the default logback implementation, debug logging to the console is enabled by default. In order to add logback to your project and log debug information, add the following dependency:

groovycopydownload
implementation 'ch.qos.logback:logback-classic:latest.release'