Control plane observability allows you to monitor the status of core components of the control plane in a cluster. This topic describes how to configure control plane observability.
Prerequisites
Step 1: Configure observability items
- In the left navigation pane, click Cluster. Find the target cluster and click its name.
- In the left navigation pane of the cluster management page, click Observability settings, and select the Basic observability tab.
- Find the Control plane service card and click Enable observation to go to the observability item configuration page.
- The system automatically checks the necessary conditions for enabling observability, such as the workspace configuration and add-on status.
- For the Observation item parameter, select observability items for which you want to collect metrics. For items for which metric collection is not enabled, the system will not collect the corresponding metrics, and the system will prompt you to install the related add-ons. You can decide whether to install the related add-ons and select the corresponding observability items based on your business requirements.
- After the configuration is complete, click Next to go to the alert and notification configuration page.
Step 2: Configure alerts and notifications
- In the Alert and notification step, select the platform to receive alerts. Currently, Unified Alert Center and The original VMP alarm strategy are supported.
- For the Notification strategy name parameter, select the created alert notification policy and specify the notification object and Notification method parameters based on different alert levels.
tip
- If you do not need to configure alerts for a certain level, you can unselect the corresponding alert level.
- If the existing notification policies do not meet your needs, you can select vke_default_notify_policy (automatically created) for the Notification strategy name parameter, and specify the notification object and Notification method parameters for the required alert levels. After you save the configuration, the system will automatically create a custom notification policy named vke_default_notify_policy in the unified Alert Center or VMP.
- In the Alerting aggregation policy section, select the created alert aggregation policy.
- Configure preset alert rules.
- Enable or disable the switch next to a preset alert rule. After it is enabled, the system detects metrics based on the configured trigger conditions and generates alerts. When it is disabled, the rule will no longer trigger new alerts.
- Click View PromQL to view the description and corresponding PromQL statement of the current preset alert rule.
- Click the name of the preset rule to be configured to expand the preset alert rule configuration page, and configure the trigger conditions for different levels (P0, P1, or P2) of alerts in the Triggering condition section.
- Click Complete the configuration.
Description
- In addition to using preset alert templates to configure alert rules directly, you can customize the template configurations or directly use PromQL statements to configure alert rules. For details, see Alert configuration overview.
- Details of the preset alert rule templates, including rule descriptions, PromQL configurations, and common alert handling procedures. See Preset alert templates.
Observability dashboards
tip
The built-in dashboards provide features such as period-over-period comparisons of monitoring data and the ability to copy dashboard queries. For details, see Using dashboards. kube-apiserver monitoring
After you enable control plane monitoring, you can view the metrics of the control plane components in dashboards. Set the query time range and specify the refresh mode (manual or automatic).
- In the left navigation pane of the cluster management page, click Monitoring center > Dashboard.
- In the left dashboard list, click Core addon monitoring > Kube-apiserver monitoring to view the monitoring dashboard.
- The following table describes the charts related to APF rate limiting on the kube-apiserver dashboard.
Description
For the method of obtaining the PromQL statements that correspond to the charts, see Using dashboards. After you enable control plane monitoring, you can view the metrics of the control plane components in dashboards. Set the query time range and specify the refresh mode (manual or automatic).
- In the left navigation pane of the cluster management page, click Monitoring center > Dashboard.
- In the left dashboard list, click Core addon monitoring > ETCD monitoring to view the monitoring dashboard.
kube-scheduler monitoring
After you enable control plane monitoring, you can view the metrics of the control plane components in dashboards. Set the query time range, select an instance, and specify the refresh mode (manual or automatic).
- In the left navigation pane of the cluster management page, click Monitoring center > Dashboard.
- In the left dashboard list, click Core addon monitoring > Kube-scheduler monitoring to view the monitoring dashboard.
cluster-autoscaler monitoring
After you enable control plane monitoring, you can view the metrics of the control plane components in dashboards. Set the query time range, select an instance, and specify the refresh mode (manual or automatic).
- In the left navigation pane of the cluster management page, click Monitoring center > Dashboard.
- In the left dashboard list, click Core addon monitoring > Cluster-autoscaler monitoring to view the monitoring dashboard.
kube-controller-manager monitoring
After you enable control plane monitoring, you can view the metrics of the control plane components in dashboards. Set the request quantile and query time range, and specify the refresh mode (manual or automatic).
- In the left navigation pane of the cluster management page, click Monitoring center > Dashboard.
- In the left dashboard list, click Core addon monitoring > Kube-controller-manager monitoring to view the monitoring dashboard.
- The kube-controller-manager monitoring dashboard consists of three parts: Resource, Workqueue, and Kube API. The following table provides detailed descriptions of the charts.
Description
For the method of obtaining the PromQL statements that correspond to the charts, see Using dashboards. View metrics
- To query integrated or non-integrated metrics in the cluster, or to understand metric meanings, see Querying metrics.
- You can use the Explore feature of VMP to quickly query and display metric data. For details, see Querying metrics.