Skip to content

Kingsoft Cloud Elasticsearch

Collect Kingsoft Cloud Elasticsearch Cluster 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_elasticsearch
  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 Elasticsearch monitoring metrics are in the kingsoftcloud_kes metric set.

MetricName MetricDescribe Dimensions Unit
elasticsearch_cluster_health_active_primary_shards_average Average Active Primary Shards Count region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_cluster_health_active_primary_shards_max Maximum Active Primary Shards Count region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_cluster_health_active_primary_shards_min Minimum Active Primary Shards Count region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_cluster_health_active_shards_average Average Active Shards Count region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_cluster_health_active_shards_max Maximum Active Shards Count region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_cluster_health_active_shards_min Minimum Active Shards Count region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_cluster_health_initializing_shards_average Average Initializing Shards Count region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_cluster_health_initializing_shards_max Maximum Initializing Shards Count region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_cluster_health_initializing_shards_min Minimum Initializing Shards Count region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_cluster_health_number_of_data_nodes_average Average Data Nodes region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_cluster_health_number_of_data_nodes_max Maximum Data Nodes region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_cluster_health_number_of_data_nodes_min Minimum Data Nodes region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_cluster_health_number_of_nodes_average Average Total Node Count region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_cluster_health_number_of_nodes_max Maximum Total Node Count region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_cluster_health_number_of_nodes_min Minimum Total Node Count region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_cluster_health_number_of_pending_tasks_average Average Information Tasks region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_cluster_health_number_of_pending_tasks_max Maximum Information Tasks region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_cluster_health_number_of_pending_tasks_min Minimum Information Tasks region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_cluster_health_relocating_shards_average Average Relocating Shards Count region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_cluster_health_relocating_shards_max Maximum Relocating Shards Count region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_cluster_health_relocating_shards_min Minimum Relocating Shards Count region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_cluster_health_status_average Average Cluster Healthy Information region_id, account_name, cluster_id, cloud_provider, cluster_name -
elasticsearch_cluster_health_status_max Maximum Cluster Healthy Information region_id, account_name, cluster_id, cloud_provider, cluster_name -
elasticsearch_cluster_health_status_min Minimum Cluster Healthy Information region_id, account_name, cluster_id, cloud_provider, cluster_name -
elasticsearch_cluster_health_unassigned_shards_average Average Unassigned Shards Count region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_cluster_health_unassigned_shards_max Maximum Unassigned Shards Count region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_cluster_health_unassigned_shards_min Minimum Unassigned Shards Count region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_filesystem_data_available_bytes_average Average Information Disk Information region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id B
elasticsearch_filesystem_data_available_bytes_max Maximum Information Disk Information region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id B
elasticsearch_filesystem_data_available_bytes_min Minimum Information Disk Information region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id B
elasticsearch_filesystem_io_stats_device_read_size_kilobytes_sum_average Average Disk Read Data Information region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id B
elasticsearch_filesystem_io_stats_device_read_size_kilobytes_sum_max Maximum Disk Read Data Information region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id B
elasticsearch_filesystem_io_stats_device_read_size_kilobytes_sum_min Minimum Disk Read Data Information region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id B
elasticsearch_filesystem_io_stats_device_write_size_kilobytes_sum_average Average Disk Write Data Information region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id B
elasticsearch_filesystem_io_stats_device_write_size_kilobytes_sum_max Maximum Disk Write Data Information region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id B
elasticsearch_filesystem_io_stats_device_write_size_kilobytes_sum_min Minimum Disk Write Data Information region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id B
elasticsearch_heap_memtory_usage_average Average Information Memory Utilization region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id percent
elasticsearch_heap_memtory_usage_max Maximum Information Memory Utilization region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id percent
elasticsearch_heap_memtory_usage_min Minimum Information Memory Utilization region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id percent
elasticsearch_indices_docs_nums_average Average Information Write QPS region_id, account_name, cluster_id, cloud_provider, cluster_name -
elasticsearch_indices_docs_nums_max Maximum Information Write QPS region_id, account_name, cluster_id, cloud_provider, cluster_name -
elasticsearch_indices_docs_nums_min Minimum Information Write QPS region_id, account_name, cluster_id, cloud_provider, cluster_name -
elasticsearch_indices_indexing_index_total_average Average Total Indexes region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_indices_indexing_index_total_max Maximum Total Indexes region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_indices_indexing_index_total_min Minimum Total Indexes region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_indices_search_query_total_average Average Information search for Requests Total Count region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_indices_search_query_total_max Maximum Information search for Requests Total Count region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_indices_search_query_total_min Minimum Information search for Requests Total Count region_id, account_name, cluster_id, cloud_provider, cluster_name count
elasticsearch_jvm_gc_collection_seconds_count_average AverageGC Run Count region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id count
elasticsearch_jvm_gc_collection_seconds_count_max MaximumGC Run Count region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id count
elasticsearch_jvm_gc_collection_seconds_count_min MinimumGC Run Count region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id count
elasticsearch_jvm_gc_collection_seconds_sum_average AverageGC Total Running Information region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id s
elasticsearch_jvm_gc_collection_seconds_sum_max MaximumGC Total Running Information region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id s
elasticsearch_jvm_gc_collection_seconds_sum_min MinimumGC Total Running Information region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id s
elasticsearch_jvm_memory_used_bytes_average AverageElasticsearch Information Memory Information region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id B
elasticsearch_jvm_memory_used_bytes_max MaximumElasticsearch Information Memory Information region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id B
elasticsearch_jvm_memory_used_bytes_min MinimumElasticsearch Information Memory Information region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id B
elasticsearch_os_load_15_average Average15 minutes System Load region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id percent
elasticsearch_os_load_15_max Maximum15 minutes System Load region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id percent
elasticsearch_os_load_15_min Minimum15 minutes System Load region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id percent
elasticsearch_os_load_1_average Average1 minutes System Load region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id percent
elasticsearch_os_load_1_max Maximum1 minutes System Load region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id percent
elasticsearch_os_load_1_min Minimum1 minutes System Load region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id percent
elasticsearch_os_load_5_average Average5 minutes System Load region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id percent
elasticsearch_os_load_5_max Maximum5 minutes System Load region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id percent
elasticsearch_os_load_5_min Minimum5 minutes System Load region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id percent
elasticsearch_process_cpu_percent_average AverageElasticsearch Information CPU Utilization region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id count
elasticsearch_process_cpu_percent_max MaximumElasticsearch Information CPU Utilization region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id count
elasticsearch_process_cpu_percent_min MinimumElasticsearch Information CPU Utilization region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id count
elasticsearch_thread_pool_queue_count_read_average Average Read Information Count region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id -
elasticsearch_thread_pool_queue_count_read_max Maximum Read Information Count region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id -
elasticsearch_thread_pool_queue_count_read_min Minimum Read Information Count region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id -
elasticsearch_thread_pool_queue_count_write_average Average Write Information Count region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id -
elasticsearch_thread_pool_queue_count_write_max Maximum Write Information Count region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id -
elasticsearch_thread_pool_queue_count_write_min Minimum Write Information Count region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id -
elasticsearch_thread_pool_rejected_count_read_average Average Read Information Count region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id -
elasticsearch_thread_pool_rejected_count_read_max Maximum Read Information Count region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id -
elasticsearch_thread_pool_rejected_count_read_min Minimum Read Information Count region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id -
elasticsearch_thread_pool_rejected_count_write_average Average Write Information Count region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id -
elasticsearch_thread_pool_rejected_count_write_max Maximum Write Information Count region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id -
elasticsearch_thread_pool_rejected_count_write_min Minimum Write Information Count region_id, account_name, instance_id, internal_ip, instance_name, node_id, cluster_id, domain, cloud_provider, cluster_name, instance_group_id -

Objects

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

{
  "measurement": "kingsoftcloud_kes",
  "tags": {
    "account_name": "example-account",
    "cloud_provider": "kingsoftcloud",
    "region_id": "cn-beijing-6",
    "cluster_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "cluster_name": "example-elasticsearch",
    "cluster_status": "RUNNING"
  },
  "fields": {
    "availability_zone": "cn-beijing-6a",
    "charge_type": "Daily",
    "main_version": "OpenSource-7.10.0",
    "enable_eip": true,
    "vpc_domain_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "vpc_subnet_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "private_links": "{Access Address}",
    "public_links": "{Access Address}",
    "instance_groups": "{Instance Group Configuration}",
    "cluster_create_time": "2025-01-14 06:45:39",
    "last_update_time": 1784599020782
  }
}

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