Chapter 4. Configuring observability dashboards and alerts
Connectivity Link provides starting points for monitoring your Connectivity Link deployment by using example dashboards and alerts, which are ready-to-use and customizable to fit your environment.
The Connectivity Link example dashboards are uploaded to the Grafana dashboards website. You can import the following dashboards into your Grafana deployment on OpenShift:
Name | Dashboard ID |
---|---|
21538 | |
20982 | |
20981 |
This section explains how to enable the example dashboards and alerts and provides links additional resources for more information.
You must perform these steps on each OpenShift cluster that you want to use Connectivity Link on.
Prerequisites
- You have configured observability as described in Chapter 3, Enabling observability in Connectivity Link.
4.1. Configuring Grafana dashboards Copy linkLink copied to clipboard!
You can import dashboards in the Grafana user interface, or automatically by using custom resources in OpenShift:
- Importing dashboards in Grafana
Click Dashboards > New > Import, and use one of the following options:
- Upload a dashboard JSON file.
- Enter a dashboard ID obtained from the Grafana dashboards website.
Enter JSON content directly.
For more information, see the Grafana documentation on how to import dashboards.
- Importing dashboards automatically in OpenShift
You can automate dashboard provisioning in Grafana by adding JSON files to a
ConfigMap
, which must be mounted at/etc/grafana/provisioning/dashboards
.TipAlternatively, to avoid adding
ConfigMap
volume mounts in your Grafana deployment, you can use aGrafanaDashboard
resource to reference aConfigMap
. For an example, see Dashboard from ConfigMap in the Grafana documentation.Data sources are configured as template variables, automatically integrating with your existing data sources. The metrics for these dashboards are sourced from Prometheus.
For some example dashboard panels to work correctly, HTTPRoutes in Connectivity Link must include a service
and deployment
label with a value that matches the name of the service and deployment being routed to, for example, service=my-app
and deployment=my-app
. This allows low-level Istio and Envoy metrics to be joined with Gateway API state metrics.
Additional resources
4.2. Configuring Prometheus alerts Copy linkLink copied to clipboard!
You can integrate the Kuadrant example alerts into Prometheus as PrometheusRule
resources, and then adjust the alert thresholds to suit your specific operational needs.
Service Level Objective (SLO) alerts generated by using the Sloth GitHub project are also included. You can use these alerts to integrate with the SLO Grafana dashboard, which uses generated labels to comprehensively overview your SLOs.
For details on how to configure Prometheus alerts, see the OpenShift documentation on managing alerting rules.