Skip to content

Kingsoft Cloud KCH ClickHouse

Collect Kingsoft Cloud KCH ClickHouse monitoring data.

Configuration

Prerequisites

Prepare a valid Kingsoft Cloud AK ID,AK Secret,and grant read-only permissions required for collection.

Install Func

We recommend enabling TrueWatchIntegrations - Extensions - Hosted Func: all prerequisites are installed automatically, continue with script installation

For a self-hosted deployment of Func seeSelf-host Func Func

Install the Script

  1. Log in to Func Console,Click[Script Market],openTrueWatchScript Market,search for integration_kingsoftcloud_clickhouse
  2. Click[Install]then,enter the required parameters:Kingsoft Cloud AK ID,AK Secret and the account name
  3. Click[Deploy Startup Script],the system automatically creates Startup script set,and configures the corresponding startup script
  4. after enabling it, open"Management / Automatic Trigger Configuration"to view the automatic trigger configuration.Click[Run],to run it immediately,without waiting for the scheduled interval.wait a moment,you can view execution records and related logs

Verification

  1. In"Management / Automatic Trigger Configuration"confirm that the automatic trigger configuration exists for the task,and review task records and logs for exceptions
  2. InTrueWatch,"Infrastructure - Resource Catalog"to verify that asset information is available
  3. InTrueWatch,"Metrics"verify that the corresponding monitoring data

Metrics

After configuring Kingsoft Cloud-Cloud Monitor,the default metric sets are listed below,additional metrics can be collected through configuration.Kingsoft Cloud KCH ClickHouse monitoring metrics are in the kingsoftcloud_kck metric set.

