跳转至

采集器「阿里云-ClickHouse 社区兼容版」配置手册

阅读本文前,请先阅读:

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

1. 配置结构

本采集器配置结构如下:

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

2. 配置示例

指定地域

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

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

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
32
33
34
35
36
37
38
{
  "measurement": "aliyun_clickhouse_community",
  "tags": {
    "DBClusterId"           : "cc-bp108z124a8o7****",
    "DBNodeClass"           : "C8",
    "AliUid"                : "140692647406****",
    "LockReason"            : "DISK_FULL",
    "RegionId"              : "cn-hangzhou",
    "VSwitchId"             : "vsw-bp1gzt31twhlo0sa5****",
    "DBClusterStatus"       : "Running",
    "DBClusterDescription"  : "test",
    "DBClusterNetworkType"  : "VPC",
    "ZoneId"                : "cn-hangzhou-h",
    "Category"              : "Basic",
    "ControlVersion"        : "v1",
    "ExtStorageType"        : "CloudESSD",
    "ResourceGroupId"       : "rg-4690g37929****",
    "VpcCloudInstanceId"    : "vpc-bp175iuvg8nxqraf2****",
    "VpcId"                 : "vpc-bp175iuvg8nxqraf2****",
    "PayType"               : "Postpaid",
    "Bid"                   : "26842",
    "LockMode"              : "Unlock",
    "StorageType"           : "CloudESSD",
    "name"                  : "drdshbga17ld92lb"
  },
  "fields": {
    "ConnectionString"      : "cc-bp1fs5o051c61****.clickhouse.ads.aliyuncs.com",
    "CommodityCode"         : "clickhouse_go_public_cn",
    "DBNodeStorage"         : 100,
    "ExtStorageSize"        : 0,
    "ExpireTime"            : "2011-05-30T12:11:4Z",
    "DBNodeCount"           : 2,
    "CreateTime"            : "2021-10-28T07:24:45Z",
    "Port"                  : 8123,
    "IsExpired"             : "false",
    "message"               : "{实例 json 数据}}",
  }
}

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

tags.name 值为实例 ID,作为唯一标识,fields.message 为 JSON 序列化后字符串

X. 附录

请参考阿里云官方文档: