Tencent Cloud Elasticsearch Service

Collect Tencent Cloud Elasticsearch Service Metrics

Configuration¶

Install Func¶

It is recommended to enable Guance Integration - Extensions - DataFlux Func (Automata): All prerequisites are automatically installed, please proceed with the script installation.

If you need to deploy Func manually, refer to Deploy Func Manually

Enable Script¶

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

Enable Script for DataFlux Func (Automata)¶

1. Log in to the Guance console
2. Click the 【Integration】 menu, select 【Cloud Account Management】
3. Click 【Add Cloud Account】, select 【Tencent Cloud】, and fill in the required information on the interface. If you have already configured the cloud account information before, you can skip this step
4. Click 【Test】, if the test is successful, click 【Save】. If the test fails, please check if the relevant configuration information is correct and retest
5. Click 【Cloud Account Management】, you can see the added cloud account in the list. Click the corresponding cloud account to enter the details page
6. Click the 【Integration】 button on the cloud account details page, find Tencent Cloud Elasticsearch Service under the Not Installed list, and click the 【Install】 button. The installation interface will pop up for installation.

Enable Script Manually¶

1. Log in to the Func console, click 【Script Market】, enter the Guance script market, search for integration_tencentcloud_es

2. Click 【Install】, then enter the corresponding parameters: Tencent Cloud AK, SK, and account name

3. Click 【Deploy Startup Script】, the system will automatically create the Startup script set and configure the corresponding startup script

4. After enabling, you can see the corresponding automatic trigger configuration in 「Management / Automatic Trigger Configuration」. Click 【Execute】 to execute it immediately without waiting for the scheduled time. After a while, you can check the execution task records and corresponding logs

Verification¶

1. In 「Management / Automatic Trigger Configuration」, confirm whether the corresponding task has the corresponding automatic trigger configuration, and you can also check the corresponding task records and logs to check for any exceptions
2. In Guance, check if the asset information exists in 「Infrastructure - Resource Catalog」
3. In Guance, check if there is corresponding monitoring data in 「Metrics」

Metrics¶

After configuring Tencent Cloud Cloud Monitor, the default Measurement is 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 Measurement. The following are the relevant Metrics descriptions:

Objects¶

The collected Tencent Cloud ES object data structure can be seen 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"                    : "{Instance JSON Data}"
  }
}

Note: The fields in tags and fields may change with subsequent updates