Alibaba Cloud ElasticSearch¶

Alibaba Cloud ElasticSearch Metrics display, including cluster status, index QPS, node CPU/memory/disk usage, etc.

Configuration¶

Install Func¶

It is recommended to activate TrueWatch Integration - Extensions - DataFlux Func (Automata)

If you want to deploy Func by yourself, refer to Deploy Func by Yourself

Activate Script¶

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

Activate Script for DataFlux Func (Automata)¶

1. Log in to the TrueWatch console
2. Click the 【Integration】 menu, and select 【Cloud Account Management】
3. Click 【Add Cloud Account】, select 【Alibaba Cloud】, and fill in the required information on the interface. If you have already configured the cloud account information before, ignore this step
4. Click 【Test】, and click 【Save】 after the test is successful. If the test fails, please check whether the relevant configuration information is correct and test again
5. Click 【Cloud Account Management】, and 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 Alibaba Cloud ElasticSearch under the Not Installed list, and click the 【Install】 button to pop up the installation interface for installation.

Activate Script Manually¶

1. Log in to the Func console, click 【Script Market】, enter the TrueWatch script market, and search: integration_alibabacloud_elasticsearch

2. Click 【Install】, and enter the corresponding parameters: Alibaba Cloud AK ID, AK Secret, and account name.

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

4. After activation, 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 check the corresponding task records and logs to check for any exceptions
2. In TrueWatch, check whether there is asset information in 「Infrastructure / Custom」
3. In TrueWatch, check whether there is corresponding monitoring data in 「Metrics」

Metrics¶

After configuring Alibaba Cloud Cloud Monitor, the default Measurement is as follows. You can collect more Metrics through configuration Alibaba Cloud Cloud Monitor Metrics Details

Object¶

The collected Alibaba Cloud ElasticSearch object data structure can be seen in 「Infrastructure - Custom」

{
  "measurement": "aliyun_elasticsearch",
  "tags": {
    "RegionId"       : "cn-hangzhou",
    "esVersion"      : "7.4.0_with_X-Pack",
    "instanceId"     : "es-cn-xxxx",
    "name"           : "es-cn-xxxx",
    "paymentType"    : "prepaid",
    "resourceGroupId": "rg-acfm2l3p7xxxx",
    "serviceVpc"     : "True",
    "status"         : "active"
  },
  "fields": {
    "advancedDedicateMaster": false,
    "createdAt"             : "2021-04-07T06:10:50.527Z",
    "extendConfigs"         : "[ {Cluster Extension Parameter Configuration JSON Data}, ...]",
    "message"               : "{Instance JSON Data}"
  }
}

Logging¶

Prerequisites¶

Note 1: Before using this collector, you must install the 「TrueWatch Integration Core Package」 and its supporting third-party dependencies Note 2: The code execution of this script depends on the mongodb instance object collection. If the custom object collection of mongodb is not configured, the slow log script cannot collect slow log data

Install Script¶

On the previous basis, you need to install a corresponding elasticsearch log collection script

In 「Management / Script Market」, click and install the corresponding script package:

• 「TrueWatch Integration (Alibaba Cloud - ElasticSearch Collection)」(ID：integration_alibabacloud_elasticsearch_log)

Data Reporting Format¶

After the data is synchronized normally, you can view the data in TrueWatch's 「Infrastructure - Custom Objects」.

The reported data example is as follows:

{
  "measurement": "aliyun_elasticsearch_log",
  "tags": {
    "RegionId"       : "cn-hangzhou",
    "esVersion"      : "7.10.0_with_X-Pack",
    "host"           : "10.14.xxx.xxx",
    "instanceId"     : "es-cn-xxxx",
    "name"           : "es-cn-xxxx",
    "paymentType"    : "prepaid",
    "resourceGroupId": "rg-aekzkcwe4dxxxx",
    "serviceVpc"     : "True",
    "status"         : "active"
  },
  "fields": {
    "timestamp"        : 1684304299000,
    "contentCollection": "[ {Log Detail Information JSON Data}, ...]",
    "message"          : "{Instance JSON Data}"
  }
}

log_types (log type) assignment meaning:

Note: The fields in tags and fields may change with subsequent updates Note 1: The value of tags.name is the instance ID, which is used as the unique identifier Note 2: fields.message is a JSON serialized string ```