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
+71-5Lines changed: 71 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -147,21 +147,87 @@ You can also change the interval at which metrics are sent to Datadog:
147
147
148
148
[[actuator.metrics.export.dynatrace]]
149
149
==== Dynatrace
150
-
Dynatrace registry pushes metrics to the configured URI periodically.
150
+
151
+
Dynatrace offers two metrics ingest APIs, both of which are implemented for {micrometer-registry-docs}/dynatrace[Micrometer]:
152
+
153
+
===== API v2
154
+
155
+
The API v2 can be used in two ways:
156
+
157
+
If a local OneAgent is running on the host, it is enough to set the API version to v2 and metrics will be automatically exported to the https://www.dynatrace.com/support/help/how-to-use-dynatrace/metrics/metric-ingestion/ingestion-methods/local-api/[local OneAgent ingest endpoint], which forwards them to the Dynatrace backend:
If no local OneAgent is running, the endpoint of the https://www.dynatrace.com/support/help/dynatrace-api/environment-api/metric-v2/post-ingest-metrics/[Metrics API v2] and an API token are required.
169
+
The https://www.dynatrace.com/support/help/dynatrace-api/basics/dynatrace-api-authentication/[API token] must have the "Ingest metrics" (`metrics.ingest`) permission set.
170
+
It is recommended to limit scope to only this one permission.
171
+
Please ensure that the endpoint URI contains the path (e.g. `/api/v2/metrics/ingest`).
# specify token and uri or leave blank for OneAgent export
199
+
api-version: "v2"
200
+
metric-key-prefix: "your.key.prefix"
201
+
enrich-with-one-agent-metadata: true
202
+
default-dimensions:
203
+
key1: "value1"
204
+
key2: "value2"
205
+
----
206
+
207
+
===== API v1 (Legacy)
208
+
209
+
The Dynatrace API v1 registry pushes metrics to the configured URI periodically using the https://www.dynatrace.com/support/help/dynatrace-api/environment-api/metric-v1/[Timeseries API v1].
210
+
For backwards-compatibility with existing setups, `api-version` defaults to `"v1"` but can also be specified explicitly as such.
151
211
To export metrics to {micrometer-registry-docs}/dynatrace[Dynatrace], your API token, device ID, and URI must be provided:
212
+
For the API v1, the base environment URI needs to be specified, without any path.
213
+
The API v1 endpoint path will be added automatically.
@@ -172,7 +238,7 @@ You can also change the interval at which metrics are sent to Dynatrace:
172
238
step: "30s"
173
239
----
174
240
175
-
241
+
More information on how to set up the Dynatrace exporter for Micrometer can be found in {micrometer-registry-docs}/dynatrace[the Micrometer documentation].
0 commit comments