Red Hat SummitQuesto contenuto non è disponibile nella lingua selezionata.
Connectivity Link observability guide
Observe and monitor Gateways, APIs, and applications on OpenShift
Abstract
Preface
Providing feedback on Red Hat documentation
Red Hat appreciates your feedback on product documentation.
To propose improvements, open a Jira issue and describe your suggested changes. Provide as much detail as possible to help the documentation team to address your request quickly.
Prerequisite
- You have a Red Hat Customer Portal account. This account enables you to log in to the Red Hat Jira Software instance. If you do not have an account, you will be prompted to create one.
Procedure
- Click the following link: Create issue.
- In the Summary text box, enter a brief description of the issue.
In the Description text box, provide the following information:
- The URL of the page where you found the issue.
- A detailed description of the issue. You can leave the information in other fields at their default values.
- In the Reporter field, enter your Jira user name.
- Click Create to submit the Jira issue to the documentation team.
Thank you for taking the time to provide feedback.
Chapter 1. Connectivity Link observability
You can use the Connectivity Link observability features to observe and monitor your cloud-based applications, APIs, and Gateways.
1.1. Connectivity Link observability features
Connectivity Link uses Kuadrant-maintained Gateway API state metrics, metrics exposed by Connectivity Link components, and standard metrics exposed by Envoy to build a set of template dashboards and alerts.
You can download and use these Kuadrant community templates to integrate with Grafana, Prometheus, and Alertmanager deployments, or use them as starting points to modify for your specific needs.
Figure 1.1. Platform engineer Grafana dashboard
The platform engineer dashboard displays details such as the following:
- Policy compliance and governance.
- Resource consumption.
- Error rates.
- Request latency and throughput.
- Multi-window, multi-burn alert templates for API error rates and latency.
- Multicluster split.
Figure 1.2. Application developer Grafana dashboard
The application developer dashboard is less focused on policies than the platform engineer dashboard and is more focused on APIs and applications. For example, this includes details such as request latency and throughput per API, and total requests and error rates by API path.
Figure 1.3. Business user Grafana dashboard
The business user dashboard includes details such as the following:
- Requests per second per API.
- Increase or decrease in rates of API usage over specified times.
Chapter 2. Configuring observability metrics
The example dashboards and alerts provided by Connectivity Link use metrics exported by Connectivity Link and Gateway API components to provide insight into your applications, APIs, and Gateways. While not essential, it is best to configure these metrics and set up these dashboards and alerts on your OpenShift cluster.
The example dashboards and alerts for observing Connectivity Link functionality use low-level CPU metrics and network metrics available from the user monitoring stack in OpenShift and resource state metrics from Gateway API and Connectivity Link resources.
This section provides links to OpenShift documentation on how to configure monitoring and metrics storage and shows how to configure resources to scrape the relevant metrics.
You must perform these steps on each OpenShift cluster that you want to use Connectivity Link on.
Prerequisites
- You have installed Connectivity Link as described in Installing Connectivity Link on OpenShift.
- You have set up monitoring for user-defined projects as described in the OpenShift monitoring documentation.
Procedure
When monitoring for user projects is enabled in OpenShift, this allows the scraping of metrics from the Gateway and Connectivity Link components. To scrape additional metrics in OpenShift, you can install a
kube-state-metricsinstance, with a custom resource configuration as follows:kubectl apply -f https://raw.githubusercontent.com/Kuadrant/kuadrant-operator/v1.0.1/config/observability/openshift/kube-state-metrics.yaml kubectl apply -k https://github.com/Kuadrant/gateway-api-state-metrics/config/kuadrant?ref=0.6.0
kubectl apply -f https://raw.githubusercontent.com/Kuadrant/kuadrant-operator/v1.0.1/config/observability/openshift/kube-state-metrics.yaml kubectl apply -k https://github.com/Kuadrant/gateway-api-state-metrics/config/kuadrant?ref=0.6.0Copy to Clipboard Copied! Toggle word wrap Toggle overflow Some example dashboards aggregate data by request path. By default, OpenShift Service Mesh metrics do not include labels for request paths, however, you can enable these labels as follows:
kubectl apply -f https://raw.githubusercontent.com/Kuadrant/kuadrant-operator/v1.0.1/config/observability/openshift/telemetry.yaml
kubectl apply -f https://raw.githubusercontent.com/Kuadrant/kuadrant-operator/v1.0.1/config/observability/openshift/telemetry.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow NoteThis might lead to a high cardinality label where multiple time series are generated, which can have an impact on performance and resource usage. For more details, see the Reliable Insights blog post on cardinality.
You can configure scraping of metrics from the various Connectivity Link Operators as follows:
kubectl apply -f https://raw.githubusercontent.com/Kuadrant/kuadrant-operator/v1.0.1/config/observability/prometheus/monitors/operators.yaml
kubectl apply -f https://raw.githubusercontent.com/Kuadrant/kuadrant-operator/v1.0.1/config/observability/prometheus/monitors/operators.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow NoteYou must apply additional configuration so that all relevant metrics are scraped. However, this configuration depends on how you deploy your Gateway later. For details on the required steps, see Configuring and deploying Gateway policies with Connectivity Link.
Additional resources
- For details on how to enable metrics in OpenShift Service Mesh, see the OpenShift Service Mesh metrics documentation.
- For more details on Connectivity Link component metrics, see the Kuadrant metrics documentation.
Chapter 3. Configuring observability dashboards and alerts
Connectivity Link provides a variety of 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 metrics as described in Chapter 2, Configuring observability metrics.
- You have installed and set up Grafana on OpenShift. For an example, see Installing Grafana on Openshift for Kaudrant Observability.
3.1. Configuring example Grafana dashboards
You can import dashboards into Grafana by using its user interface, or automatically by using custom resources in OpenShift:
- Importing dashboards in the Grafana UI
- JSON file: Use the Import feature in the Grafana UI to upload dashboard JSON files directly.
Dashboard ID: Use the Import feature in the Grafana UI to import via Grafana.com using a dashboard ID.
You can download the JSON file or copy the dashboard ID from the relevant dashboard page on Grafana dashboards website. For more information, see the Grafana documentation on how to import dashbords.
- 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
ConfigMapvolume mounts in your Grafana deployment, you can use aGrafanaDashboardresource 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. Metrics for these dashboards are sourced from Prometheus. For more information, see the Kuadrant documentation on metrics.
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
3.2. Configuring example Prometheus alerts
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.
Appendix A. Using your Red Hat subscription
Red Hat Connectivity Link is provided through a software subscription. To manage your subscriptions, access your account at the Red Hat Customer Portal.
Managing your subscriptions
- Go to access.redhat.com.
- If you do not already have an account, create one.
- Log in to your account.
- In the menu bar, click Subscriptions to view and manage your subscriptions.
Revised on 2025-05-14 11:02:14 UTC
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}