Extend documentation on Datadog metrics

- Document that an application key must be set to publish metadata
  for the exported metrics.

- Point out that using a non-US Datadog site (e.g., EU) requires
  changing the `uri` property.

See gh-30879
pull/32644/head
Denis Washington 3 years ago committed by Andy Wilkinson
parent 822aad978e
commit 09db7e4001

@ -53,8 +53,8 @@ public class DatadogProperties extends StepRegistryProperties {
private String hostTag = "instance";
/**
* URI to ship metrics to. If you need to publish metrics to an internal proxy
* en-route to Datadog, you can define the location of the proxy with this.
* URI to ship metrics to. Set this if you need to publish metrics to a Datadog site
* other than US, or to an internal proxy en-route to Datadog.
*/
private String uri = "https://api.datadoghq.com";

@ -132,6 +132,30 @@ To export metrics to {micrometer-registry-docs}/datadog[Datadog], your API key m
api-key: "YOUR_KEY"
----
If you additionally provide an application key (optional), then metadata such as meter descriptions, types, and base units will also be exported:
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
----
management:
metrics:
export:
datadog:
api-key: "YOUR_API_KEY"
application-key: "YOUR_APPLICATION_KEY"
----
By default, metrics are sent to the Datadog US https://docs.datadoghq.com/getting_started/site[site] (`https://api.datadoghq.com`).
In case your Datadog project is hosted on one of the other sites, or you need to send metrics through a proxy, change the API base URL accordingly:
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
----
management:
metrics:
export:
datadog:
uri: "https://api.datadoghq.eu"
----
You can also change the interval at which metrics are sent to Datadog:
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]

Loading…
Cancel
Save