采集器「华为云-RDS-MariaDB」配置手册¶

阅读本文前，请先阅读：

云集成

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地域对应项目的 RDS-MariaDB 实例数据

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

配置过滤器（可选项）¶

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

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

支持筛选的对象属性：

属性	描述
id	实例 ID
port	实例端口
engine	实例引擎

# 示例：开启过滤器，根据对象的 id 和 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_rds__main as main

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

3. 数据上报格式¶

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

上报的数据示例如下：

{
  "measurement": "huaweicloud_rds",
  "tags": {
    "RegionId"               : "cn-north-4",
    "project_id"             : "c631f046252dxxxxxxxf253c62d48585",
    "enterprise_project_id"  : "0",
    "name"                   : "xxxxxxxxxxxx",
    "instance_id"            : "xxxxxxxxxxxx",
    "instance_name"          : "rds-df54-xxxx",
    "status"                 : "ACTIVE",
    "type"                   : "Single",
    "engine"                 : "MariaDB"
  },
  "fields": {
    "security_group_id"      : "d13ebb59-d4fe-xxxx-xxxx-c22bcea6f987",
    "switch_strategy"        : "xxx",
    "time_zone"              : "UTC+08:00",
    "enable_ssl"             : "False",
    "charge_info.charge_mode": "postPaid",
    "engine_version"         : "5.7",
    "port"                   : "3306",
    "created_time"           : "2022-06-21T06:17:27+0000",
    "updated_time"           : "2022-06-21T06:20:03+0000",
    "alias"                  : "xxx",
    "private_ips"            : "[\"192.xxx.x.144\"]",
    "public_ips"             : "[]",
    "datastore"              : "{数据库信息}",
    "cpu"                    : "2",
    "mem"                    : "4",
    "volume"                 : "{volume 信息}",
    "nodes"                  : "[{主备实例信息}]",
    "related_instance"       : "[]",
    "backup_strategy"        : "{备份策略}",
    "message"                : "{实例 JSON 数据}"
  }
}

Note

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

Tip

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

Tip

以下字段均为 JSON 序列化后字符串

fields.message
fields.private_ips
fields.public_ips
fields.volume
fields.nodes
fields.related_instance
fields.backup_strategy

Tip

type 取值为 Single、Ha、Replica 或 Enterprise，分别对应于单机实例、主备实例、只读实例、分布式实例（企业版）

X. 附录¶

华为云 RDS「地域 ID」¶

请参考华为云官方文档：