采集器「华为云-ECS」配置手册

阅读本文前，请先阅读：

• 观测云集成 / 基本操作

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

1. 配置结构

本采集器配置结构如下：

字段	类型	是否必须	说明
region_projects	dict	必须	所需采集数据的「地域 - 项目 ID」列表
region_projects[#]	str:list	必须	键值对中： Key 代表地域（如：'cn-north-4'） Value 代表该地域下所需采集的项目 ID 列表 总表见附录

2. 配置示例

指定地域

采集cn-north-4地域下对应项目的 ECS 实例数据

collector_configs = {
    'region_projects':{
        'cn-north-4': ['c631f046252d4exxxxxxxxxxx', '15c6ce1c12da40xxxxxxxx9']
    }
}

配置过滤器（可选项）

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

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

支持筛选的对象属性：

属性	描述
status	实例状态
id	实例ID
name	实例名称
enterprise_project_id	企业项目 ID
vpc_id	虚拟云 ID

# 示例：开启过滤器，根据对象的 name、id 属性过滤，配置格式如下：

def filter_instance(instance):
    '''
    采集 id 为 i-xxxxxa, i-xxxxxb 且 name 为 test 的指标
    '''
    instance_id = instance['id']
    name = instance['name']
    if instance_id in ['i-xxxxxa', 'i-xxxxxb'] and name in ['test']:
        return True
    return False

from guance_integration__runner import Runner
import guance_huaweicloud_ecs__main as main

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

3. 数据上报格式

数据正常同步后，可以在观测云的「基础设施-资源目录」中查看数据。

上报的数据示例如下：

{
  "measurement": "huaweicloud_ecs",
  "tags": {
    "RegionId"                            : "cn-north-4",
    "project_id"                          : "xxxxxxx",
    "enterprise_project_id"               : "xxxxxxx",
    "name"                                : "xxxxx",
    "instance_id"                         : "xxxxx",
    "instance_name"                       : "ecs-3384",
    "status"                              : "ACTIVE"
  },
  "fields": {
    "OS-EXT-AZ:availability_zone"         : "cn-southeast-1",
    "vpc_id"                              : "3dda7d4b-aec0-4838-a91a-28xxxxxxxx",
    "charging_mode"                       : "0",
    "resource_spec_code"                  : "sn3.small.1.linux",
    "resource_type"                       : "1",
    "metadata_os_type"                    : "Linux",
    "hostId"                              : "1e122315dac18163814b9e0d0fc6xxxxxx",
    "created"                             : "2022-06-16T10:13:24Z",
    "description"                         : "{JSON 数据}",
    "addresses"                           : "{IPJSON 数据}",
    "os-extended-volumes:volumes_attached": "{JSON 数据}",
    "message"                             : "{实例 JSON 数据}"
  }
}

部分参数说明如下：

参数名称	说明
resource_spec_code	资源规格
resource_type	云服务器对应的资源类型

charging_mode（云服务器付费类型）取值含义：

取值	说明
0	按需计费（即 postPaid-后付费方式）
1	包年包月计费（即 prePaid-预付费方式）
2	竞价实例计费

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

tags.name 值为实例 ID，作为唯一标识

status 取值范围及对应含义请见附录云服务器状态

X. 附录

华为云 ECS「地域 ID」

请参考华为云官方文档：

• 华为云 地域 ID
• 华为云 云服务器状态