traefik/docs/content/observability/metrics/datadog.md

156 lines
2.4 KiB
Markdown
Raw Normal View History

---
title: "Traefik Datadog Metrics Documentation"
description: "Traefik Proxy supports Datadog for backend metrics. Read the technical documentation to enable Datadog for observability."
---
2019-09-02 10:18:04 +00:00
# Datadog
2019-07-18 19:36:05 +00:00
2019-09-02 10:18:04 +00:00
To enable the Datadog:
2019-07-18 19:36:05 +00:00
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
metrics:
2019-09-02 10:18:04 +00:00
datadog: {}
2019-07-22 07:58:04 +00:00
```
```toml tab="File (TOML)"
[metrics]
[metrics.datadog]
```
2019-07-18 19:36:05 +00:00
```bash tab="CLI"
2019-07-22 07:58:04 +00:00
--metrics.datadog=true
2019-07-18 19:36:05 +00:00
```
#### `address`
_Required, Default="127.0.0.1:8125"_
Address instructs exporter to send metrics to datadog-agent at this address.
This address can be a Unix Domain Socket (UDS) address with the following form: `unix:///path/to/datadog.socket`.
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
2019-07-18 19:36:05 +00:00
metrics:
2019-09-02 10:18:04 +00:00
datadog:
2019-07-18 19:36:05 +00:00
address: 127.0.0.1:8125
```
```toml tab="File (TOML)"
[metrics]
[metrics.datadog]
address = "127.0.0.1:8125"
```
2019-07-18 19:36:05 +00:00
```bash tab="CLI"
--metrics.datadog.address=127.0.0.1:8125
2019-07-18 19:36:05 +00:00
```
#### `addEntryPointsLabels`
_Optional, Default=true_
Enable metrics on entry points.
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
2019-07-18 19:36:05 +00:00
metrics:
2019-09-02 10:18:04 +00:00
datadog:
2019-07-18 19:36:05 +00:00
addEntryPointsLabels: true
```
```toml tab="File (TOML)"
[metrics]
[metrics.datadog]
addEntryPointsLabels = true
```
2019-07-18 19:36:05 +00:00
```bash tab="CLI"
--metrics.datadog.addEntryPointsLabels=true
```
#### `addRoutersLabels`
2021-04-30 08:22:04 +00:00
_Optional, Default=false_
Enable metrics on routers.
```toml tab="File (TOML)"
[metrics]
[metrics.datadog]
addRoutersLabels = true
```
```yaml tab="File (YAML)"
metrics:
datadog:
addRoutersLabels: true
```
```bash tab="CLI"
--metrics.datadog.addrouterslabels=true
```
2019-07-18 19:36:05 +00:00
#### `addServicesLabels`
_Optional, Default=true_
Enable metrics on services.
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
2019-07-18 19:36:05 +00:00
metrics:
2019-09-02 10:18:04 +00:00
datadog:
2019-07-18 19:36:05 +00:00
addServicesLabels: true
```
```toml tab="File (TOML)"
[metrics]
[metrics.datadog]
addServicesLabels = true
```
2019-07-18 19:36:05 +00:00
```bash tab="CLI"
--metrics.datadog.addServicesLabels=true
```
#### `pushInterval`
_Optional, Default=10s_
The interval used by the exporter to push metrics to datadog-agent.
2019-07-22 07:58:04 +00:00
```yaml tab="File (YAML)"
2019-07-18 19:36:05 +00:00
metrics:
2019-09-02 10:18:04 +00:00
datadog:
2019-07-18 19:36:05 +00:00
pushInterval: 10s
```
```toml tab="File (TOML)"
[metrics]
[metrics.datadog]
2022-02-03 14:16:12 +00:00
pushInterval = "10s"
```
2019-07-18 19:36:05 +00:00
```bash tab="CLI"
--metrics.datadog.pushInterval=10s
```
2021-10-06 15:34:07 +00:00
#### `prefix`
_Optional, Default="traefik"_
The prefix to use for metrics collection.
```yaml tab="File (YAML)"
metrics:
datadog:
prefix: traefik
```
```toml tab="File (TOML)"
[metrics]
[metrics.datadog]
prefix = "traefik"
```
```bash tab="CLI"
2022-02-03 14:16:12 +00:00
--metrics.datadog.prefix=traefik
2021-10-06 15:34:07 +00:00
```