Skip to content

Tencent Cloud Elasticsearch Service

Collect metrics data from Tencent Cloud Elasticsearch Service

Configuration

Install Func

It is recommended to enable Guance integration - extension - DataFlux Func (Automata): all prerequisites will be automatically installed, please continue with the script installation.

If you deploy Func by yourself, refer to Self-deployed Func

Install Script

Note: Please prepare a Tencent Cloud AK that meets the requirements in advance (for simplicity, you can directly grant global read-only permission ReadOnlyAccess)

  1. Log in to the Func console, click on [Script Market], go to the official script market, and search for guance_tencentcloud_es.

  2. Click [Install], then input the corresponding parameters: Tencent Cloud AK ID, AK Secret, and account name.

  3. Click [Deploy Start Script], the system will automatically create a Startup script set and automatically configure the corresponding start script.

  4. After enabling, you can see the corresponding automatic trigger configuration in "Manage / Automatic Trigger Configuration". Click [Execute] to run it immediately without waiting for the scheduled time. Wait a moment, and you can view the execution task records and corresponding logs.

Verification

  1. In "Manage / Automatic Trigger Configuration", confirm whether the corresponding task has an automatic trigger configuration. You can also check the corresponding task records and logs for any anomalies.
  2. In Guance, under "Infrastructure - Resource Catalog", check if there is asset information.
  3. In Guance, under "Metrics", check if there are corresponding monitoring data.

Metrics

After configuring Tencent Cloud - Cloud Monitor, the default metric sets are as follows. You can collect more metrics through configuration. Tencent Cloud Cloud Monitor Metrics Details

Tencent Cloud ES metrics are under the tencentcloud_QCE/CES metric set. The following are explanations of related metrics:

Metric Name Metric Description Metric Explanation Unit Statistical Granularity
IsReadOnly Whether the cluster is read-only Whether the cluster is read-only None 5s、10s、60s、300s、3600s、86400s
NodeBulkSpeed Node single-cycle bulk speed Node single-cycle bulk speed Count/s 5s、10s、60s、300s、3600s、86400s
NodeCpuLoad1min Node CPU 1-minute load Node CPU 1-minute load None 5s、10s、60s、300s、3600s、86400s
NodeIndexLatency Node single-cycle write average latency Node single-cycle write average latency ms 5s、10s、60s、300s、3600s、86400s
NodeIndexSpeed Node write speed Node write speed Count/s 5s、10s、60s、300s、3600s、86400s
NodeJvmMemUsage Node JVM memory usage rate Node JVM memory usage rate % 5s、10s、60s、300s、3600s、86400s
NodeJvmOldMemUsage JVM_Old area memory usage rate JVM_Old area memory usage rate % 5s、10s、60s、300s、3600s、86400s
NodeMemUsage Node memory usage rate Node memory usage rate % 5s、10s、60s、300s、3600s、86400s
NodeOldGcDif Node single-cycle OldGC count Node single-cycle OldGC count Count 5s、10s、60s、300s、3600s、86400s
NodeSearchLatency Node single-cycle query average latency Node single-cycle query average latency ms 5s、10s、60s、300s、3600s、86400s
NodeStatus Node health status Node health status None 5s、10s、60s、300s、3600s、86400s
ShardNum Cluster shard count Cluster shard count Count 5s、10s、60s、300s、3600s、86400s
Status Cluster health status Cluster health status: 0: Green 1: Yellow 2: Red % 5s、10s、60s、300s、3600s、86400s
ClusterSlowSearchCount1min Number of slow queries within 1 minute in the cluster Number of slow queries within 1 minute in the cluster Count 5s、10s、60s、300s、3600s、86400s
ForceMergeQueue forceMerge thread queue wait count forceMerge thread queue wait count Count 5s、10s、60s、300s、3600s、86400s
NodeCpuLoad1minRate Node CPU 1-minute load rate Node CPU 1-minute load rate % 5s、10s、60s、300s、3600s、86400s
QueryCacheHitRate Query cache hit rate Query cache hit rate % 5s、10s、60s、300s、3600s、86400s
ShardNumLimitPercen Cluster shard usage rate Cluster shard usage rate % 5s、10s、60s、300s、3600s、86400s
DiskAwait Operation wait time Operation wait time ms 5s、10s、60s、300s、3600s、86400s
DiskIoutil Disk IOUtil Disk IO Util % 5s、10s、60s、300s、3600s、86400s
DiskIps Writes per second Writes per second None 5s、10s、60s、300s、3600s、86400s
DiskOps Reads per second Reads per second None 5s、10s、60s、300s、3600s、86400s
DiskReadTraffic Disk read traffic Disk read traffic KBytes/s 5s、10s、60s、300s、3600s、86400s
DiskWriteTraffic Disk write traffic Disk write traffic KBytes/s 5s、10s、60s、300s、3600s、86400s
MaxP90SearchTaskMillisMax Query task duration at 90th percentile Query task duration at 90th percentile ms 5s、10s、60s、300s、3600s、86400s
MaxP95SearchTaskMillis Query task duration at 95th percentile Query task duration at 95th percentile ms 5s、10s、60s、300s、3600s、86400s
MaxP99SearchTaskMillis Query task duration at 99th percentile Query task duration at 99th percentile ms 5s、10s、60s、300s、3600s、86400s
NodeDiskPathMaxUsage Maximum node disk usage rate Maximum node disk usage rate % 5s、10s、60s、300s、3600s、86400s
ClusterHttpCurrentOpen Current number of HTTP connections in the cluster Current number of HTTP connections in the cluster ms 5s、10s、60s、300s、3600s、86400s

Objects

The collected Tencent Cloud ES object data structure can be viewed in "Infrastructure - Resource Catalog"

{
  "measurement": "tencentcloud_es",
  "tags": {
    "RegionId"          : "ap-shanghai",
    "InstanceId"        : "ap-shanghai-1",
    "InstanceName"      : "xxxx",
    "InstanceType"      : "BIND",
    "AppId"             : "119.45.172.xxx",
    "EsVip"             : "xxxxx  ",
    "EsPort"            : "xxxx",
    "VpcUid"            : "xxxxxxxxxx"
  },
  "fields": {
    "EsPrivateUrl"               : "xxxxxxxxxxx",
    "EsPublicUrl"                : "xxxxxxxxxxx",
    "Status"                     : "xxxxxxxxxxx",
    "NodeInfoList"               : "mmxxxx",
    "CpuNum"                     : "8xxxxx",
    "MemSize"                    : "xxxx",
    "MasterNodeInfo"             : "xxxxxxxxxxx",
    "KibanaNodeInfo"             : false,
    "OptionalWebServiceInfos"    : false,
    "ChargeType"                 : 1,
    "CreateTime"                 : "2024-06-11T08:10:57Z",
    "TagList"                    : "{JSON instance data}"
  }
}

Note: Fields in tags and fields may change with subsequent updates.

Feedback

Is this page helpful? ×