Terraform module that configures important elasticsearch alerts using CloudWatch and sends them to an SNS topic.
Create a set of sane Elasticsearch CloudWatch alerts for monitoring the health of an elasticsearch cluster.
This project is inspired by CloudPosse
It's 100% Open Source and licensed under the APACHE2.
area | metric | comparison operator | threshold | rationale |
---|---|---|---|---|
Sharding | ClusterStatus.red | >= |
1 | At least one primary shard and its replicas are not allocated to a node for 1 minute 1 consecutive time. Threshold should always be 1. |
Sharding | ClusterStatus.yellow | >= |
1 | At least one replica shard is not allocated to a node for 1 minute 1 consecutive time. Threshold should always be 1. |
Storage | FreeStorageSpace | <= |
20480 MB | A node in your cluster is down to 20 GiB of free storage space for 1 minute 1 consecutive time. This value is in MiB, so rather than 20480, we recommend setting it to 25% of the storage space for each node. |
Storage | ClusterIndexWritesBlocked | >= |
1 | The cluster is blocking write requests for 5 minutes 1 consecutive time. Threshold should always be 1. |
Node Count | Nodes | < |
x |
x is the number of nodes in your cluster. This alarm indicates that at least one node in your cluster has been unreachable for one day. |
Snapshot | AutomatedSnapshotFailure | >= |
1 | An automated snapshot failed for 1 minute 1 consecutive time. This failure is often the result of a red cluster health status. |
CPU | CPUUtilization | >= |
80 % | CPU utilization average is >= 80% for 15 minutes, 3 consecutive times for the node cluster. |
Memory | JVMMemoryPressure | >= |
80 % | JVMMemoryPressure maximum is >= 80% for 15 minutes, 1 consecutive time. |
CPU | MasterCPUUtilization | >= |
80 % | Dedicated master nodes' CPU utilization is >= 80% for 15 minutes, 3 consecutive times. |
Memory | MasterJVMMemoryPressure | >= |
80 % | Dedicated master nodes' maximum JVM memory usage is >= 80% for 15 minutes, 1 consecutive time. |
See the examples/
directory for working examples.
resource "aws_elasticsearch_domain" "es" {
domain_name = "example"
elasticsearch_version = "6.3"
cluster_config {
instance_type = "r4.large.elasticsearch"
}
snapshot_options {
automated_snapshot_start_hour = 23
}
tags = {
Domain = "TestDomain"
}
}
module "es_alarms" {
source = "github::https://github.com/dubiety/terraform-aws-elasticsearch-cloudwatch-sns-alarms.git?ref=master"
domain_name = "example"
}
Name | Description | Type | Default | Required |
---|---|---|---|---|
domain_name |
The Elasticserach domain name you want to monitor. | string | - | yes |
alarm_name_postfix |
Alarm name postfix | string | "" |
no |
alarm_name_prefix |
Alarm name prefix | string | "" |
no |
cpu_utilization_threshold |
The maximum percentage of CPU utilization | string | 80 |
no |
free_storage_space_threshold |
The minimum amount of available storage space in Byte. | string | 21474836480 |
no |
jvm_memory_pressure_threshold |
The maximum percentage of the Java heap used for all data nodes in the cluster | string | 80 |
no |
master_cpu_utilization_threshold |
The maximum percentage of CPU utilization of master nodes | string | "" |
no |
master_jvm_memory_pressure_threshold |
The maximum percentage of the Java heap used for master nodes in the cluster | string | "" |
no |
min_available_nodes |
The minimum available (reachable) nodes to have | string | 1 |
no |
monitor_automated_snapshot_failure |
Enable monitoring of automated snapshot failure | string | true |
no |
monitor_cluster_index_writes_blocked |
Enable monitoring of cluster index writes being blocked | string | true |
no |
monitor_cluster_status_is_red |
Enable monitoring of cluster status is in red | string | true |
no |
monitor_cluster_status_is_yellow |
Enable monitoring of cluster status is in yellow | string | true |
no |
monitor_cpu_utilization_too_high |
Enable monitoring of CPU utilization is too high | string | true |
no |
monitor_free_storage_space_too_low |
Enable monitoring of cluster average free storage is to low | string | true |
no |
monitor_insufficient_available_nodes |
Enable monitoring insufficient available nodes | string | false |
no |
monitor_jvm_memory_pressure_too_high |
Enable monitoring of JVM memory pressure is too high | string | true |
no |
monitor_master_cpu_utilization_too_high |
Enable monitoring of CPU utilization of master nodes are too high. Only enable this when dedicated master is enabled | string | false |
no |
monitor_master_jvm_memory_pressure_too_high |
Enable monitoring of JVM memory pressure of master nodes are too high. Only enable this wwhen dedicated master is enabled | string | false |
no |
sns_topic |
SNS topic you want to specify. If leave empty, it will use a prefix and a timestampe appended | string | "" |
no |
Name | Description |
---|---|
sns_topic_arn |
The ARN of the SNS topic |
sns_topic_name |
The SNS topic name |
Like this project? Please give it a ★ on our GitHub!
Got a question?
File a GitHub issue.
Please use the issue tracker to report any bugs or file feature requests.
See LICENSE for full details.
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.