Introduction
Amazon OpenSearch Service is an AWS-managed service that enables you to deploy, operate, and scale OpenSearch clusters without managing the underlying infrastructure or requiring specialized operational expertise.OpenSearch is a distributed, open-source search and analytics suite that is community-driven and licensed under Apache 2.0.By using OpenSearch Service, you can reduce operational overhead while benefiting from enterprise-grade security, high availability, and scalability. The service supports rapid deployment of real-time search, analytics, and generative AI applications, allowing organizations to focus on innovation and operational efficiency instead of infrastructure management.You can choose between fully managed OpenSearch Service clusters for greater control or Amazon OpenSearch Serverless for automatic resource optimization and efficient scaling of vector workloads.
Use the AWS public cloud integration to discover and collect metrics against the AWS service.
Setup
To set up the AWS integration and discover the AWS services (OpenSearch Serverless Collections and OpenSearch Ingestion Pipelines), go to AWS Integration Discovery Profile and select OpenSearch Serverless Collections and OpenSearch Ingestion Pipelines.
Event support
CloudTrail event support
- Supported
- Configurable in OpsRamp AWS Integration Discovery Profile.
CloudWatch alarm support
- Supported
- Configurable in OpsRamp AWS Integration Discovery Profile.
Supported metrics
OpenSearch Serverless Collections metrics
| OpsRamp Metric | AWS Metric | Metric Display Name | Unit | Aggregation Type | Description |
|---|---|---|---|---|---|
| aws_aoss_SearchableDocuments | SearchableDocuments | Searchable Documents | Count | Average | The number of searchable documents in the collection. |
| aws_aoss_SearchRequestRate | SearchRequestRate | Search Request Rate | Count | Average | The rate of search requests to the collection. |
| aws_aoss_SearchRequestLatency | SearchRequestLatency | Search Request Latency | Milliseconds | Average | The time it takes to complete a search request. |
| aws_aoss_SearchRequestErrors | SearchRequestErrors | Search Request Errors | Count | Sum | The number of search request errors. |
| aws_aoss_DeletedDocuments | DeletedDocuments | Deleted Documents | Count | Average | The number of deleted documents in the collection. |
| aws_aoss_2xx | 2xx | 2xx Responses | Count | Sum | The number of requests that returned a 2xx HTTP response code. |
| aws_aoss_3xx | 3xx | 3xx Responses | Count | Sum | The number of requests that returned a 3xx HTTP response code. |
| aws_aoss_4xx | 4xx | 4xx Responses | Count | Sum | The number of requests that returned a 4xx HTTP response code. |
| aws_aoss_5xx | 5xx | 5xx Responses | Count | Sum | The number of requests that returned a 5xx HTTP response code. |
| aws_aoss_ActiveCollection | ActiveCollection | Active Collection | Count | Maximum | Indicates whether a collection is active. A value of 1 means that the collection is in an ACTIVE state. |
| aws_aoss_IngestionDataRate | IngestionDataRate | Ingestion Data Rate | Count | Sum | The indexing rate in GiB per second to a collection or index. This metric only applies to bulk indexing requests. |
| aws_aoss_IngestionDocumentErrors | IngestionDocumentErrors | Ingestion Document Errors | Count | Sum | The total number of document errors during ingestion for a collection or index. |
| aws_aoss_IngestionDocumentRate | IngestionDocumentRate | Ingestion Document Rate | Count | Sum | The rate per second at which documents are being ingested to a collection or index. |
| aws_aoss_IngestionRequestErrors | IngestionRequestErrors | Ingestion Request Errors | Count | Sum | The total number of bulk indexing request errors to a collection. |
| aws_aoss_IngestionRequestLatency | IngestionRequestLatency | Ingestion Request Latency | Seconds | Average | The latency, in seconds, for bulk write operations to a collection. |
| aws_aoss_IngestionRequestRate | IngestionRequestRate | Ingestion Request Rate | Count | Average | The total number of bulk write operations received by a collection. |
| aws_aoss_IngestionRequestSuccess | IngestionRequestSuccess | Ingestion Request Success | Count | Sum | The total number of successful indexing operations to a collection. |
| aws_aoss_StorageUsedInS3 | StorageUsedInS3 | Storage Used In S3 | Bytes | Sum | The amount, in bytes, of Amazon S3 storage used. OpenSearch Serverless stores indexed data in Amazon S3. |
| aws_aoss_VectorIndexBuildAccelerationOCU | VectorIndexBuildAccelerationOCU | Vector Index Build Acceleration OCU | Count | Sum | The number of OpenSearch Compute Units (OCUs) used to accelerate vector indexing. |
OpenSearch Ingestion Pipelines metrics
| OpsRamp Metric | AWS Metric | Metric Display Name | Unit | Aggregation Type | Description |
|---|---|---|---|---|---|
| aws_osis_system_cpu_usage_value | system.cpu.usage.value | CPU Usage | Percent | Average | The percentage of available CPU usage for all data nodes. |
| aws_osis_system_cpu_count_value | system.cpu.count.value | CPU Count | Count | Average | The total amount of CPU usage for all data nodes. |
| aws_osis_jvm_memory_max_value | jvm.memory.max.value | JVM Memory Max | Bytes | Average | The maximum amount of memory that can be used for memory management, in bytes. |
| aws_osis_jvm_memory_used_value | jvm.memory.used.value | JVM Memory Used | Bytes | Average | The total amount of memory used, in bytes. |
| aws_osis_jvm_memory_committed_value | jvm.memory.committed.value | JVM Memory Committed | Bytes | Average | The amount of memory that is committed for use by the Java virtual machine (JVM), in bytes. |
| aws_osis_computeUnits | computeUnits | Compute Units | Count | Average | The number of Ingestion OpenSearch Compute Units (Ingestion OCUs) in use by a pipeline. |