The information contained in this article has been verified as up-to-date on the date of the original publication of the article. HashiCorp endeavors to keep this information up-to-date and correct, but it makes no representations or warranties of any kind, express or implied, about the ongoing completeness, accuracy, reliability, or suitability of the information provided.
All information contained in this article is for general information purposes only. Any reliance you place on such information as it applies to your use of your HashiCorp product is therefore strictly at your own risk.
Overview
This article provides links to various resources related to observability for Consul.
Note
- This article contains URLs that direct to sites outside of HashiCorp.
- This is not an exhaustive list of observability resources
Documentation | Tutorials | Blogs
Abbreviation Legend
|
Name |
Abbreviation |
|---|---|
| Key Value | KV |
| Knowledge Base Article | KB |
| Service Discovery | SD |
| Service Mesh | SM |
| System | SYS |
| Name | Resource Type | SD | SM | KV | SYS | Notes |
|---|---|---|---|---|---|---|
| Accessing Envoy metrics when using Consul and Kubernetes | HashiCorp KB | ✅ | How-To: Access Envoy Administrative API Endpoint (/stats) endpoint on Consul K8s Cluster via Port Forwarding | |||
| Agent Telemetry | HashiCorp Doc | ✅ | ✅ | ✅ |
Official Documentation for all available Consul Agent Telemetry metrics |
|
| Datadog Consul and Envoy Metrics Monitoring | VM Edition | HashiCorp KB | ✅ | How-To: Configure Datadog agent integration with Consul and Envoy for Virtual Machine environments | |||
| Debug service mesh events and errors with Consul proxy access logs | HashiCorp Tutorial | ✅ | How-To: Enable proxy access logs for Consul sidecars and utilize Grafana dashboards to analyze events, errors, and operations | |||
| Helpful Envoy Metrics When Used With Consul | HashiCorp KB | ✅ | KB: Outlines Envoy metrics useful for troubleshooting Consul Service Mesh issues | |||
| How to monitor Consul with Datadog | Datadog Blog | ✅ | ✅ | ✅ | ✅ | Blog: Describes overview of all Datadog capabilities in monitoring a Consul Service Mesh |
| Key metrics for monitoring Consul | Datadog Blog | ✅ | ✅ | ✅ | Blog: Describes Consul-specific metrics for overall cluster health analysis from Datadog's perspective. Uses official Consul Docs as reference/basis. | |
| Layer 7 Observability with Prometheus, Grafana, and Kubernetes | HashiCorp Tutorial | ✅ |
How-To: Configure Consul to expose Envoy metrics to Prometheus. Deploy Prometheus and Grafana using their official Helm charts. |
|||
| Monitor Consul Datacenter Health | HashiCorp Tutorial | ✅ | ✅ | ✅ | KB: Review Consul-specific metrics and ID their importance, and when a metric is indicating a healthy or unhealthy state. | |
| Monitor Consul Datacenter Health with Telegraf | HashiCorp Tutorial | ✅ | ✅ | ✅ |
How-To: Configure Telegraf to collect StatsD and host-level metrics Configure Consul to send metrics to Telegraf Review an example of metrics visualization Understand important metrics to aggregate and alert on |
|
| Monitor Consul health and performance with Datadog | Datadog Blog | ✅ | ✅ | ✅ |
Blog: Discussion on how to interpret and understand Consul metrics in terms of - Consul Health Checks Cluster Latency Cluster Health Logging Service Tags |
|
| Service Mesh Observability with Docker Compose | HashiCorp Tutorial | ✅ | ✅ | ✅ | ✅ | How-To: Create an observability suite comprised of Prometheus (metrics), Loki (logs), Tempo (traces), and Grafana (visualization) using Docker Compose |
| HashiCorp Tutorial | ✅ | ✅ | How-To: Enable service-mesh sidecar proxy and server agent metrics on Kubernetes. |