Amazon Elasticsearch Service is a fully managed service that is easy to deploy, easy to secure, and cost effective at scale.
Features include:
- Support for the tools that build, monitor, and troubleshoot your applications at the scale that you need.
- Support for open source Elasticsearch APIs, managed Kibana, integration with Logstash and other AWS services, and built-in alerting and SQL querying.
- Pay for only what is used with no upfront costs or usage requirements. For example, you can get the ELK stack that you need, without the operational overhead.
Use the AWS public cloud integration to discover and collect metrics against the AWS service.
External reference
What Is Amazon Elasticsearch Service?
Setup
To set up the AWS integration and discover the AWS service, go to AWS Integration Discovery Profile and select Elastic Search Service.
Event support
CloudTrail event support
- Supported
- Configurable in OpsRamp AWS Integration Discovery Profile.
CloudWatch alarm support
- Not Supported
Supported metrics
| OpsRamp Metric | AWS Metric | Metric Display Name | Unit | Aggregation Type | Description |
|---|---|---|---|---|---|
| aws_es_ClusterStatus_green_es | ClusterStatus.green | Cluster Status green | None | Maximum | A value of 1 indicates that all index shards are allocated to nodes in the cluster. |
| aws_es_ClusterStatus_yellow_es | ClusterStatus.yellow | Cluster Status yellow | None | Maximum | A value of 1 indicates that the primary shards for all indexes are allocated to nodes in the cluster, but replica shards for at least one index are not. |
| aws_es_ClusterStatus_red_es | ClusterStatus.red | Cluster Status red | None | Maximum | A value of 1 indicates that the primary and replica shards for at least one index are not allocated to nodes in the cluster. |
| aws_es_Shards_active | Shards.active | Shards active | Count | Maximum | The total number of active primary and replica shards. |
| aws_es_Shards_unassigned | Shards.unassigned | Shards unassigned | Count | Maximum | The number of shards that are not allocated to nodes in the cluster. |
| aws_es_Shards_delayedUnassigned | Shards.delayedUnassigned | Shards delayed Unassigned | Count | Maximum | The number of shards whose node allocation has been delayed by the timeout settings. |
| aws_es_Shards_activePrimary | Shards.activePrimary | Shards active Primary | Count | Maximum | The number of active primary shards. |
| aws_es_Shards_initializing | Shards.initializing | Shards initializing | Count | Sum | The number of shards that are under initialization. |
| aws_es_Shards_relocating | Shards.relocating | Shards relocating | Count | Sum | The number of shards that are under relocation. |
| aws_es_Nodes | Nodes | Nodes | Count | Maximum | The number of nodes in the OpenSearch Service cluster, including dedicated master nodes and Warm nodes. |
| aws_es_SearchableDocuments | SearchableDocuments | Searchable Documents | Count | Maximum | The total number of searchable documents across all data nodes in the cluster. |
| aws_es_DeletedDocuments | DeletedDocuments | Deleted Documents | Count | Maximum | The total number of documents marked for deletion across all data nodes in the cluster. |
| aws_es_CPUUtilization | CPUUtilization | CPU Utilization | Percent | Maximum | The percentage of CPU usage for data nodes in the cluster. |
| aws_es_FreeStorageSpace | FreeStorageSpace | Free Storage Space | None | Maximum | The free space for data nodes in the cluster. |
| aws_es_ClusterUsedSpace | ClusterUsedSpace | Cluster Used Space | None | Maximum | The total used space for the cluster. You must leave the period at one minute to get an accurate value. |
| aws_es_ClusterIndexWritesBlocked | ClusterIndexWritesBlocked | Cluster Index Writes Blocked | None | Maximum | Indicates whether your cluster is accepting or blocking incoming write requests. |
| aws_es_JVMMemoryPressure_Multi_AZ | JVMMemoryPressure | JVM Memory Pressure (Multi-AZ) | Percent | Maximum | The maximum percentage of the Java heap used for all data nodes in the cluster. |
| aws_es_OldGenJVMMemoryPressure | OldGenJVMMemoryPressure | Old Gen JVM Memory Pressure | Percent | Maximum | The maximum percentage of the Java heap used for the old generation on all data nodes in the cluster. |
| aws_es_AutomatedSnapshotFailure | AutomatedSnapshotFailure | Automated Snapshot Failure | Count | Maximum | The number of failed automated snapshots for the cluster. |
| aws_es_CPUCreditBalance | CPUCreditBalance | CPU Credit Balance | Count | Minimum | The remaining CPU credits available for data nodes in the cluster. |
| aws_es_KibanaHealthyNodes | KibanaHealthyNodes | Kibana Healthy Nodes | Count | Minimum | A health check for Kibana. |
| aws_es_OpenSearchDashboardsHealthyNodes | OpenSearchDashboardsHealthyNodes | Open Search Dashboards Healthy Nodes | None | Maximum | A health check for OpenSearch Dashboards. |
| aws_es_OpensearchDashboardsReportingFailedRequestSysErrCount | OpensearchDashboardsReportingFailedRequestSysErrCount | Opensearch Dashboards Reporting Failed Request Sys Err Count | Count | Sum | The number of requests to generate OpenSearch Dashboards reports that failed due to server problems or feature limitations. |
| aws_es_OpensearchDashboardsReportingFailedRequestUserErrCount | OpensearchDashboardsReportingFailedRequestUserErrCount | Opensearch Dashboards Reporting Failed Request User Err Count | Count | Sum | The number of requests to generate OpenSearch Dashboards reports that failed due to client issues. |
| aws_es_OpensearchDashboardsReportingRequestCount | OpensearchDashboardsReportingRequestCount | Opensearch Dashboards Reporting Request Count | Count | Sum | The total number of requests to generate OpenSearch Dashboards reports. |
| aws_es_OpensearchDashboardsReportingSuccessCount | OpensearchDashboardsReportingSuccessCount | Opensearch Dashboards Reporting Success Count | Count | Sum | The number of successful requests to generate OpenSearch Dashboards reports. |
| aws_es_KMSKeyError | KMSKeyError | KMS Key Error | None | Maximum | A value of 1 indicates that the AWS KMS key used to encrypt data at rest has been disabled. |
| aws_es_KMSKeyInaccessible | KMSKeyInaccessible | KMS Key Inaccessible | None | Maximum | A value of 1 indicates that the AWS KMS key used to encrypt data at rest has been deleted or revoked its grants to OpenSearch Service. |
| aws_es_InvalidHostHeaderRequests | InvalidHostHeaderRequests | Invalid Host Header Requests | None | Sum | The number of HTTP requests made to the OpenSearch cluster that included an invalid (or missing) host header. |
| aws_es_OpenSearchRequests | OpenSearchRequests | Open Search Requests | None | Sum | The number of requests made to the OpenSearch cluster. |
| aws_es_2xx | 2xx | 2xx | None | Sum | The number of requests to the domain that resulted in the given HTTP response code |
| aws_es_3xx | 3xx | 3xx | None | Sum | The number of requests to the domain that resulted in the given HTTP response code |
| aws_es_4xx | 4xx | 4xx | None | Sum | The number of requests to the domain that resulted in the given HTTP response code |
| aws_es_5xx | 5xx | 5xx | None | Sum | The number of requests to the domain that resulted in the given HTTP response code |
| aws_es_ThroughputThrottle | ThroughputThrottle | Throughput Throttle | None | Maximum | Indicates whether or not disks have been throttled. |
| aws_es_IopsThrottle | IopsThrottle | Iops Throttle | None | Maximum | Indicates whether or not the number of input/output operations per second (IOPS) on the domain have been throttled. |
| aws_es_HighSwapUsage | HighSwapUsage | High Swap Usage | None | Maximum | A value of 1 indicates that swapping due to page faults has potentially caused spikes in underlying disk usage during a specific time period. |
| aws_es_MasterCPUUtilization | MasterCPUUtilization | Master CPU Utilization | Percent | Maximum | The maximum percentage of CPU resources used by the dedicated master nodes. |
| aws_es_MasterFreeStorageSpace | MasterFreeStorageSpace | Master Free Storage Space | Percent | Maximum | This metric is not relevant and can be ignored. The service does not use master nodes as data nodes. |
| aws_es_MasterJVMMemoryPressure | MasterJVMMemoryPressure | Master JVM Memory Pressure | Percent | Maximum | The maximum percentage of the Java heap used for all dedicated master nodes in the cluster. |
| aws_es_MasterOldGenJVMMemoryPressure | MasterOldGenJVMMemoryPressure | Master Old Gen JVM Memory Pressure | Percent | Maximum | The maximum percentage of the Java heap used for the old generation per master node. |
| aws_es_MasterCPUCreditBalance | MasterCPUCreditBalance | Master CPU Credit Balance | Count | Minimum | The remaining CPU credits available for dedicated master nodes in the cluster. |
| aws_es_MasterReachableFromNode | MasterReachableFromNode | Master Reachable From Node | None | Maximum | A health check for MasterNotDiscovered exceptions. |
| aws_es_MasterSysMemoryUtilization | MasterSysMemoryUtilization | Master Sys Memory Utilization | Percent | Maximum | The percentage of the master node's memory that is in use. |
| aws_es_AlertingDegraded | AlertingDegraded | Alerting Degraded | None | Maximum | A value of 1 means that either the alerting index is red or one or more nodes is not on schedule. A value of 0 indicates normal behavior. |
| aws_es_AlertingIndexExists | AlertingIndexExists | Alerting Index Exists | None | Maximum | A value of 1 means the .opensearch-alerting-config index exists. A value of 0 means it does not. Until you use the alerting feature for the first time, this value remains 0. |
| aws_es_AlertingIndexStatus_green | AlertingIndexStatus.green | Alerting Index Status green | None | Maximum | The health of the index. A value of 1 means green. A value of 0 means that the index either doesn't exist or isn't green. |
| aws_es_AlertingIndexStatus_red | AlertingIndexStatus.red | Alerting Index Status red | None | Maximum | The health of the index. A value of 1 means red. A value of 0 means that the index either doesn't exist or isn't red. |
| aws_es_AlertingIndexStatus_yellow | AlertingIndexStatus.yellow | Alerting Index Status yellow | None | Maximum | The health of the index. A value of 1 means yellow. A value of 0 means that the index either doesn't exist or isn't yellow. |
| aws_es_AlertingNodesNotOnSchedule | AlertingNodesNotOnSchedule | Alerting Nodes Not On Schedule | None | Maximum | A value of 1 means some jobs are not running on schedule. A value of 0 means that all alerting jobs are running on schedule (or that no alerting jobs exist). |
| aws_es_AlertingNodesOnSchedule | AlertingNodesOnSchedule | Alerting Nodes On Schedule | None | Maximum | A value of 1 means that all alerting jobs are running on schedule (or that no alerting jobs exist). A value of 0 means some jobs are not running on schedule. |
| aws_es_AlertingScheduledJobEnabled | AlertingScheduledJobEnabled | Alerting Scheduled Job Enabled | None | Maximum | A value of 1 means that the opensearch.scheduled_jobs.enabled cluster setting is true. A value of 0 means it is false, and scheduled jobs are disabled. |
| aws_es_CPUUtilization | CPUUtilization | CPU Utilization | Percent | Maximum | The percentage of CPU usage for data nodes in the cluster. |
| aws_es_FreeStorageSpace | FreeStorageSpace | Free Storage Space | None | Maximum | The free space for data nodes in the cluster. |
| aws_es_JVMMemoryPressure | JVMMemoryPressure | JVM Memory Pressure | Percent | Maximum | The maximum percentage of the Java heap used for all data nodes in the cluster. |
| aws_es_SysMemoryUtilization | SysMemoryUtilization | Sys Memory Utilization | Percent | Average | The percentage of the instance's memory that is in use. High values for this metric are normal and usually do not represent a problem with your cluster. |
| aws_es_IndexingLatency | IndexingLatency | Indexing Latency | Milliseconds | Average | The difference in total time, in milliseconds, taken by all indexing operations in a node between minute N and minute (N-1). |
| aws_es_IndexingRate | IndexingRate | Indexing Rate | Count | Average | The number of indexing operations per minute. |
| aws_es_SearchLatency | SearchLatency | Search Latency | Milliseconds | Average | The difference in total time, in milliseconds, taken by all searches in a node between minute N and minute (N-1). |
| aws_es_SearchRate | SearchRate | Search Rate | Count | Average | The total number of search requests per minute for all shards on a data node. |
| aws_es_ThreadpoolSearchQueue | ThreadpoolSearchQueue | Threadpool Search Queue | Count | Average | The number of queued tasks in the search thread pool. If the queue size is consistently high, consider scaling your cluster. The maximum search queue size is 1,000. |
| aws_es_ThreadpoolWriteQueue | ThreadpoolWriteQueue | Threadpool Write Queue | Count | Average | The number of queued tasks in the write thread pool. |
| aws_es_ThreadpoolSearchRejected | ThreadpoolSearchRejected | Threadpool Search Rejected | Count | Average | The number of rejected tasks in the search thread pool. If this number continually grows, consider scaling your cluster. |
| aws_es_ThreadpoolWriteRejected | ThreadpoolWriteRejected | Threadpool Write Rejected | Count | Average | The number of rejected tasks in the write thread pool. |
| aws_es_SQLFailedRequestCountByCusErr | SQLFailedRequestCountByCusErr | SQL Failed Request Count By Cus Err | Count | Sum | The number of requests to the _sql API that failed due to a client issue. For example, a request might return HTTP status code 400 due to an IndexNotFoundException. |
| aws_es_SQLFailedRequestCountBySysErr | SQLFailedRequestCountBySysErr | SQL Failed Request Count By Sys Err | Count | Sum | The number of requests to the _sql API that failed due to a server problem or feature limitation. For example, a request might return HTTP status code 503 due to a VerificationException. |
| aws_es_SQLRequestCount | SQLRequestCount | SQL Request Count | Count | Sum | The number of requests to the _sql API. |
| aws_es_SQLDefaultCursorRequestCount | SQLDefaultCursorRequestCount | SQL Default Cursor Request Count | Count | Sum | Similar to SQLRequestCount, but only counts pagination requests. |
| aws_es_SQLUnhealthy | SQLUnhealthy | SQL Unhealthy | None | Sum | A value of 1 indicates that, in response to certain requests, the SQL plugin is returning 5xx response codes or passing invalid query DSL to OpenSearch. |