跳转至

采集器「火山云-ECS」配置手册

阅读本文前，请先阅读：

使用本采集器前，必须安装「观测云集成 Core 核心包」及其配套的第三方依赖包

1. 配置结构

本采集器配置结构如下：

字段 类型 是否必须 说明
regions list 必须 所需采集的地域列表
regions[#] str 必须 地域 ID。如：'cn-shanghai'
总表见附录

2. 配置示例

指定地域

采集上海地域的数据

Python
1
2
3
collector_configs = {
    'regions': [ 'cn-beijing' ]
}

配置过滤器（可选项）

本采集器脚本支持用户自定义过滤器，让用户通过对象属性筛选出目标资源。过滤器函数返回值为 True｜False

  • True：目标资源需要被采集。

  • False 目标资源不需要被采集

支持筛选的对象属性：

属性 描述
InstanceId 实例 ID
InstanceName 实例名称
ZoneId 可用区 ID
Hostname 实例主机名
VpcId 私有网络 ID
Cpus CPU 数量
OsType 操作系统类型，取值：Linux、Windows
MemorySize 内存大小，单位：MiB
Python
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
# 示例：开启过滤器，根据对象的 InstanceId 和 name 属性过滤，配置格式如下：
def filter_instance(instance):
    '''
    采集 instance_id 为 xxxxx 或者 instance_name 为 xxxxx 的实例
    '''
    # return True
    instance_id = instance['InstanceId']
    instance_name = instance['name']
    if instance_id in ['xxxxx'] or instance_name in ['xxxxx']:
        return True
    return False


###### Do not modify the following contents #####
from guance_integration__runner import Runner
import guance_volcengine_ecs__main as main


@DFF.API('Volcengine-ECS Collection', timeout=3600, fixed_crontab='*/15 * * * *')
def run():
    Runner(main.DataCollector(account, collector_configs, filters=[filter_instance])).run()

3. 数据上报格式

数据正常同步后，可以在观测云的「基础设施 / 自定义（对象）」中查看数据。

上报的数据示例如下：

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
{
  "measurement": "volcengine_ecs",
  "tags": {
    "Cpus": "1",
    "DeploymentSetGroupNumber": "0",
    "DeploymentSetId": "",
    "ElasticScheduledInstanceType": "NoEsi",
    "Hostname": "iv-xxx",
    "ImageId": "image-xxx",
    "InstanceChargeType": "PostPaid",
    "InstanceId": "i-xxx",
    "InstanceName": "ECS-0XQq",
    "InstanceTypeId": "ecs.s2-c1m2.small",
    "KeyPairId": "kp-xxx",
    "KeyPairName": "zsh-xxx",
    "MemorySize": "2048",
    "OsName": "CentOS Stream 9 64位",
    "OsType": "Linux",
    "ProjectName": "default",
    "RegionId": "cn-beijing",
    "ScheduledInstanceId": "",
    "Status": "RUNNING",
    "Uuid": "000c65ee-xxx",
    "VpcId": "vpc-xxx",
    "ZoneId": "cn-beijing-b",
    "name": "i-xxxx"
  },
  "fields": {
    "CpuOptions": "{CPU配置详情}",
    "CreatedAt": "2024-03-11T14:01:05+08:00",
    "Description": "",
    "LocalVolumes": "[实例对应的本地盘配置信息]",
    "NetworkInterfaces": "[实例挂载的网卡信息]",
    "RdmaIpAddresses": "[当查询高性能计算GPU型实例时，列表形式返回各网卡的RDMA IP地址]",
    "UpdatedAt": "2024-03-13T10:14:00+08:00",
    "message": "{实例 JSON 数据}"
  }
}

tags、fields 中的字段可能会随后续更新有所变动

tags.name 值为实例 ID，作为唯一标识，fields.message、fields.CpuOptions、fields.LocalVolumes、fields.NetworkInterfaces、fields.RdmaIpAddresses 均为 JSON 序列化后字符串

X. 附录

请参考火山云官方文档：