Docs

Volcengine Kubernetes Engine

Metric alerts

Configuring alerts based on custom templates

VKE provides comprehensive cluster monitoring and alert capabilities based on VMP. The capabilities cover typical scenarios such as the control plane, nodes, networks, workloads, and AI training tasks. This topic describes how to configure alerts by using custom templates in VMP.

Prerequisites

The cloud-native observability feature has been enabled. For details, see Enabling observability.

An alert notification object or policy has been created. For details, see Creating contacts, Creating contact groups, and Creating alert notification policies.

tip

Alert rules are defined by PromQL statements. We recommend that you first understand basic PromQL concepts and the meaning of the metrics exposed by monitoring targets. For details, see Getting started with PromQL.

Procedure

Step 1: Export a preset template

Select the target region in the top navigation bar.

In the left navigation pane, click Alarm Center > Alarm Rule Template.

Click the Preset template tab, and select Kubernetes Engine from the Template type drop-down list.

Select the target template and click Export to export the YAML file of the preset template to your local machine.

Step 2: Configure a custom template

Modify the content of the template YAML file based on your actual requirements.

Adjust the rule name, PromQL query, threshold, duration, and variable definitions in items.

Add or remove rule items to meet your own business requirements.

Click the Custom template tab and click YAML file import to import the modified template file.

Click Next to configure the basic information about the template.

Click Confirm.

Step 3: Configure alerts using the custom template

In the list on the Custom template tab, find the custom template you imported, click Apply template in the Actions column, and use the custom template to configure alerts.

Configure alert rule group details.

Specify the basic information about the alert rule group.

Select the workspace bound to the cluster, alert notification policy, and variables.

Check whether each rule and its corresponding threshold meet your requirements. You can disable specified rules or modify the alert thresholds of specified rules.

Click Confirm. The system automatically generates the corresponding alert rule group.

Validate results

View settings

After the alert rule is created, you can view the rule status in the alert rule list of the VMP console.

When an alert is generated, you can view the trigger records on the Alert event page and troubleshoot issues by referencing the add-on status, Pod events, and logs in the VKE console.

Receive alerts

After you have completed alert-related configuration, when an alert that matches the defined rules is triggered, a notification will be sent through the specified alert channel. You will receive the alert notification details through the channel.