Skip to content

Collector Configuration Manual for "Alibaba Cloud - ClickHouse Cloud Native Edition"

Before reading this article, please read the following first:

Before using this collector, you must install the 'Integration Core Package' and its associated third-party dependency packages.

1. Configuration Structure

The configuration structure of this collector is as follows:

Field Type Required Description
regions list Required List of regions to collect data from
regions[#] str Required Region ID. For example: 'cn-hangzhou'
Refer to the appendix for the full list

2. Configuration Example

Specifying Regions

Collecting data from Hangzhou and Shanghai regions

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

3. Data Reporting Format

After data synchronization is successful, you can view the data in the {{( brand_name )}} "Infrastructure - Resource Catalog".

An example of reported data is shown below:

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
{
  "measurement": "aliyun_clickhouse_cloud",
  "tags": {
    "DBClusterId"           : "cc-bp108z124a8o7****",
    "EngineVersion"         : "21.8",
    "RegionId"              : "cn-hangzhou",
    "VpcId"                 : "vpc-2zedznmtm8j7fksbc****",
    "ZoneId"                : "cn-hangzhou-h",
    "VswitchId"             : "vsw-bp1tg609m5j85jejq****",
    "PayType"               : "Postpaid",
    "CommodityCode"         : "clickhouse_go_public_cn",
    "LockMode"              : "Unlock",
    "LockReason"            : "DISK_FULL",
    "DBClusterStatus"       : "Running",
    "CacheStorageType"      : "CloudESSD",
    "name"                  : "drdshbga17ld92lb"
  },
  "fields": {
    "DBClusterDescription"  : "test",
    "AliUid"                : 0,
    "CreateTime"            : "2022-03-18T08:14:48Z",
    "ExpireTime"            : "2022-04-17T08:14:48Z",
    "ResourceCpuCores"      : 8,
    "ResourceMemoryGiB"     : 32,
    "CacheStorageSizeGiB"   : 200,
    "ObjectStoreSizeGiB"    : 0,
    "message"               : "{instance json data}}",
  }
}

Fields in tags and fields may change with subsequent updates.

The value of tags.name is the instance ID, serving as a unique identifier, while fields.message is a JSON serialized string.

X. Appendix

Please refer to the official Alibaba Cloud documentation: