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
+26-7Lines changed: 26 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -167,9 +167,10 @@ You can also change the interval at which metrics are sent to Datadog:
167
167
[[actuator.metrics.export.dynatrace]]
168
168
==== Dynatrace
169
169
Dynatrace offers two metrics ingest APIs, both of which are implemented for {micrometer-registry-docs}/dynatrace[Micrometer].
170
+
You can find the Dynatrace documentation on Micrometer metrics ingest {dynatrace-help}/how-to-use-dynatrace/metrics/metric-ingestion/ingestion-methods/micrometer[here].
170
171
Configuration properties in the `v1` namespace apply only when exporting to the {dynatrace-help}/dynatrace-api/environment-api/metric-v1/[Timeseries v1 API].
171
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].
172
-
Note that this integration can export only to either the `v1` or `v2` version of the API at a time.
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.
173
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.
174
175
Otherwise, `v2` is assumed.
175
176
@@ -179,11 +180,24 @@ Otherwise, `v2` is assumed.
179
180
===== v2 API
180
181
You can use the v2 API in two ways.
181
182
182
-
If a local 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].
Dynatrace auto-configuration is available for hosts that are monitored by the OneAgent or by the Dynatrace Operator for Kubernetes.
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].
183
190
The ingest endpoint forwards the metrics to the Dynatrace backend.
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.
193
+
184
194
This is the default behavior and requires no special setup beyond a dependency on `io.micrometer:micrometer-registry-dynatrace`.
185
195
186
-
If no local OneAgent is running, the endpoint of the {dynatrace-help}/dynatrace-api/environment-api/metric-v2/post-ingest-metrics/[Metrics v2 API] and an API token are required.
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.
187
201
The {dynatrace-help}/dynatrace-api/basics/dynatrace-api-authentication/[API token] must have the "`Ingest metrics`" (`metrics.ingest`) permission set.
188
202
We recommend limiting the scope of the token to this one permission.
189
203
You must ensure that the endpoint URI contains the path (for example, `/api/v2/metrics/ingest`):
@@ -205,15 +219,19 @@ The example below configures metrics export using the `example` environment id:
205
219
api-token: "YOUR_TOKEN"
206
220
----
207
221
208
-
When using the Dynatrace v2 API, the following optional features are available:
222
+
When using the Dynatrace v2 API, the following optional features are available (more details can be found in the {dynatrace-help}/how-to-use-dynatrace/metrics/metric-ingestion/ingestion-methods/micrometer#dt-configuration-properties[Dynatrace documentation]):
209
223
210
224
* Metric key prefix: Sets a prefix that is prepended to all exported metric keys.
211
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).
212
226
* Default dimensions: Specify key-value pairs that are added to all exported metrics.
213
-
If tags with the same key are specified with Micrometer, they overwrite the default dimensions.
227
+
If tags with the same key are specified with Micrometer, they overwrite the default dimensions.
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.
214
232
215
233
It is possible to not specify a URI and API token, as shown in the following example.
216
-
In this scenario, the local OneAgent endpoint is used:
234
+
In this scenario, the automatically configured endpoint is used:
@@ -269,7 +288,7 @@ The following example sets the export interval to 30 seconds:
269
288
step: "30s"
270
289
----
271
290
272
-
You can find more information on how to set up the Dynatrace exporter for Micrometer in {micrometer-registry-docs}/dynatrace[the Micrometer documentation].
291
+
You can find more information on how to set up the Dynatrace exporter for Micrometer in the {micrometer-registry-docs}/dynatrace[Micrometer documentation] and the {dynatrace-help}/how-to-use-dynatrace/metrics/metric-ingestion/ingestion-methods/micrometer[Dynatrace documentation].
0 commit comments