采集器「华为云-EIP 带宽」配置手册¶

阅读本文前，请先阅读：

云集成

Tip

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

1. 配置结构¶

本采集器配置结构如下：

配置一（推荐）

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

Tip

采集器会自动获取地域下的所有 IAM 项目，再根据 IAM 项目获取资源

配置二（旧版兼容）

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

2. 配置示例¶

指定地域¶

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

collector_configs = {
    'regions': ['cn-north-4']
}

配置过滤器（可选项）¶

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

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

支持筛选的对象属性：

属性	描述
`id`	带宽 ID
`name`	带宽名称
`enterprise_project_id`	企业项目 ID

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

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

from integration_core__runner import Runner
import integration_huaweicloud_eip_bandwidth__main as main

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

3. 数据上报格式¶

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

上报的数据示例如下：

{
  "measurement": "huaweicloud_eip_bandwidth",
  "tags": {
    "RegionId"               : "cn-north-4",
    "project_id"             : "xxxxxxx",
    "enterprise_project_id"  : "0",
    "name"                   : "15e410a4-xxxxxx",
    "bandwidth_id"           : "15e410a4-xxxxxx",
    "bandwidth_name"         : "bandwidth-xxxx",
    "bandwidth_type"         : "bgp",
  },
  "fields": {
    "admin_state"            : "NORMAL",
    "bandwidth_rules"        : "[{带宽规则对象}]",
    "created_at"             : "2023-07-10T11:46:23Z",
    "updated_at"             : "2023-07-10T11:47:25Z",
    "ingress_size"           : "10",
    "publicip_info"          : "{弹性公网 IP 信息}",
    "rule_quota"             : "0",
    "size"                   : "10",
    "tags"                   : "{实例 tags}",
    "message"                : "{实例 JSON 数据}"
  }
}

Note

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

Tip

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

X. 附录¶

华为云 EIP 带宽「地域 ID」¶

请参考华为云官方文档：

华为云 EIP 地域/节点