Docs

Volcengine Kubernetes Engine

Monitoring add-ons

prometheus-adapter

The prometheus-adapter is an adapter component for cluster custom metrics. It converts Prometheus metrics into the format required by the custom metric API. This topic describes the functionality, core resources, and installation and upgrade instructions of this add-on.

Add-on overview

The prometheus-adapter add-on exposes metrics from Prometheus through the Kubernetes Custom Metrics API. This enables Horizontal Pod Autoscaler (HPA) in Kubernetes to use these metrics for autoscaling. After the add-on is installed in a cluster, the system will create the following Kubernetes resources under the kube-system namespace.

Resource name	Resource type	Resource description
Prometheus-adapter	Deployment	The core workload of the add-on. It is used to run logic for metric conversion and exposure.
Prometheus-adapter	Service	The add-on service. It provides the add-on with a stable in-cluster access point for the API Server to call.
prometheus-adapter-config	ConfigMap	The core settings of the add-on, including Prometheus native metric conversion rules. You can use this configuration file to specify custom Prometheus metrics that need to be converted and used. For details, see Achieving autoscaling based on custom metrics.

tip

The preceding table only lists the main resources of the add-on, as well as resources that may be used when the add-on or the corresponding feature is configured. This helps you understand the main components of this add-on. Other resources, such as ConfigMap and Secret, related to the add-on are not described here. You should refer to the actual resources in the cluster.

Add-on versions

For information about the historical release records of the add-on, as well as new features and optimization descriptions for each version, see Add-on release records.

Install the add-on

In the left navigation pane, click Cluster. Click the target cluster name to go to the management page of this cluster.

In the left navigation bar of the cluster management page, click Addons. On the page that appears, click the Monitoring tab.

Move the pointer over the add-on card, click Deploy, and configure the add-on parameters.

Parameter	Description
Deployment method	The deployment method of the add-on. This parameter is fixed and cannot be modified.
Deployment mode	This parameter is displayed for clusters that use the VPC-CNI network model. You can deploy the add-on on the following two types of nodes. Elastic Compute Service deployment: Deploys the add-on on ECS nodes in the cluster. Volcengine Container Instance deployment: Deploys the add-on on VCIs, which are the virtual nodes in the cluster. Fees will be incurred if you deploy the add-on on VCI. For detailed fee descriptions, see VCI service billing.
Prometheus workspace	The add-on uses the VMP workspace bound to the cluster. If you do not configure a VMP workspace for the cluster, follow the on-screen prompts to go to the Operation and maintenance configuration tab on the cluster details page and configure a VMP workspace for the cluster.

Click Confirm to finish configuration.

Upgrading add-ons

New versions of the add-on are released at irregular intervals to provide new features or fix known issues. When the add-on card displays that a new version is available, we recommend upgrading the add-on promptly. To ensure a smooth service transition, perform the upgrade during off-peak hours whenever possible. For upgrade procedures and considerations, see Upgrading add-ons.

Monitoring and alerting

Add-on observability

The stability and performance of the prometheus-adapter add-on directly affect its proper functioning and overall effectiveness. We recommend enabling add-on observability in your cluster to monitor add-on health in real time. For details, see VKE observability.

Configuring alerts

VKE provides comprehensive cluster monitoring and alerting capabilities based on VMP. You can quickly create alert rule groups by using system preset templates or configure custom alert rules by using PromQL statements based on your business requirements. You can also export preset templates in YAML format, adjust the rules, and save them as custom alert templates for reuse across multiple clusters. For details, see the following topics:

Configuring alerts through preset templates

Configuring alerts based on custom templates

Configuring alerts through custom alert rules

Preset alert templates are provided by the system based on common O&M scenarios. They are applicable to building an alert system for the first time or quickly supplementing basic monitoring items. This helps you promptly detect insufficient resources or abnormal operation of add-ons. For details about the alert rules in preset alert templates, see Preset alert templates.