AWS OpenSearch¶

AWS OpenSearch, including connection counts, request counts, latency, slow queries, etc.

Configuration¶

Install Func¶

Recommended to enable Guance integration - extension - hosted Func: all prerequisites are automatically installed. Please continue with the script installation.

If you deploy Func on your own, refer to Self-deployed Func

Installation Script¶

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

Hosted Edition Activation Script¶

1. Log in to the Guance console
2. Click on the [Integration] menu and select [Cloud Account Management]
3. Click [Add Cloud Account], choose [AWS]. If cloud account information has been configured before, skip this step.
4. Click [Test], if the test is successful, click [Save]. If the test fails, check whether the related configuration information is correct and retest.
5. In the [Cloud Account Management] list, you can see the added cloud accounts. Click on the corresponding cloud account and enter the details page.
6. Click the [Integration] button on the cloud account details page. Under the Not Installed list, find AWS OpenSearch, click the [Install] button, and follow the installation interface to complete the installation.

Manual Activation Script¶

1. Log in to the Func console, click [Script Market], enter the official script market, and search for: guance_aws_open_search
2. After clicking [Install], input the corresponding parameters: AWS AK ID, AK Secret, and account name.
3. Click [Deploy Startup Script], and the system will automatically create a Startup script set and configure the corresponding startup scripts automatically.
4. After activation, you can see the corresponding automatic trigger configuration in the "Management / Automatic Trigger Configuration". Click [Execute] to immediately execute once without waiting for the scheduled time. Wait a moment, and 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. You can also check the corresponding task records and logs for any abnormalities.
2. In Guance, under "Infrastructure / Custom", check if there is asset information.
3. In Guance, under "Metrics", check if there are corresponding monitoring data.

Metrics¶

After configuring AWS OpenSearch, the default metric sets are as follows. More metrics can be collected through configuration AWS Cloud Monitoring Metric Details

Cluster Metrics¶

Amazon OpenSearch service provides the following metrics for clusters.

Objects¶

The structure of AWS OpenSearch object data collected 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 current state of service software}",
    "region"                : "cn-northwest-1",
    "RegionId"              : "cn-northwest-1"
  },
  "fields": {
    "EBSOptions": "{JSON data of elastic block storage options for the specified domain}",
    "Endpoints" : "{Mapping JSON data of domain endpoints used to submit index and search requests}",
    "message"   : "{Instance JSON data}"
  }
}

Note: Fields in tags and fields may change with subsequent updates. Tip 1: The value of tags.name is the instance ID, used for unique identification. Tip 2: The data field corresponding to tags.name in this script is DomainName. 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 serialized JSON strings.