采集器「阿里云-POLARDB」配置手册

阅读本文前，请先阅读：

• 观测云集成 / 基本操作

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

1. 配置结构

本采集器配置结构如下：

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

2. 配置示例

指定地域

采集杭州地域的数据

collector_configs = {
    'regions': [ 'cn-hangzhou']
}

配置过滤器（可选项）

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

支持筛选的对象属性：

属性	描述
DBClusterId	集群 ID
VpcId	VPC ID
DBNodeNumber	节点数量
PayType	付费类型
DBType	数据库类型
LockMode	集群的锁定状态
DBVersion	数据库版本
DBClusterNetworkType	集群的网络类型
ZoneId	可用区 ID
Engine	集群引擎
RegionId	地域 ID
Category	集群系列
DBClusterDescription	集群描述
DBNodeIds	节点 ID

# 示例：开启过滤器，根据对象的 DBClusterId 和 DBType 属性过滤，配置格式如下：

def filter_cluster(cluster):
    cluster_id = cluster['DBClusterId']
    db_type = cluster['DBType']
    if cluster_id in ['xxx'] and db_type in ['MySQL']:
        return True
    return False

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

def run():
    Runner(main.DataCollector(account, collector_configs, filters=[filter_cluster])).run()

3. 数据上报格式

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

上报的数据示例如下：

{
  "measurement": "aliyun_polardb",
  "tags": {
    "name"                : "pc-xxxx",
    "RegionId"            : "cn-hangzhou",
    "VpcId"               : "vpc-xxxx",
    "DBNodeNumber"        : "2",
    "PayType"             : "Postpaid",
    "DBType"              : "MySQL",
    "LockMode"            : "Unlock",
    "DBVersion"           : "8.0",
    "DBClusterId"         : "pc-xxxx",
    "DBClusterNetworkType": "VPC",
    "ZoneId"              : "cn-hangzhou-i",
    "Engine"              : "POLARDB",
    "Category"            : "Normal",
    "DBClusterDescription": "pc-xxxx",
    "DBNodeClass"         : "polar.mysql.x4.medium"
  },
  "fields": {
    "DBNodes"   : "{节点列表 JSON 数据}",
    "Database"  : "[数据库详情 JSON 数据]",
    "ExpireTime": "",
    "CreateTime": "2022-06-17T06:07:19Z",
    "message"   : "{实例 JSON 数据}"
  }
}

部分参数说明如下

tags.Category（集群系列）取值含义：

取值	说明
Normal	集群版
Basic	单节点
Archive	历史库

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

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

X. 附录

请参考阿里云官方文档：

• 地域和可用区
• POlARDB