Docs

Volcengine Managed Service for Prometheus

Cloud service integration

Custom ECS integration

Volcengine Managed Service for Prometheus supports ECS integration to meet users' unified monitoring needs for cloud basic resources and custom business services. This topic describes the procedure for integrating an ECS instance.

Background information

ECS serves as a cloud virtual server that is secure, stable, and scalable, and provides resources such as CPU, memory, disk, and network. You can use ECS to create a business environment that is elastic, available, secure, and reliable to effectively reduce IT maintenance costs.

You can monitor basic ECS instance resources or custom applications deployed on ECS instances by integrating them into VMP.

tip

For more details about ECS, refer to the documentation of ECS.

Prerequisites

VMP and ECS have been activated.

A VMP workspace has been created. For details, see Creating workspaces.

An ECS instance is created. For details, see Creating ECS instances.

When monitoring basic ECS resources, please confirm that the monitoring add-ons (cloud-monitor-agent, node-exporter, etc.) are installed on the ECS instance. For details, see How do I handle the "Cloud-monitor-agent unable to collect monitoring data" issue on ECS instances?

When monitoring custom business on ECS, please confirm the custom business is deployed, and the metric interface is exposed, or the corresponding exporter is deployed.

Security groups are configured. For details, please refer to Creating Security Groups.

Create the security group used by the managed collector, and allow the subnet and port of the ECS instance in the outbound rule.

Configure the security group to which the ECS belongs, and allow the security group used by the managed collector to access the corresponding port in the inbound rule.

tip

The VMP workspace and the target ECS instance must be deployed in the same region.

Procedure

In the top navigation bar, select the target region.

In the left navigation bar, click Integration Center > Component. On the page that appears, click Elastic Computing Services custom scraping.

(Optional) Service authorization.

When you configure an ECS integration task for the first time, you need to grant permissions to allow VMP to access ECS and VPC. Click Authorize to configure service authorization.

Click Authorize Now to authorize VMP to access other services.

Configure integration task details.

Parameter	Description
Task name	Configure the name of the integration task.
workspace	Select a created VMP workspace.
ECS VPC	Select the VPC where the ECS instance is located.
Security group	Select the security group for the hosted collector to use, which allows the hosted collector to access resources in the VPC of the user. warning To ensure that the hosted collector can collect the metrics of the ECS instance as expected, add the target CIDR block and port of the ECS instance to the outbound access rules of the selected security groups.
Subnet	Select one or more subnets. This setting is mainly for connecting networks. This setting can be used together with Filtering ECS objects by subnet to specify a granular ECS scope for metric collection.
Filtering ECS objects by subnet	Specify the ECS scope for metric collection. Disable: (default) Do not use subnet filtering. The system will perform ECS service discovery within the selected VPC, and collect metrics from all ECS instances within all subnets in the VPC. Enable: Use subnet filtering. The system will perform ECS service discovery within the specified subnet of the VPC and collect metrics only from ECS instances within the specified subnet.

The Job configuration includes items such as the collection time interval, collection timeout, collection protocol, and port number. You can configure multiple groups of jobs for a task.

Currently, three service discovery configurations are available:

Service discovery configuration	Configuration example
volc_sd_configs	The default service discovery configuration. The following is an example: volc_sd_configs: - port: 9091 # Required. The port number for collecting metrics. project_name: project_a # Optional. ECS instances are filtered by project. tag_filters: # Optional. ECS instances are filtered by label. - key: ecs-label # The label name for filtering ECS instances. values: ["demo-a", "demo-b"] # The label value for filtering ECS instances. instance_ids: # Optional. ECS instances are filtered by ID. - i-ycpy3h* - i-ycroi4* instance_name: ecs-demo # Optional. ECS instances can be filtered by name using fuzzy matching.
http_sd_configs	The service discovery configuration that is natively supported by Prometheus. With no ecosystem dependencies, the configuration applies to scenarios where a complex service discovery mechanism is not required and various backends are flexibly integrated, such as lightweight architectures without a service registry or integration with a custom registry. For more details, see the official documentation. Sample code: http_sd_configs: - url: 'https://service-discovery.example.com/targets' # Required. The HTTP or HTTPS endpoint for getting a list of targets. refresh_interval: 15s # Optional. The time interval of pulling the target list. timeout: 8s # The timeout for a single request to the endpoint. basic_auth: # Optional. Basic authentication (username and password). username: 'prometheus-sd' # Username. password: 'secure-pass-123' # Password. tls_config: # Optional. The TLS configuration for secure communication with an HTTPS endpoint. ca_file: '/etc/prometheus/root-ca.crt' # Client certificate for mutual authentication. server_name: 'service-discovery.example.com' # Hostname for verifying the server certificate. insecure_skip_verify: false # Whether to skip certification verification. You are advised against skipping certification verification in production environments.
consul_sd_configs	The service discovery configuration that is natively supported by Prometheus. It natively integrates with Consul, offering a high degree of automation. It applies to scenarios where the Consul service mesh has been deployed, or large-scale dynamic monitoring is required, such as the scenario where Consul is deployed as a service registry, monitoring of large-scale microservices clusters, and multi-data center environments. For more details, see the official documentation. Sample code: consul_sd_configs: - server: 'consul-server:8500' # Required. The HTTP API address of the Consul service. datacenter: 'dc-prod' # Optional. The name of the Consul data center, which must be consistent with the Consul cluster configuration. services: ['user-service', 'order-service', 'payment-*'] # Optional. The services to be monitored. Wildcards are supported. health_check: true # Optional. Whether to retain only instances for which the Consul health check status is passing. We recommend that you enable this feature in production environments. acl_token_file: '/etc/prometheus/consul-acl-token.txt' # Optional. The file path where the Consul ACL token is stored. You can read the ACL token from the file. timeout: 8s # Optional. The Consul connection timeout.

The following content is a complete example of Job configuration in which the service discovery configuration volc_sd_configs is used.

tip

For more configuration item descriptions, refer to the official documentation.

The job configurations will take effect about 1 minute after modification and deployment. Please wait patiently.

When you configure multiple filter conditions for ECS instances, the conditions are in an AND relationship. In this way, only ECS instances that meet all conditions will be identified and monitored.

Click Confirm to complete the configuration.

Validate results

After the configuration is complete, you can view the status and details of the task. Check whether the target ECS instance is integrated with VMP properly.

Select Access Center > Access Jobs in the left navigation bar and select the managed environment tab.

Select the target job in the job list, click the job name, and enter the access job details. Select the Target List tab to view the ECS instances properly integrated with Volcengine Managed Service for Prometheus.