diff --git a/website/content/docs/k8s/connect/observability/datadog.mdx b/website/content/docs/k8s/connect/observability/datadog.mdx new file mode 100644 index 0000000000..896a4bdc7c --- /dev/null +++ b/website/content/docs/k8s/connect/observability/datadog.mdx @@ -0,0 +1,100 @@ +--- +layout: docs +page_title: Configure Datadog Metrics Collection for Consul on Kubernetes +description: >- + Enable Consul Monitoring via Datadog using the `metrics.datadog` helm annotation. +--- + +# Datadog Integration for Consul on Kubernetes + +The Helm chart includes automated configuration options in order to integrate with Datadog. + +### Note + + + The **DogStatsD**, **Openmetrics Prometheus**, and **Datadog Integration** methods are mutually exclusive and cannot be enabled at the same time. This is currently unsupported within current Datadog Integration. One of the three methods of integration must be enabled at any given time. + + +## Consul Datadog Agent Metrics Integration Checks: + + + + ```yaml + metrics: + enabled: true + enableAgentMetrics: true + datadog: + enabled: true + namespace: "datadog" + ``` + + + + | Consul Component | Description | API Endpoint(s) | + |------------------|--------------------------------------------------|----------------------------------------| + | Serf | Events and Membership Flaps | `/v1/agent/metrics` (prometheus) | + | Raft | Monitors Raft peer information | `/v1/status/leader` `/v1/status/peers` | + | Catalog Services | Service Health Status and Node Count | | + | Catalog Nodes | Node Service Count and Health Status | | + | Consul Latency | Consul LAN + WAN Coordinate Latency Calculations | | + + +## Consul Server Agent DogstatsD Metrics Collection + + + + + ```yaml + metrics: + enabled: true + enableAgentMetrics: true + datadog: + enabled: true + namespace: "datadog" + dogstatsd: + enabled: true + socketTransportType: "UDS" + dogstatsdAddr: "/var/run/datadog/dsd.socket" + ``` + + + + + + ```yaml + metrics: + enabled: true + enableAgentMetrics: true + datadog: + enabled: true + namespace: "datadog" + dogstatsd: + enabled: true + socketTransportType: "UDP" + dogstatsdAddr: "datadog.datadog.svc.cluster.local" + ``` + + + + + - Collects DogstatsD formatted metrics pertaining to Consul Serf Membership, Raft, DNS Performance, Agent Telemetry, and much more. + - Enables configuring DogstatsD metric collection using one of either `UDP` or `Unix Domain Socket configuration` + +## Consul Server Openmetrics Prometheus Metrics Collection + + + + ```yaml + metrics: + enabled: true + enableAgentMetrics: true + datadog: + enabled: true + namespace: "datadog" + openMetricsPrometheus: + enabled: true + ``` + + + + - Collects Consul related metrics via the `/v1/agent/metrics` API endpoint leveraging the `prometheus` query parameter. diff --git a/website/data/docs-nav-data.json b/website/data/docs-nav-data.json index bc5175f4d7..ed8f7de35a 100644 --- a/website/data/docs-nav-data.json +++ b/website/data/docs-nav-data.json @@ -1530,6 +1530,10 @@ { "title": "Metrics", "path": "k8s/connect/observability/metrics" + }, + { + "title": "Datadog", + "path": "k8s/connect/observability/datadog" } ] }