采集器「华为云-ELB」配置手册¶
阅读本文前,请先阅读:
Tip
使用本采集器前,必须安装「集成 Core 核心包」及其配套的第三方依赖包
1. 配置结构¶
本采集器配置结构如下:
字段 | 类型 | 是否必须 | 说明 |
---|---|---|---|
region_projects |
dict | 必须 | 所需采集数据的「地域 - 项目 ID」列表 |
region_projects[#] |
str:list | 必须 | 键值对中: Key 代表地域(如: 'cn-north-4' )Value 代表该地域下所需采集的项目 ID 列表 总表见附录 |
2. 配置示例¶
配置过滤器(可选项)¶
本采集器脚本支持用户自定义过滤器,让用户通过对象属性筛选出目标资源。过滤器函数返回值为 True|False
-
True:目标资源需要被采集。
-
False 目标资源不需要被采集
支持筛选的对象属性:
配置一(推荐)
字段 | 类型 | 是否必须 | 说明 |
---|---|---|---|
regions |
list | 必须 | 所需采集的地域列表 |
regions[#] |
str | 必须 | 地域 ID。如:'cn-north-4' 总表见附录 |
Tip
采集器会自动获取地域下的所有 IAM 项目,再根据 IAM 项目获取资源
配置二(旧版兼容)
属性 | 描述 |
---|---|
name | 实例 ID |
description | 实例描述 |
id | 实例 ID |
instance_name | 实例 name |
project_id | 项目 ID |
operating_status | 实例运行状态 |
# 示例:开启过滤器,根据对象的 id 和 instance_name 属性过滤,配置格式如下:
def filter_instance(instance):
'''
采集 instance_id 为 'xxxx' 和 instance_name 为 'xxxx' 的实例
'''
# return True
instance_id = instance['id']
instance_name = instance['instance_name']
if instance_id in ['xxxx'] and instance_name in ['xxxx']:
return True
return False
###### Do not modify the following contents #####
from integration_core__runner import Runner
import integration_huaweicloud_elb__main as main
@DFF.API('HuaweiCloud ELB Collection', timeout=3600, fixed_crontab='*/15 * * * *')
def run():
Runner(main.DataCollector(account, collector_configs, filters=[filter_instance])).run()
3. 数据上报格式¶
数据正常同步后,可以在 观测云 的「基础设施-资源目录」中查看数据。
上报的数据示例如下:
{
"measurement": "huaweicloud_elb",
"tags": {
"RegionId" : "cn-north-4",
"project_id" : "c631f046252d4ebdaxxxxxxxxxx",
"enterprise_project_id": "0",
"name" : "e9cb54b0-63e0-46c5xxxxxxxx",
"instance_id" : "e9cb54b0-63e0-46c5xxxxxxxxxx",
"instance_name" : "elb-xxxx",
},
"fields": {
"description" : "",
"operating_status" : "ONLINE",
"created_at" : "2022-06-22T02:41:57",
"listeners" : "{实例 JSON 数据}",
"updated_at" : "2022-06-22T02:41:57",
"message" : "{实例 JSON 数据}"
}
}
Note
tags、fields 中的字段可能会随后续更新有所变动
Tip
tags.name 值为实例 ID,作为唯一标识
!!! tip
- `fields.message`、`fields.listeners`为 JSON 序列化后字符串。
- `tags.operating_status`为负载均衡器的操作状态。取值范围:可以为 ONLINE 和 FROZEN。
X. 附录¶
请参考华为云官方文档: