Note
A Terraform deployment option is also available. You can find the required .tf file HERE
Deploying the CloudFormation / Terraform in this repository will create CloudWatch Alarms - that will trigger email alerts via. SNS notification - for the metrics documented in the table below.
To deploy the CloudWatch alarms via. CloudFormation click the button
When prompted by CloudFormation enter the name of the OpenSearch domain to monitor and the email address you want notifications to be send to
AWS documention recomends these CloudWatch alarms as a means of monitoring an OpenSearch domain
| Metric name | Statistic | Period (second) | ComparisonOperator | Threshold | EvaluationPeriods |
|---|---|---|---|---|---|
| ClusterStatus.red | Maximum | 60 | GreaterThanOrEqualToThreshold | 1 | 1 |
| ClusterStatus.yellow | Maximum | 60 | GreaterThanOrEqualToThreshold | 1 | 5 |
| FreeStorageSpace | Minimum | 60 | LessThanOrEqualToThreshold | 20480 | 1 |
| ClusterIndexWritesBlocked | Maximum | 300 | GreaterThanOrEqualToThreshold | 1 | 1 |
| AutomatedSnapshotFailure | Maximum | 60 | GreaterThanOrEqualToThreshold | 1 | 1 |
| CPUUtilization | Maximum | 900 | GreaterThanOrEqualToThreshold | 80 | 3 |
| JVMMemoryPressure | Maximum | 60 | GreaterThanOrEqualToThreshold | 95 | 3 |
| OldGenJVMMemoryPressure | Maximum | 60 | GreaterThanOrEqualToThreshold | 80 | 3 |
| MasterCPUUtilization | Maximum | 900 | GreaterThanOrEqualToThreshold | 50 | 3 |
| MasterJVMMemoryPressure | Maximum | 60 | GreaterThanOrEqualToThreshold | 95 | 3 |
| MasterOldGenJVMMemoryPressure | Maximum | 60 | GreaterThanOrEqualToThreshold | 80 | 3 |
| KMSKeyError | Maximum | 60 | GreaterThanOrEqualToThreshold | 1 | 1 |
| KMSKeyInaccessible | Maximum | 60 | GreaterThanOrEqualToThreshold | 1 | 1 |
| Shards.active | Maximum | 60 | GreaterThanOrEqualToThreshold | 30000 | 1 |
| MasterReachableFromNode | Maximum | 86400 | LessThanThreshold | 1 | 1 |
| ThreadpoolWriteQueue | Average | 60 | GreaterThanOrEqualToThreshold | 100 | 1 |
| ThreadpoolSearchQueue | Average | 60 | GreaterThanOrEqualToThreshold | 500 | 1 |
| ThreadpoolSearchQueue | Maximum | 60 | GreaterThanOrEqualToThreshold | 5000 | 1 |
| ThreadpoolWriteRejected | Maximum | 60 | GreaterThanOrEqualToThreshold | 1 | 1 |
| ThreadpoolSearchRejected | Maximum | 60 | GreaterThanOrEqualToThreshold | 1 | 1 |
| Nodes | Minimum | 86400 | LessThanThreshold | 1 | 1 |
- Add alarm for IOPS Throttle | Maximum | 300 seconds | GreaterThanOrEqualToThreshold | 1 | 2
- Add alarm for Throughput Throttle | Maximum | 300 seconds | GreaterThanOrEqualToThreshold | 1 | 2
- Add alarm for ReadThroughputMicroBursting + WriteThroughputMicroBursting | SUM ReadThroughputMicroBursting + WriteThroughputMicroBursting | 300 | GreaterThan | Provisioned Throughput of EBS volume(s) | 2
- Simply user inputs to their email and cluster ARN. Automaticlly get the other required cluster information using the ARN
- Add alarms for metrics of the dedicated cordinator nodes