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

Before reading this document, please read:

Cloud Integration

Tip

Before using this collector, you must install the "Integration Core Package" and its accompanying third-party dependencies.

1. Configuration Structure¶

The configuration structure of this collector is as follows:

Field	Type	Required	Description
`regions`	list	Required	List of regions to be collected
`regions[#]`	str	Required	Region ID. For example: `'cn-hangzhou'` See appendix for the complete list

2. Configuration Example¶

Specifying Regions¶

Collect data from Hangzhou and Shanghai regions

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

3. Data Reporting Format¶

After data is successfully synchronized, you can view the data in the "Infrastructure-Resource Catalog" of TrueWatch.

An example of the reported data is as follows:

{
  "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}}",
  }
}

Note

Fields in tags and fields may change with subsequent updates.

Tip

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

X. Appendix¶

Please refer to the official Alibaba Cloud documentation:

Service Access Address for Alibaba Cloud ClickHouse Cloud Native Edition