Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pirgeo committed Jul 16, 2021
1 parent 81bc348 commit 4090f20
Showing 1 changed file with 6 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -151,12 +151,13 @@ You can also change the interval at which metrics are sent to Datadog:
Dynatrace offers two metrics ingest APIs, both of which are implemented for {micrometer-registry-docs}/dynatrace[Micrometer]:

[[actuator.metrics.export.dynatrace.v2-api]]
===== V2 API
===== v2 API

The V2 API can be used in two ways:
The v2 API can be used in two ways:

If a local OneAgent is running on the host, 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.

This is the default behaviour and requires no special set up.
Simply include a dependency to `'io.micrometer:micrometer-registry-dynatrace'` in your project, and metrics will be exported to the local OneAgent endpoint.

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 v2 API] and an API token are required.
The https://www.dynatrace.com/support/help/dynatrace-api/basics/dynatrace-api-authentication/[API token] must have the "Ingest metrics" (`metrics.ingest`) permission set.
Expand Down Expand Up @@ -200,7 +201,7 @@ If tags with the same key are specified using Micrometer, they overwrite the def
===== v1 API (Legacy)

The Dynatrace v1 API registry pushes metrics to the configured URI periodically using the https://www.dynatrace.com/support/help/dynatrace-api/environment-api/metric-v1/[Timeseries v1 API].
For backwards-compatibility with existing setups, `api-version` defaults to `"v1"` but can also be specified explicitly as such.
For backwards-compatibility with existing setups, when `device-id` is set (required for v1, but not used in v2), metrics will be exported to the Timeseries v1 endpoint.
To export metrics to {micrometer-registry-docs}/dynatrace[Dynatrace], your API token, device ID, and URI must be provided:

[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
Expand All @@ -221,7 +222,7 @@ For the v1 API, the base environment URI must be specified without a path as the
[[actuator.metrics.export.dynatrace.version-independent-settings]]
===== Version-independent settings

You can also change the interval at which metrics are sent to Dynatrace (works for both API versions).
In addition to the API endpoint and token, you can also change the interval at which metrics are sent to Dynatrace.
The default export interval is `60s`.

[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
Expand Down

0 comments on commit 4090f20

Please sign in to comment.