Send Micrometer metrics to Dynatrace

Micrometer is an open source instrumentation framework for JVM-based application metrics. It's used by Spring Boot to instrument a wide range of metrics. You can ingest Micrometer and Spring Boot metrics and analyze them with Dynatrace Davis® AI end to end in the context of your trace, log, and diagnostics data. With Dynatrace, you get intelligent AI-based observability and automatic root cause analysis for Spring Boot, 15+ pre-instrumented JVM-based frameworks and servers, and custom metrics.

You can use Micrometer in Dynatrace to:

There are two ways of using Micrometer:

Prerequisites

Ingestion channels

You can use one of the following ingestion channels to send your Micrometer metrics:

Dynatrace Micrometer registry

Micrometer uses the concept of a registry to export metrics to monitoring systems.

Ingest metrics from Spring Boot apps

Micrometer can be configured via a .properties or .yaml file used for Spring Boot configuration. Spring Boot automatically binds properties with the management.dynatrace.metrics.export prefix to the Dynatrace configuration object.

1management.dynatrace.metrics.export:
2  v2:
3    metric-key-prefix: "service.component"
4    enrich-with-dynatrace-metadata: true
5    default-dimensions:
6      stack: "prod"
7      region: "us-east-1"

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

Ingest metrics directly from Micrometer

1DynatraceConfig dynatraceConfig = new DynatraceConfig() {
2    @Override
3    @Nullable
4    public String get(String k) {
5        // This method can be used for retrieving arbitrary config items;
6        // null means accepting the defaults defined in DynatraceConfig
7        return null;
8    }
9};
10DynatraceMeterRegistry registry = DynatraceMeterRegistry.builder(config).build();

Verify the metrics

After you have sent your metrics, verify the data in the Data explorer.

Configuration properties

To set up the Dynatrace Micrometer registry, you need the Dynatrace configuration object (DynatraceConfig). The object contains the parameters of metric ingestion and is used to construct the Dynatrace registry (DynatraceMeterRegistry), which is registered with Micrometer to ingest metrics to Dynatrace. You can set the following parameters:

Additional information

Metric types

All metrics are transformed to follow the Metric ingestion protocol types used by Dynatrace.

Meter metadata

Starting with version 1.12.0 of the Dynatrace Micrometer registry, meter metadata (unit and description) is automatically exported to Dynatrace. No code changes are required to start exporting metadata. To turn off metadata export, use the following configuration:

1management:
2  metrics:
3    export:
4      dynatrace:
5        v2:
6          export-meter-metadata: false  # default: true

1management.dynatrace.metrics.export.v2.export-meter-metadata=false

For previous versions of Micrometer, you need to specify the metadata manually using the Dynatrace web UI or API For more information, see Custom metric metadata.

Capture JVM metrics in Micrometer

By default, JVM metrics are turned off when running Micrometer without Spring Boot. To learn how to enable them, see the Micrometer documentation. After they are enabled and registered with the Dynatrace registry (DynatraceMeterRegistry), JVM metrics are created and sent to Dynatrace automatically.

On hosts that are monitored by OneAgent, these metrics might already be captured by OneAgent.

Restrict ingestion of specific metrics

1management.metrics.enable:
2  # disable jvm.memory metrics
3  jvm.memory: false
4  # disable all jvm metrics:
5  jvm: false

1# disable jvm.memory metrics
2management.metrics.enable.jvm.memory=false
3# disable all jvm metrics
4management.metrics.enable.jvm=false

1management.metrics.enable:
2  # disable all metrics
3  all: false
4  # re-enable only jvm.* metrics
5  jvm: true

1# disable all metrics
2management.metrics.enable.all=false
3# re-enable jvm.* metrics
4management.metrics.enable.jvm=true

1@Configuration(proxyBeanMethods = false)
2public class MyMeterRegistryConfiguration {
3
4    @Bean
5    public MeterRegistryCustomizer<MeterRegistry> metricsCommonTags() {
6        return registry -> registry.config()
7            .meterFilter(MeterFilter.denyNameStartsWith("jvm.gc"));
8    }
9}

Troubleshooting with logs

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

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

Dynatrace summary instruments

Starting with Micrometer version 1.9.x, specialized instruments are used in the Dynatrace meter registry for certain summary instruments (DynatraceTimer and DynatraceDistributionSummary). Their purpose is to get around a peculiarity in how Micrometer records metrics, which, in some cases, led to metrics being rejected by Dynatrace for having an invalid format. The specialized instruments, tailored to Dynatrace metrics ingestion, prevent the creation of invalid metrics.

Dynatrace Micrometer registry v1 (legacy)

If the apiVersion property is set to V1, the registry sends data via the Timeseries API v1. For backward compatibility, it defaults to V1 if a deviceId is specified, because this property is required in V1 and is not used in V2.

Existing setups will continue to work when updating to newer versions of Micrometer. The reported metrics will be assigned to custom devices in Dynatrace.

For the V1 API, you only need to specify the base URL of your environment (for example, https://mySampleEnv.live.dynatrace.com).

1management.dynatrace.metrics.export:
2    # For v1 export, do not append a path to the endpoint URL. For example:
3    # For SaaS: https://{your-environment-id}.live.dynatrace.com
4    # For Managed deployments: https://{your-domain}/e/{your-environment-id}
5    uri: https://{your-environment-id}.live.dynatrace.com
6
7    # Should be read from a secure source
8    api-token: MY_TOKEN
9
10    # When setting the device id, metrics will be exported to the v1 timeseries endpoint
11    # Using just device-id (without the v1 prefix) is deprecated, but will work to maintain backwards compatibility.
12    v1:
13        device-id: sample
14
15    # To disable Dynatrace publishing (for example, in a local development profile), use:
16    # enabled: false
17
18    # The interval at which metrics are sent to Dynatrace. The default is 1 minute.
19    step: 1m

1DynatraceConfig dynatraceConfig = new DynatraceConfig() {
2    @Override
3    public String uri() {
4        // The Dynatrace environment URI without any path. For example:
5        // https://{your-environment-id}.live.dynatrace.com
6        return MY_DYNATRACE_URI;
7    }
8
9    @Override
10    public String apiToken() {
11        // Should be read from a secure source
12        return MY_TOKEN;
13    }
14
15    @Override
16    public String deviceId() {
17        return MY_DEVICE_ID;
18    }
19
20    @Override
21    @Nullable
22    public String get(String k) {
23        return null;
24    }
25};
26DynatraceMeterRegistry registry = DynatraceMeterRegistry.builder(config).build();
27// Add the Dynatrace registry to Micrometers global registry.
28Metrics.addRegistry(registry);