Skip to content

Collector "Alibaba Cloud - ClickHouse Community Edition" Configuration Manual

Before reading this document, please read:

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 the 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 successful data synchronization, you can view the data in the "Infrastructure - Resource Catalog" of TrueWatch.

An example of the reported data is as follows:

{
  "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"               : "{instance json data}}",
  }
}
Note

The 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: