AWS OpenSearch¶

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

Configuration¶

Install Func¶

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

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

Installation Script¶

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

Hosted Version Activation Script¶

1. Log in to the Guance console
2. Click on the 【Manage】 menu and select 【Cloud Account Management】
3. Click 【Add Cloud Account】, select 【AWS】, and fill in the required information on the interface; if cloud account information has been configured before, skip this step
4. Click 【Test】, after a successful test click 【Save】, if the test fails, check whether the relevant configuration information is correct and retest
5. In the 【Cloud Account Management】 list, you can see the added cloud account. Click the corresponding cloud account to 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 install by following the installation interface.

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】, the system will automatically create a Startup script set and configure the corresponding startup script automatically.
4. After enabling, you can see the corresponding automatic trigger configuration in 「Management / Automatic Trigger Configuration」. Click 【Execute】, which can immediately execute once without waiting for the regular time. Wait a moment, and you can view the execution task records and corresponding logs.

Verification¶

1. Confirm in 「Management / Automatic Trigger Configuration」 whether the corresponding tasks have the corresponding automatic trigger configurations. You can also check the corresponding task records and logs for any anomalies.
2. In Guance, check under 「Infrastructure / Custom」 whether asset information exists.
3. In Guance, under 「Metrics」 check if there are corresponding monitoring data.

Metrics¶

After configuring AWS OpenSearch, the default metric set is as follows. You can collect more metrics via configuration AWS Cloud Monitoring Metric Details

Cluster Metrics¶

Amazon OpenSearch service provides the following metrics for clusters.

Objects¶

The collected AWS OpenSearch object data structure can be viewed from 「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 numbers 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 elastic block storage for the specified domain}",
    "Endpoints" : "{JSON data mapping of domain endpoints for submitting 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, serving as a unique identifier Tip 2: The data field corresponding to tags.name in this script is DomainName. When using this script, ensure that DomainName values do not duplicate across multiple AWS accounts. Tip 3: tags.ClusterConfig, tags.Endpoint, tags.ServiceSoftwareOptions, fields.message, fields.EBSOptions, fields.Endpoints, are all serialized JSON strings