Chapter 2. Configuring observability metrics
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. Note 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-metrics instance, with a custom resource configuration as follows: 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: Note This 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: Note You 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 information 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 .
apply -f https://raw.githubusercontent.com/Kuadrant/kuadrant-operator/v1.0.1/config/observability/openshift/kube-state-metrics.yaml apply -k https://github.com/Kuadrant/gateway-api-state-metrics/config/kuadrant?ref=0.6.0 apply -f https://raw.githubusercontent.com/Kuadrant/kuadrant-operator/v1.0.1/config/observability/openshift/telemetry.yaml apply -f https://raw.githubusercontent.com/Kuadrant/kuadrant-operator/v1.0.1/config/observability/prometheus/monitors/operators.yaml