跳转至

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

阅读本文前，请先阅读：

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

1. 配置结构

本采集器配置结构如下：

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

2. 配置示例

指定地域

采集杭州、上海地域的数据

Python
1
2
3
collector_configs = {
    'regions': [ 'cn-hangzhou', 'cn-shanghai' ]
}

配置过滤器（可选项）

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

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

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

支持筛选的对象属性：

属性 描述
InstanceId 集群 ID
InstanceName 集群名称
State 集群状态
Python
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
# 示例：开启过滤器，根据对象的实例 ID 和名称属性过滤，配置格式如下：
def filter_instance(instance):
    '''
    采集 InstanceId 为 xxxxx 或者 InstanceName 为 xxxxx 的实例
    '''
    # return True
    instance_id = instance['InstanceId']
    instance_name = instance['InstanceName']
    if instance_id in ['xxxxx'] or instance_name in ['xxxxx']:
        return True
    return False


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


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

3. 数据上报格式

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

上报的数据示例如下：

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
{
  "measurement": "aliyun_oceanbase",
  "tags": {
    "InstanceId": "ob67r23fni4zz4",
    "InstanceName": "fyb-created",
    "InstanceRole": "NORMAL",
    "InstanceType": "cluster",
    "ResourceGroupId": "rg-acfm4m3fh3iykdq",
    "State": "ONLINE",
    "name": "ob67r23fni4zz4"
  },
  "fields": {
    "AvailableZones": "[\"h\", \"i\"]",
    "Cpu": 4,
    "CpuArchitecture": "X86",
    "CreateTime": "2024-11-05T02:43:36Z",
    "DataDiskAutoScaleConfig": "{数据盘自动协调配置}",
    "DeployMode": "1-1-1",
    "DeployType": "dual",
    "DiskSize": 50,
    "ExpireTime": "2124-11-05T16:00:00Z",
    "InstanceClass": "4C16G",
    "Mem": 16,
    "PayType": "POSTPAY",
    "Resource": "{集群的资源信息}",
    "UsedDiskSize": 1,
    "Version": "4.2.1.9",
    "VpcId": "vpc-bp12v3efx5klzh720t5zf",
    "message"       : "{实例 JSON 数据}"
  }
}

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

tags.name 值为实例 ID，作为唯一标识，fields.message、fields.DataDiskAutoScaleConfig、fields.Resource、fields.AvailableZones 为 JSON 序列化后字符串

X. 附录

请参考阿里云官方文档：