MetricName MetricDescribe Dimensions Unit
ch_bytes_average Average Information seconds Write Information node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id MB
ch_bytes_max Maximum Information seconds Write Information node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id MB
ch_bytes_min Minimum Information seconds Write Information node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id MB
ch_bytes_received_average Average Instance Information seconds Information Traffic node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id Kbps
ch_bytes_received_max Maximum Instance Information seconds Information Traffic node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id Kbps
ch_bytes_received_min Minimum Instance Information seconds Information Traffic node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id Kbps
ch_bytes_sent_average Average Instance Information seconds Information Traffic node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id Kbps
ch_bytes_sent_max Maximum Instance Information seconds Information Traffic node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id Kbps
ch_bytes_sent_min Minimum Instance Information seconds Information Traffic node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id Kbps
ch_connections_average Average Current Connections node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id count
ch_connections_max Maximum Current Connections node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id count
ch_connections_min Minimum Current Connections node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id count
ch_cpu_used_percent_average Average CPU Utilization node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id percent
ch_cpu_used_percent_max Maximum CPU Utilization node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id percent
ch_cpu_used_percent_min Minimum CPU Utilization node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id percent
ch_cpu_wait_average Average CPU Wait Duration node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id ms
ch_cpu_wait_max Maximum CPU Average Wait Duration node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id ms
ch_cpu_wait_min Minimum CPU Average Wait Duration node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id ms
ch_insert_delay_count_average Average Latency Insert Count node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id count
ch_insert_delay_count_max Maximum Latency Insert Count node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id count
ch_insert_delay_count_min Minimum Latency Insert Count node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id count
ch_max_delay_average ch_max_delay_average node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id -
ch_max_delay_max ch_max_delay_max node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id -
ch_max_delay_min ch_max_delay_min node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id -
ch_memory_used_percent_average Average Memory Utilization node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id percent
ch_memory_used_percent_max Maximum Memory Utilization node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id percent
ch_memory_used_percent_min Minimum Memory Utilization node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id percent
ch_merge_running_average Average Running Merge Tasks node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id count
ch_merge_running_max Maximum Running Merge Tasks node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id count
ch_merge_running_min Minimum Running Merge Tasks node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id count
ch_mutation_running_average Average Running Mutation Tasks node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id count
ch_mutation_running_max Maximum Running Mutation Tasks node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id count
ch_mutation_running_min Minimum Running Mutation Tasks node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id count
ch_qps_average Average Information seconds Queries Count node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id ops
ch_qps_max Maximum Information seconds Queries Count node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id ops
ch_qps_min Minimum Information seconds Queries Count node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id ops
ch_query_failed_average Average Failures Query Count node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id count
ch_query_failed_max Maximum Failures Query Count node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id count
ch_query_failed_min Minimum Failures Query Count node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id count
ch_query_running_average Average Running Query Count node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id count
ch_query_running_max Maximum Running Query Count node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id count
ch_query_running_min Minimum Running Query Count node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id count
ch_rbps_average Average Read Throughput Information node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id B/S
ch_rbps_max Maximum Read Throughput Information node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id B/S
ch_rbps_min Minimum Read Throughput Information node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id B/S
ch_resident_memory_size_average Average Memory Usage node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id MB
ch_resident_memory_size_max Maximum Memory Usage node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id MB
ch_resident_memory_size_min Minimum Memory Usage node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id MB
ch_riops_average Average Disk Read IOPS node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id ops
ch_riops_max Maximum Disk Read IOPS node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id ops
ch_riops_min Minimum Disk Read IOPS node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id ops
ch_rows_average Average Information seconds Write Rows Count node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id rows (Custom)
ch_rows_max Maximum Information seconds Write Rows Count node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id rows (Custom)
ch_rows_min Minimum Information seconds Write Rows Count node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id rows (Custom)
ch_space_used_percent_average Average Disk Utilization node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id percent
ch_space_used_percent_max Maximum Disk Utilization node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id percent
ch_space_used_percent_min Minimum Disk Utilization node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id percent
ch_spaced_used_average Average Information Disk Information node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id MB
ch_spaced_used_max Maximum Information Disk Information node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id MB
ch_spaced_used_min Minimum Information Disk Information node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id MB
ch_unexecuted_logs_average ch_unexecuted_logs_average node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id -
ch_unexecuted_logs_max ch_unexecuted_logs_max node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id -
ch_unexecuted_logs_min ch_unexecuted_logs_min node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id -
ch_wbps_average Average Write Throughput Information node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id B/S
ch_wbps_max Maximum Write Throughput Information node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id B/S
ch_wbps_min Minimum Write Throughput Information node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id B/S
ch_wiops_average Average Disk Write IOPS node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id ops
ch_wiops_max Maximum Disk Write IOPS node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id ops
ch_wiops_min Minimum Disk Write IOPS node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id ops
ch_zk_wait_average Average ZooKeeper Wait Duration node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id ms
ch_zk_wait_max Maximum ZooKeeper Average Wait Duration node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id ms
ch_zk_wait_min Minimum ZooKeeper Average Wait Duration node_monitor_id, shard_name, instance_id, account_name, region_id, node_vip, cloud_provider, instance_name, shard_id, node_id, instance_vip, project_name, project_id ms

Objects

The collected Kingsoft Cloud KCH ClickHouse object data structure,can be viewed in"Infrastructure - Resource Catalog"as resource object data.

{
  "measurement": "kingsoftcloud_clickhouse",
  "tags": {
    "account_name": "account_xxx",
    "cloud_provider": "kingsoftcloud",
    "region_id": "cn-beijing-6",
    "project_id": "xxxxxxxx",
    "project_name": "Example Project",
    "instance_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "instance_name": "example-clickhouse",
    "status": "2",
    "status_name": "Running",
    "vpc_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "subnet_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "security_group_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  },
  "fields": {
    "cpu": 8,
    "mem": 32,
    "instacne_config": "8C32G",
    "engine": "ClickHouse",
    "network_type": "VPC",
    "instance_vip": "192.0.2.10",
    "tcp_port": 9000,
    "http_port": 8123,
    "mysql_port": 9004,
    "node_num": 3,
    "replicas": 2,
    "instance_create_date": "2026-01-01T00:00:00Z"
  }
}

Note:tags,fields fields may change in later updates.