Skip to content

Commit 0f7fa84

Browse files
committed
Polish 'Update Dynatrace documentation for Micrometer 1.9.0'
See gh-31132
1 parent 6df9f50 commit 0f7fa84

File tree

1 file changed

+13
-9
lines changed
  • spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator

1 file changed

+13
-9
lines changed

spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/metrics.adoc

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -166,36 +166,37 @@ You can also change the interval at which metrics are sent to Datadog:
166166

167167
[[actuator.metrics.export.dynatrace]]
168168
==== Dynatrace
169-
170169
Dynatrace offers two metrics ingest APIs, both of which are implemented for {micrometer-registry-docs}/dynatrace[Micrometer].
171170
You can find the Dynatrace documentation on Micrometer metrics ingest {dynatrace-help}/how-to-use-dynatrace/metrics/metric-ingestion/ingestion-methods/micrometer[here].
172171
Configuration properties in the `v1` namespace apply only when exporting to the {dynatrace-help}/dynatrace-api/environment-api/metric-v1/[Timeseries v1 API].
173172
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.
175174
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.
176175
Otherwise, `v2` is assumed.
177176

177+
178+
178179
[[actuator.metrics.export.dynatrace.v2-api]]
179180
===== v2 API
180-
181181
You can use the v2 API in two ways.
182182

183+
184+
183185
[[actuator.metrics.export.dynatrace.v2-api.auto-config]]
184186
====== Auto-configuration
185-
186187
Dynatrace auto-configuration is available for hosts that are monitored by the OneAgent or by the Dynatrace Operator for Kubernetes.
187188

188189
**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].
189190
The ingest endpoint forwards the metrics to the Dynatrace backend.
190191

191192
**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`.
193193

194194
This is the default behavior and requires no special setup beyond a dependency on `io.micrometer:micrometer-registry-dynatrace`.
195195

196+
197+
196198
[[actuator.metrics.export.dynatrace.v2-api.manual-config]]
197199
====== Manual configuration
198-
199200
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.
200201
The {dynatrace-help}/dynatrace-api/basics/dynatrace-api-authentication/[API token] must have the "`Ingest metrics`" (`metrics.ingest`) permission set.
201202
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 (
224225
* 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).
225226
* Default dimensions: Specify key-value pairs that are added to all exported metrics.
226227
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.
228232

229233
It is possible to not specify a URI and API token, as shown in the following example.
230234
In this scenario, the automatically configured endpoint is used:
@@ -245,9 +249,10 @@ In this scenario, the automatically configured endpoint is used:
245249
use-dynatrace-summary-instruments: true # (default: true)
246250
----
247251

252+
253+
248254
[[actuator.metrics.export.dynatrace.v1-api]]
249255
===== v1 API (Legacy)
250-
251256
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].
252257
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.
253258
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
270275

271276
[[actuator.metrics.export.dynatrace.version-independent-settings]]
272277
===== Version-independent Settings
273-
274278
In addition to the API endpoint and token, you can also change the interval at which metrics are sent to Dynatrace.
275279
The default export interval is `60s`.
276280
The following example sets the export interval to 30 seconds:

0 commit comments

Comments
 (0)