Skip to content

AWS OpenSearch Serverless

Collect AWS OpenSearch Serverless Metrics

Configuration

Install Func

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

If you deploy Func manually, refer to Manual Func Deployment

Install Script

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

Hosted Version Activation Script

  1. Log in to the TrueWatch console
  2. Click the [Integration] menu, select [Cloud Account Management]
  3. Click [Add Cloud Account], select [AWS], 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], if the test is successful, click [Save]. If the test fails, please check if the relevant configuration information is correct and test again
  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 AWS OpenSearch Serverless under the Not Installed list, click the [Install] button, and install it in the pop-up installation interface.

Manual Activation Script

  1. Log in to the Func console, click [Script Market], enter the TrueWatch script market, search for integration_open_search_serverless

  2. Click [Install], then enter the corresponding parameters: AWS 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 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. Wait a moment, you can view the execution task record and corresponding logs.

Verification

  1. In [Management / Automatic Trigger Configuration], confirm whether the corresponding task has the automatic trigger configuration, and check the corresponding task records and logs for any exceptions
  2. In TrueWatch, [Infrastructure - Resource Catalog], check if asset information exists
  3. In TrueWatch, [Metrics], check if there is corresponding monitoring data

Metrics

AWS OpenSearch Serverless Metrics are under the aws_aoss Measurement, the description column includes the description of each metric as well as units and statistical data.

Metric Description Unit
ActiveCollection Indicates whether the collection is active. A value of 1 indicates that the collection is in the ACTIVE state. This value is emitted when the collection is successfully created and remains 1 until you delete the collection. The value of this metric cannot be 0. -
DeletedDocuments Total number of deleted documents. count
IndexingOCU Number of OpenSearch Compute Units (OCUs) used for ingesting collection data. This metric applies to the account level. count
IngestionDataRate Indexing rate of the collection or index, in GiB/s GiB/s
IngestionDocumentErrors Total number of document errors during ingestion for the collection or index. After the bulk indexing request is successfully completed, the writer processes the request and emits errors for all failed documents in the request. count
IngestionDocumentRate Rate of documents ingested into the collection or index per second. This metric only applies to bulk indexing requests. count/s
IngestionRequestErrors Total number of bulk indexing request errors for the collection. count
IngestionRequestLatency Latency of bulk write operations against the collection, in seconds. s
IngestionRequestRate Total number of bulk write operations received by the collection. count
IngestionRequestSuccess Total number of successful indexing operations for the collection. count
SearchableDocuments Total number of searchable documents in the collection or index. count
SearchRequestErrors Total number of query errors per minute for the collection. count
SearchRequestLatency Average time required to complete search operations against the collection, in milliseconds. ms
SearchOCU Number of OpenSearch Compute Units (OCUs) used for searching collection data. count
SearchRequestRate Total number of search requests per minute against the collection. count
StorageUsedInS3 Amount of Amazon S3 storage used, in bytes. count
2xx, 3xx, 4xx, 5xx Number of requests against the collection that resulted in the given HTTP response code (2xx, 3xx, 4xx, 5xx). count

Object

The collected AWS OpenSearch Serverless object data structure can be seen in "Infrastructure - Resource Catalog"

{
  "measurement": "aws_opensearch_serverless",
  "tags": {
    "collection_id"             : "91dxh9h35ijjctd8nlvxfd4d",
    "collection_name"           : "xxx-test",
    "RegionId"                  : "ap-southeast-1",
    "arn"                       : "arn:aws:aoss:ap-southeast-1:87xxxxxxx45r:collection/xh9h35ijjctd8nldddxd
"
  },
  "fields": {
    "status"                    : "ACTIVE"
  }
}

Note: Fields in tags, fields may change with subsequent updates ```