datadog integration - consul integration table

website/content/docs/k8s/connect/observability/datadog.mdx

@@ -9,13 +9,18 @@ description: >-
 
 The Helm chart includes automated configuration options in order to integrate with Datadog.
 
-### Note
+### Datadog Metrics Integration Methods
 
-<Note>
+<Highlight>
-  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.
+  Choose <strong><em>one</em></strong> integration method from the three described below that best suites the intent for metrics collection. <strong><a href="https://docs.datadoghq.com/integrations/consul/?tab=containerized">Consul Integration</a></strong>, <strong><a href="https://docs.datadoghq.com/developers/dogstatsd/?tab=kubernetes">DogStatsD</a></strong>, and <strong><a href="https://docs.datadoghq.com/containers/kubernetes/prometheus/?tab=kubernetesadv2">Openmetrics Prometheus</a></strong> methods of integration are <strong><em>mutually exclusive</em></strong>.
-</Note>
+  <br/><br/>
+  <strong>Reasoning:</strong> <em>The consul-k8s helm chart automated configuration implements Datadog's <a href="https://docs.datadoghq.com/integrations/consul/?tab=containerized">Consul Integration</a> method using the <a href="https://github.com/DataDog/integrations-core/blob/07c04c5e9465ba1f3e0198830896d05923e81283/consul/datadog_checks/consul/data/conf.yaml.example#L59"><code>use_prometheus_endpoint</code></a> configuration parameter. <strong>DogstatsD</strong>, <strong>Consul Integration</strong>, and <strong>Openmetrics Prometheus</strong> Metrics by design share the same <a href="https://docs.datadoghq.com/integrations/consul/?tab=host#data-collected">metric name</a> syntax for collection, and would therefore cause a conflict.
+    The <a href="https://github.com/DataDog/integrations-core/blob/07c04c5e9465ba1f3e0198830896d05923e81283/consul/datadog_checks/consul/consul.py#L55-L61">consul.py</a> integration source code, as well as the <a href="https://github.com/hashicorp/consul-k8s/blob/4cac70496788f50354f96e9331003fcf338f419c/charts/consul/templates/_helpers.tpl#L595-L598">consul-k8s helm chart</a> prohibit the enablement of more that one integration at a time.</em>
+</Highlight>
 
-## Consul Datadog Agent Metrics Integration Checks:
+
+
+## Consul Metrics Integration Checks
 
   <CodeBlockConfig heading={"Datadog Consul Checks"}>
 
@@ -30,14 +35,20 @@ The Helm chart includes automated configuration options in order to integrate wi
 
   </CodeBlockConfig>
 
-  | Consul Component | Description                                      | API Endpoint(s)                        |
+  | Consul Component | Description                                      | API Endpoint(s)                                                      |
-  |------------------|--------------------------------------------------|----------------------------------------|
+  |------------------|--------------------------------------------------|----------------------------------------------------------------------|
-  | Serf             | Events and Membership Flaps                      | `/v1/agent/metrics` (prometheus)       |
+  | Agent            | Agent Metadata (i.e., version)                   | `/v1/agent/self`                                                     |
-  | Raft             | Monitors Raft peer information                   | `/v1/status/leader` `/v1/status/peers` |
+  | Metrics          | Prometheus formatted metrics                     | `/v1/agent/metrics`                                                  |
-  | Catalog Services | Service Health Status and Node Count             |                                        |
+  | Serf             | Events and Membership Flaps                      | `/v1/health/service/consul` `/v1/agent/self`                         |
-  | Catalog Nodes    | Node Service Count and Health Status             |                                        |
+  | Raft             | Monitors Raft peer information                   | `/v1/status/leader` `/v1/status/peers`                               |
-  | Consul Latency   | Consul LAN + WAN Coordinate Latency Calculations |                                        |
+  | Catalog Services | Service Health Status and Node Count             | `/v1/catalog/services` `/v1/health/state/any`                        |
+  | Catalog Nodes    | Node Service Count and Health Status             | `/v1/health/state/any` `/v1/health/service/<service>`                |
+  | Consul Latency   | Consul LAN + WAN Coordinate Latency Calculations | `/v1/agent/self` `/v1/coordinate/nodes` `/v1/coordinate/datacenters` |
+
+
+### Metrics Data Collected
 
+Review the Datadog Documentation for the full description of Metrics data collected by the official Consul integration [here](https://docs.datadoghq.com/integrations/consul/?tab=host#data-collected).
 
 ## Consul Server Agent DogstatsD Metrics Collection