github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Apply suggestions from code review

Browse Source 
Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
pull/21890/head
Melisa Griffin 1 month ago committed by Melisa Griffin
parent 7c24db2f3b
commit 8067fd6476
2 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File

4
website/content/docs/connect/observability/grafanadashboards/index.mdx
Unescape View File

@ -7,7 +7,9 @@ description: >-
# Dashboards for service mesh observability # Dashboards for service mesh observability
This topic describes the configuration and usage of dashboards for monitoring and managing services within a Consul-managed Envoy service mesh. These dashboards provide critical insights into the health, performance, and resource utilization of services. The dashboards described here are essential tools for ensuring the stability, efficiency, and reliability of your service mesh environment. This page provides reference information about the Grafana dashboard configurations included in the `grafana` directory within the [Consul repository](https://github.com/hashicorp/consul/tree/main/grafana). This topic describes the configuration and usage of dashboards for monitoring and managing services within a Consul-managed Envoy service mesh. These dashboards provide critical insights into the health, performance, and resource utilization of services. The dashboards described here are essential tools for ensuring the stability, efficiency, and reliability of your service mesh environment.
This page provides reference information about the Grafana dashboard configurations included in the [`grafana` directory in the `hashicorp/consul` GitHub repository](https://github.com/hashicorp/consul/tree/main/grafana).
## Dashboards overview ## Dashboards overview

8
website/content/docs/connect/observability/grafanadashboards/servicedashboard.mdx
Unescape View File

@ -2,12 +2,12 @@
layout: docs layout: docs
page_title: Dashboard for monitoring Consul service mesh page_title: Dashboard for monitoring Consul service mesh
description: >- description: >-
This documentation provides an overview of the Service Dashboard. This documentation provides an overview of the Service Dashboard. Learn about the metrics it displays and the queries that produce the metrics.
--- ---
# Service dashboard # Service dashboard
This page provides reference information about the Grafana dashboard configuration included in [this GitHub repository](https://github.com/hashicorp/consul/blob/main/grafana/consulservicedashboard.json). The service dashboard offers an overview of the performance and health of individual services within the Consul service mesh. It provides insights into service availability, request success rates, latency, and connection metrics. This dashboard is essential for maintaining optimal service performance and quickly identifying any issues with service communications. This page provides reference information about the [Grafana dashboard configuration included in the `hashicorp/consul` GitHub repository](https://github.com/hashicorp/consul/blob/main/grafana/consulservicedashboard.json). The service dashboard offers an overview of the performance and health of individual services within the Consul service mesh. It provides insights into service availability, request success rates, latency, and connection metrics. This dashboard is essential for maintaining optimal service performance and quickly identifying any issues with service communications.
## Grafana queries overview ## Grafana queries overview
@ -31,7 +31,7 @@ sum(irate(envoy_cluster_upstream_rq_xx{envoy_response_code_class!="5", envoy_res
### Total failed request rate ### Total failed request rate
**Description:** This stat tracks the rate of failed requests (4xx and 5xx errors) for the selected service. It helps operators quickly identify if there are issues with client requests or server errors for a specific service. **Description:** This stat tracks the rate of failed requests for the selected service according to 4xx and 5xx errors. It helps operators quickly identify if there are issues with client requests or server errors for a specific service.
```promql ```promql
sum(irate(envoy_cluster_upstream_rq_xx{envoy_response_code_class=~"4|5", consul_destination_service=~"$service"}[10m])) / sum(irate(envoy_cluster_upstream_rq_xx{consul_destination_service=~"$service"}[10m])) sum(irate(envoy_cluster_upstream_rq_xx{envoy_response_code_class=~"4|5", consul_destination_service=~"$service"}[10m])) / sum(irate(envoy_cluster_upstream_rq_xx{consul_destination_service=~"$service"}[10m]))
@ -47,7 +47,7 @@ sum(rate(envoy_cluster_upstream_rq_time_sum{consul_destination_service=~"$servic
### Total failed requests ### Total failed requests
**Description:** This gauge tracks the total number of failed requests over a 10-minute window, categorized by service. It allows for easy identification of services that are experiencing high failure rates. **Description:** This gauge tracks the total number of failed requests over a 10 minute window, categorized by service. It allows for easy identification of services that are experiencing high failure rates.
```promql ```promql
sum(increase(envoy_cluster_upstream_rq_xx{envoy_response_code_class=~"4|5", consul_destination_service=~"$service"}[10m])) by(local_cluster) sum(increase(envoy_cluster_upstream_rq_xx{envoy_response_code_class=~"4|5", consul_destination_service=~"$service"}[10m])) by(local_cluster)

Write Preview
Loading…
Cancel
Save