AWS OpenSearch¶

AWS OpenSearch, including connections, requests, latency, slow queries, etc.

Configuration¶

Install Func¶

It is recommended to enable TrueWatch integration - Extensions - DataFlux Func (Automata): all prerequisites are automatically installed, please continue with script installation

For self-deployed Func, refer to Self-deployed Func

Install Script¶

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

Managed Version Activation Script¶

1. Log in to the TrueWatch console
2. Click on the 【Integration】 menu, select 【Cloud Account Management】
3. Click on 【Add Cloud Account】, select 【AWS】, and fill in the required information on the interface. If the cloud account information has been configured before, skip this step
4. Click on 【Test】, and after a successful test, click on 【Save】. If the test fails, please check if the relevant configuration information is correct and test again
5. Click on 【Cloud Account Management】 list to see the added cloud account, click on the corresponding cloud account to enter the details page
6. Click on the 【Integration】 button on the cloud account details page, find AWS OpenSearch under the Not Installed list, and click on the 【Install】 button to pop up the installation interface for installation.

Manual Activation Script¶

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

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

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

4. After enabling, you can see the corresponding automatic trigger configuration in 「Management / Automatic Trigger Configuration」. Click on 【Execute】 to immediately execute once without waiting for the scheduled time. Wait a moment, you can view 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 see if there are any exceptions
2. In TrueWatch, check if there is asset information in 「Infrastructure / Custom」
3. In TrueWatch, check if there is corresponding monitoring data in 「Metrics」

Metrics¶

After configuring AWS OpenSearch, the default measurement sets are as follows. You can collect more metrics by configuring AWS CloudWatch Metrics Details

Cluster Metrics¶

Amazon OpenSearch Service provides the following metrics for clusters.

Objects¶

The collected AWS OpenSearch object data structure can be seen in 「Infrastructure - Custom」

{
  "measurement": "aws_opensearch",
  "tags": {
    "name"                  : "df-prd-es",
    "EngineVersion"         : "Elasticsearch_7.10",
    "DomainId"              : "5882XXXXX135/df-prd-es",
    "DomainName"            : "df-prd-es",
    "ClusterConfig"         : "{JSON data of instance types and instance counts in the domain}",
    "ServiceSoftwareOptions": "{JSON data of the current state of the service software}",
    "region"                : "cn-northwest-1",
    "RegionId"              : "cn-northwest-1"
  },
  "fields": {
    "EBSOptions": "{JSON data of the Elastic Block Store for the specified domain}",
    "Endpoints" : "{JSON data of the mapping of domain endpoints for submitting indexing and search requests}",
    "message"   : "{JSON data of the instance}"
  }
}

Note: Fields in tags and fields may change with subsequent updates Tip 1: The value of tags.name is the instance ID, used as a unique identifier Tip 2: The tags.name in this script corresponds to the DomainName data field. When using this script, ensure that there are no duplicate DomainName values across multiple AWS accounts. Tip 3: tags.ClusterConfig, tags.Endpoint, tags.ServiceSoftwareOptions, fields.message, fields.EBSOptions, fields.Endpoints are all JSON serialized strings