You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/metrics.adoc
+13-9Lines changed: 13 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -166,36 +166,37 @@ You can also change the interval at which metrics are sent to Datadog:
166
166
167
167
[[actuator.metrics.export.dynatrace]]
168
168
==== Dynatrace
169
-
170
169
Dynatrace offers two metrics ingest APIs, both of which are implemented for {micrometer-registry-docs}/dynatrace[Micrometer].
171
170
You can find the Dynatrace documentation on Micrometer metrics ingest {dynatrace-help}/how-to-use-dynatrace/metrics/metric-ingestion/ingestion-methods/micrometer[here].
172
171
Configuration properties in the `v1` namespace apply only when exporting to the {dynatrace-help}/dynatrace-api/environment-api/metric-v1/[Timeseries v1 API].
173
172
Configuration properties in the `v2` namespace apply only when exporting to the {dynatrace-help}/dynatrace-api/environment-api/metric-v2/post-ingest-metrics/[Metrics v2 API].
174
-
Note that this integration can export only to either the `v1` or `v2` version of the API at a time, with `v2` being the preferred one.
173
+
Note that this integration can export only to either the `v1` or `v2` version of the API at a time, with `v2` being preferred.
175
174
If the `device-id` (required for v1 but not used in v2) is set in the `v1` namespace, metrics are exported to the `v1` endpoint.
Dynatrace auto-configuration is available for hosts that are monitored by the OneAgent or by the Dynatrace Operator for Kubernetes.
187
188
188
189
**Local OneAgent:** If a OneAgent is running on the host, metrics are automatically exported to the {dynatrace-help}/how-to-use-dynatrace/metrics/metric-ingestion/ingestion-methods/local-api/[local OneAgent ingest endpoint].
189
190
The ingest endpoint forwards the metrics to the Dynatrace backend.
190
191
191
192
**Dynatrace Kubernetes Operator:** When running in Kubernetes with the Dynatrace Operator installed, the registry will automatically pick up your endpoint URI and API token from the operator instead.
192
-
Dynatrace Operator-based auto-configuration is available from Micrometer version `1.9.0`, which is distributed with Spring Boot since version `2.7.0`.
193
193
194
194
This is the default behavior and requires no special setup beyond a dependency on `io.micrometer:micrometer-registry-dynatrace`.
If no auto-configuration is available, the endpoint of the {dynatrace-help}/dynatrace-api/environment-api/metric-v2/post-ingest-metrics/[Metrics v2 API] and an API token are required.
200
201
The {dynatrace-help}/dynatrace-api/basics/dynatrace-api-authentication/[API token] must have the "`Ingest metrics`" (`metrics.ingest`) permission set.
201
202
We recommend limiting the scope of the token to this one permission.
@@ -224,7 +225,10 @@ When using the Dynatrace v2 API, the following optional features are available (
224
225
* Enrich with Dynatrace metadata: If a OneAgent or Dynatrace operator is running, enrich metrics with additional metadata (for example, about the host, process, or pod).
225
226
* Default dimensions: Specify key-value pairs that are added to all exported metrics.
226
227
If tags with the same key are specified with Micrometer, they overwrite the default dimensions.
227
-
* Use Dynatrace Summary instruments: In some cases the Micrometer Dynatrace registry created metrics that were rejected. In Micrometer 1.9.x, this was fixed by introducing Dynatrace-specific summary instruments. Setting this toggle to false forces Micrometer to fall back to the behavior that was the default before 1.9.x. It should only be used when encountering problems while migrating from 1.8.x to 1.9.x.
228
+
* Use Dynatrace Summary instruments: In some cases the Micrometer Dynatrace registry created metrics that were rejected.
229
+
In Micrometer 1.9.x, this was fixed by introducing Dynatrace-specific summary instruments.
230
+
Setting this toggle to `false` forces Micrometer to fall back to the behavior that was the default before 1.9.x.
231
+
It should only be used when encountering problems while migrating from Micrometer 1.8.x to 1.9.x.
228
232
229
233
It is possible to not specify a URI and API token, as shown in the following example.
230
234
In this scenario, the automatically configured endpoint is used:
@@ -245,9 +249,10 @@ In this scenario, the automatically configured endpoint is used:
The Dynatrace v1 API metrics registry pushes metrics to the configured URI periodically by using the {dynatrace-help}/dynatrace-api/environment-api/metric-v1/[Timeseries v1 API].
252
257
For backwards-compatibility with existing setups, when `device-id` is set (required for v1, but not used in v2), metrics are exported to the Timeseries v1 endpoint.
253
258
To export metrics to {micrometer-registry-docs}/dynatrace[Dynatrace], your API token, device ID, and URI must be provided:
@@ -270,7 +275,6 @@ For the v1 API, you must specify the base environment URI without a path, as the
0 commit comments