terraform-datadog-old-monitors/database/elasticsearch/README.md

DATABASE ELASTICSEARCH DataDog monitors

How to use this module

module "datadog-monitors-database-elasticsearch" {
  source      = "claranet/monitors/datadog//database/elasticsearch"
  version     = "{revision}"

  environment = var.environment
  message     = module.datadog-message-alerting.alerting-message
}

Purpose

Creates DataDog monitors with the following checks:

• Elasticsearch average index flushing to disk latency
• Elasticsearch average indexing latency by document
• Elasticsearch average Old-generation garbage collections latency
• Elasticsearch average search fetch latency
• Elasticsearch average search query latency
• Elasticsearch average Young-generation garbage collections latency
• Elasticsearch change alert on the average time spent by tasks in the queue
• Elasticsearch change alert on the number of currently active queries
• Elasticsearch change alert on the number of query cache evictions
• Elasticsearch change alert on the number of request cache evictions
• Elasticsearch change alert on the number of search fetches currently running
• Elasticsearch change alert on the total number of evictions from the fielddata cache
• ElasticSearch Cluster has unassigned shards
• ElasticSearch Cluster is initializing shards
• ElasticSearch Cluster is relocating shards
• ElasticSearch Cluster status not green
• ElasticSearch does not respond
• ElasticSearch free space < 10%
• Elasticsearch JVM HEAP memory usage
• Elasticsearch JVM memory Old usage
• Elasticsearch JVM memory Young usage
• Elasticsearch number of current open HTTP connections anomaly detected

Requirements

Name	Version
terraform	>= 0.12.31
datadog	>= 3.1.0

Providers

Name	Version
datadog	3.1.2

Modules

Name	Source	Version
filter-tags	../../common/filter-tags	n/a

Resources

Name	Type
datadog_monitor.cluster_initializing_shards	resource
datadog_monitor.cluster_relocating_shards	resource
datadog_monitor.cluster_status_not_green	resource
datadog_monitor.cluster_unassigned_shards	resource
datadog_monitor.fetch_change	resource
datadog_monitor.fetch_latency	resource
datadog_monitor.field_data_evictions_change	resource
datadog_monitor.flush_latency	resource
datadog_monitor.http_connections_anomaly	resource
datadog_monitor.indexing_latency	resource
datadog_monitor.jvm_gc_old_collection_latency	resource
datadog_monitor.jvm_gc_young_collection_latency	resource
datadog_monitor.jvm_heap_memory_usage	resource
datadog_monitor.jvm_memory_old_usage	resource
datadog_monitor.jvm_memory_young_usage	resource
datadog_monitor.node_free_space	resource
datadog_monitor.not_responding	resource
datadog_monitor.query_cache_evictions_change	resource
datadog_monitor.request_cache_evictions_change	resource
datadog_monitor.search_query_change	resource
datadog_monitor.search_query_latency	resource
datadog_monitor.task_time_in_queue_change	resource

Inputs

Name	Description	Type	Default	Required
cluster_initializing_shards_enabled	Flag to enable Cluster Status monitor	string	"true"	no
cluster_initializing_shards_extra_tags	Extra tags for Cluster Status monitor	list(string)	[]	no
cluster_initializing_shards_message	Custom message for the Cluster Status monitor	string	""	no
cluster_initializing_shards_threshold_critical	Cluster Status critical threshold	string	2	no
cluster_initializing_shards_threshold_warning	Cluster Status warning threshold	string	1	no
cluster_initializing_shards_time_aggregator	Time aggregator for the Cluster Status monitor	string	"avg"	no
cluster_initializing_shards_timeframe	Timeframe for the Cluster Status monitor	string	"last_5m"	no
cluster_relocating_shards_enabled	Flag to enable Cluster Status monitor	string	"true"	no
cluster_relocating_shards_extra_tags	Extra tags for Cluster Status monitor	list(string)	[]	no
cluster_relocating_shards_message	Custom message for the Cluster Status monitor	string	""	no
cluster_relocating_shards_threshold_critical	Cluster Status critical threshold	string	2	no
cluster_relocating_shards_threshold_warning	Cluster Status warning threshold	string	1	no
cluster_relocating_shards_time_aggregator	Time aggregator for the Cluster Status monitor	string	"avg"	no
cluster_relocating_shards_timeframe	Timeframe for the Cluster Status monitor	string	"last_5m"	no
cluster_status_not_green_enabled	Flag to enable Cluster Status monitor	string	"true"	no
cluster_status_not_green_extra_tags	Extra tags for Cluster Status monitor	list(string)	[]	no
cluster_status_not_green_message	Custom message for the Cluster Status monitor	string	""	no
cluster_status_not_green_threshold_critical	Cluster Status critical threshold	string	0	no
cluster_status_not_green_threshold_warning	Cluster Status warning threshold	string	1	no
cluster_status_not_green_time_aggregator	Time aggregator for the Cluster Status monitor	string	"avg"	no
cluster_status_not_green_timeframe	Timeframe for the Cluster Status monitor	string	"last_5m"	no
cluster_unassigned_shards_enabled	Flag to enable Cluster Status monitor	string	"true"	no
cluster_unassigned_shards_extra_tags	Extra tags for Cluster Status monitor	list(string)	[]	no
cluster_unassigned_shards_message	Custom message for the Cluster Status monitor	string	""	no
cluster_unassigned_shards_threshold_critical	Cluster Status critical threshold	string	2	no
cluster_unassigned_shards_threshold_warning	Cluster Status warning threshold	string	1	no
cluster_unassigned_shards_time_aggregator	Time aggregator for the Cluster Status monitor	string	"avg"	no
cluster_unassigned_shards_timeframe	Timeframe for the Cluster Status monitor	string	"last_5m"	no
environment	Architecture environment	string	n/a	yes
evaluation_delay	Delay in seconds for the metric evaluation	number	15	no
fetch_change_enabled	Flag to enable Cluster Status monitor	string	"true"	no
fetch_change_extra_tags	Extra tags for Cluster Status monitor	list(string)	[]	no
fetch_change_message	Custom message for the Cluster Status monitor	string	""	no
fetch_change_threshold_critical	Cluster Status critical threshold	string	100	no
fetch_change_threshold_warning	Cluster Status warning threshold	string	75	no
fetch_change_time_aggregator	Time aggregator for the Cluster Status monitor	string	"avg"	no
fetch_change_timeframe	Timeframe for the Cluster Status monitor	string	"last_10m"	no
fetch_change_timeshift	Timeshift for the Cluster Status monitor	string	"last_10m"	no
fetch_latency_enabled	Flag to enable Cluster Status monitor	string	"true"	no
fetch_latency_extra_tags	Extra tags for Cluster Status monitor	list(string)	[]	no
fetch_latency_message	Custom message for the Cluster Status monitor	string	""	no
fetch_latency_threshold_critical	Cluster Status critical threshold	string	20	no
fetch_latency_threshold_warning	Cluster Status warning threshold	string	10	no
fetch_latency_time_aggregator	Time aggregator for the Cluster Status monitor	string	"min"	no
fetch_latency_timeframe	Timeframe for the Cluster Status monitor	string	"last_15m"	no
field_data_evictions_change_enabled	Flag to enable Cluster Status monitor	string	"true"	no
field_data_evictions_change_extra_tags	Extra tags for Cluster Status monitor	list(string)	[]	no
field_data_evictions_change_message	Custom message for the Cluster Status monitor	string	""	no
field_data_evictions_change_threshold_critical	Cluster Status critical threshold	string	120	no
field_data_evictions_change_threshold_warning	Cluster Status warning threshold	string	60	no
field_data_evictions_change_time_aggregator	Time aggregator for the Cluster Status monitor	string	"avg"	no
field_data_evictions_change_timeframe	Timeframe for the Cluster Status monitor	string	"last_15m"	no
field_data_evictions_change_timeshift	Timeframe for the Cluster Status monitor	string	"last_15m"	no
filter_tags_custom	Tags used for custom filtering when filter_tags_use_defaults is false	string	"*"	no
filter_tags_custom_excluded	Tags excluded for custom filtering when filter_tags_use_defaults is false	string	""	no
filter_tags_use_defaults	Use default filter tags convention	string	"true"	no
flush_latency_enabled	Flag to enable Cluster Status monitor	string	"true"	no
flush_latency_extra_tags	Extra tags for Cluster Status monitor	list(string)	[]	no
flush_latency_message	Custom message for the Cluster Status monitor	string	""	no
flush_latency_threshold_critical	Cluster Status critical threshold	string	150	no
flush_latency_threshold_warning	Cluster Status warning threshold	string	100	no
flush_latency_time_aggregator	Time aggregator for the Cluster Status monitor	string	"avg"	no
flush_latency_timeframe	Timeframe for the Cluster Status monitor	string	"last_15m"	no
http_connections_anomaly_alert_window	Alert window.	string	"last_15m"	no
http_connections_anomaly_count_default_zero	Count default zero.	string	"true"	no
http_connections_anomaly_detection_algorithm	Anomaly Detection Algorithm used	string	"agile"	no
http_connections_anomaly_deviations	Deviations to detect the anomaly	string	2	no
http_connections_anomaly_direction	Direction of the anomaly. It can be both, below or above.	string	"above"	no
http_connections_anomaly_enabled	Flag to enable Cluster Status monitor	string	"true"	no
http_connections_anomaly_extra_tags	Extra tags for Cluster Status monitor	list(string)	[]	no
http_connections_anomaly_interval	Interval.	string	60	no
http_connections_anomaly_message	Custom message for the Cluster Status monitor	string	""	no
http_connections_anomaly_seasonality	Seasonality of the algorithm	string	"hourly"	no
http_connections_anomaly_threshold_critical	Cluster Status critical threshold	string	1	no
http_connections_anomaly_threshold_warning	Cluster Status warning threshold	string	0.75	no
http_connections_anomaly_time_aggregator	Time aggregator for the Cluster Status monitor	string	"avg"	no
http_connections_anomaly_timeframe	Timeframe for the Cluster Status monitor	string	"last_4h"	no
indexing_latency_enabled	Flag to enable Cluster Status monitor	string	"true"	no
indexing_latency_extra_tags	Extra tags for Cluster Status monitor	list(string)	[]	no
indexing_latency_message	Custom message for the Cluster Status monitor	string	""	no
indexing_latency_threshold_critical	Cluster Status critical threshold	string	30	no
indexing_latency_threshold_warning	Cluster Status warning threshold	string	15	no
indexing_latency_time_aggregator	Time aggregator for the Cluster Status monitor	string	"avg"	no
indexing_latency_timeframe	Timeframe for the Cluster Status monitor	string	"last_10m"	no
jvm_gc_old_collection_latency_enabled	Flag to enable Cluster Status monitor	string	"true"	no
jvm_gc_old_collection_latency_extra_tags	Extra tags for Cluster Status monitor	list(string)	[]	no
jvm_gc_old_collection_latency_message	Custom message for the Cluster Status monitor	string	""	no
jvm_gc_old_collection_latency_threshold_critical	Cluster Status critical threshold	string	300	no
jvm_gc_old_collection_latency_threshold_warning	Cluster Status warning threshold	string	200	no
jvm_gc_old_collection_latency_time_aggregator	Time aggregator for the Cluster Status monitor	string	"avg"	no
jvm_gc_old_collection_latency_timeframe	Timeframe for the Cluster Status monitor	string	"last_15m"	no
jvm_gc_young_collection_latency_enabled	Flag to enable Cluster Status monitor	string	"true"	no
jvm_gc_young_collection_latency_extra_tags	Extra tags for Cluster Status monitor	list(string)	[]	no
jvm_gc_young_collection_latency_message	Custom message for the Cluster Status monitor	string	""	no
jvm_gc_young_collection_latency_threshold_critical	Cluster Status critical threshold	string	40	no
jvm_gc_young_collection_latency_threshold_warning	Cluster Status warning threshold	string	20	no
jvm_gc_young_collection_latency_time_aggregator	Time aggregator for the Cluster Status monitor	string	"avg"	no
jvm_gc_young_collection_latency_timeframe	Timeframe for the Cluster Status monitor	string	"last_15m"	no
jvm_heap_memory_usage_enabled	Flag to enable Cluster Status monitor	string	"true"	no
jvm_heap_memory_usage_extra_tags	Extra tags for Cluster Status monitor	list(string)	[]	no
jvm_heap_memory_usage_message	Custom message for the Cluster Status monitor	string	""	no
jvm_heap_memory_usage_threshold_critical	Cluster Status critical threshold	string	90	no
jvm_heap_memory_usage_threshold_warning	Cluster Status warning threshold	string	80	no
jvm_heap_memory_usage_time_aggregator	Time aggregator for the Cluster Status monitor	string	"avg"	no
jvm_heap_memory_usage_timeframe	Timeframe for the Cluster Status monitor	string	"last_5m"	no
jvm_memory_old_usage_enabled	Flag to enable Cluster Status monitor	string	"true"	no
jvm_memory_old_usage_extra_tags	Extra tags for Cluster Status monitor	list(string)	[]	no
jvm_memory_old_usage_message	Custom message for the Cluster Status monitor	string	""	no
jvm_memory_old_usage_threshold_critical	Cluster Status critical threshold	string	90	no
jvm_memory_old_usage_threshold_warning	Cluster Status warning threshold	string	80	no
jvm_memory_old_usage_time_aggregator	Time aggregator for the Cluster Status monitor	string	"avg"	no
jvm_memory_old_usage_timeframe	Timeframe for the Cluster Status monitor	string	"last_10m"	no
jvm_memory_young_usage_enabled	Flag to enable Cluster Status monitor	string	"true"	no
jvm_memory_young_usage_extra_tags	Extra tags for Cluster Status monitor	list(string)	[]	no
jvm_memory_young_usage_message	Custom message for the Cluster Status monitor	string	""	no
jvm_memory_young_usage_threshold_critical	Cluster Status critical threshold	string	90	no
jvm_memory_young_usage_threshold_warning	Cluster Status warning threshold	string	80	no
jvm_memory_young_usage_time_aggregator	Time aggregator for the Cluster Status monitor	string	"avg"	no
jvm_memory_young_usage_timeframe	Timeframe for the Cluster Status monitor	string	"last_10m"	no
message	Message sent when a monitor is triggered	any	n/a	yes
new_host_delay	Delay in seconds before begin to monitor new host	number	300	no
node_free_space_enabled	Flag to enable Cluster Status monitor	string	"true"	no
node_free_space_extra_tags	Extra tags for Cluster Status monitor	list(string)	[]	no
node_free_space_message	Custom message for the Cluster Status monitor	string	""	no
node_free_space_threshold_critical	Cluster Status critical threshold	string	10	no
node_free_space_threshold_warning	Cluster Status warning threshold	string	20	no
node_free_space_time_aggregator	Time aggregator for the Cluster Status monitor	string	"sum"	no
node_free_space_timeframe	Timeframe for the Cluster Status monitor	string	"last_5m"	no
not_responding_enabled	Flag to enable Elasticsearch does not respond monitor	string	"true"	no
not_responding_extra_tags	Extra tags for Elasticsearch does not respond monitor	list(string)	[]	no
not_responding_message	Custom message for Elasticsearch does not respond monitor	string	""	no
not_responding_no_data_timeframe	Elasticsearch not responding monitor no data timeframe	string	10	no
not_responding_threshold_warning	Elasticsearch not responding limit (warning threshold)	number	3	no
notify_no_data	Will raise no data alert if set to true	bool	true	no
prefix_slug	Prefix string to prepend between brackets on every monitors names	string	""	no
query_cache_evictions_change_enabled	Flag to enable Cluster Status monitor	string	"true"	no
query_cache_evictions_change_extra_tags	Extra tags for Cluster Status monitor	list(string)	[]	no
query_cache_evictions_change_message	Custom message for the Cluster Status monitor	string	""	no
query_cache_evictions_change_threshold_critical	Cluster Status critical threshold	string	120	no
query_cache_evictions_change_threshold_warning	Cluster Status warning threshold	string	60	no
query_cache_evictions_change_time_aggregator	Time aggregator for the Cluster Status monitor	string	"avg"	no
query_cache_evictions_change_timeframe	Timeframe for the Cluster Status monitor	string	"last_15m"	no
query_cache_evictions_change_timeshift	Timeframe for the Cluster Status monitor	string	"last_15m"	no
request_cache_evictions_change_enabled	Flag to enable Cluster Status monitor	string	"true"	no
request_cache_evictions_change_extra_tags	Extra tags for Cluster Status monitor	list(string)	[]	no
request_cache_evictions_change_message	Custom message for the Cluster Status monitor	string	""	no
request_cache_evictions_change_threshold_critical	Cluster Status critical threshold	string	120	no
request_cache_evictions_change_threshold_warning	Cluster Status warning threshold	string	60	no
request_cache_evictions_change_time_aggregator	Time aggregator for the Cluster Status monitor	string	"avg"	no
request_cache_evictions_change_timeframe	Timeframe for the Cluster Status monitor	string	"last_15m"	no
request_cache_evictions_change_timeshift	Timeshift for the Cluster Status monitor	string	"last_15m"	no
search_query_change_enabled	Flag to enable Cluster Status monitor	string	"true"	no
search_query_change_extra_tags	Extra tags for Cluster Status monitor	list(string)	[]	no
search_query_change_message	Custom message for the Cluster Status monitor	string	""	no
search_query_change_threshold_critical	Cluster Status critical threshold	string	100	no
search_query_change_threshold_warning	Cluster Status warning threshold	string	75	no
search_query_change_time_aggregator	Time aggregator for the Cluster Status monitor	string	"avg"	no
search_query_change_timeframe	Timeframe for the Cluster Status monitor	string	"last_10m"	no
search_query_change_timeshift	Timeshift for the Cluster Status monitor	string	"last_10m"	no
search_query_latency_enabled	Flag to enable Cluster Status monitor	string	"true"	no
search_query_latency_extra_tags	Extra tags for Cluster Status monitor	list(string)	[]	no
search_query_latency_message	Custom message for the Cluster Status monitor	string	""	no
search_query_latency_threshold_critical	Cluster Status critical threshold	string	20	no
search_query_latency_threshold_warning	Cluster Status warning threshold	string	10	no
search_query_latency_time_aggregator	Time aggregator for the Cluster Status monitor	string	"avg"	no
search_query_latency_timeframe	Timeframe for the Cluster Status monitor	string	"last_15m"	no
task_time_in_queue_change_enabled	Flag to enable Cluster Status monitor	string	"true"	no
task_time_in_queue_change_extra_tags	Extra tags for Cluster Status monitor	list(string)	[]	no
task_time_in_queue_change_message	Custom message for the Cluster Status monitor	string	""	no
task_time_in_queue_change_threshold_critical	Cluster Status critical threshold	string	200	no
task_time_in_queue_change_threshold_warning	Cluster Status warning threshold	string	100	no
task_time_in_queue_change_time_aggregator	Time aggregator for the Cluster Status monitor	string	"avg"	no
task_time_in_queue_change_timeframe	Timeframe for the Cluster Status monitor	string	"last_10m"	no
task_time_in_queue_change_timeshift	Timeshift for the Cluster Status monitor	string	"last_10m"	no

Outputs

Name	Description
cluster_initializing_shards_id	id for monitor cluster_initializing_shards
cluster_relocating_shards_id	id for monitor cluster_relocating_shards
cluster_status_not_green_id	id for monitor cluster_status_not_green
cluster_unassigned_shards_id	id for monitor cluster_unassigned_shards
fetch_change_id	id for monitor fetch_change
fetch_latency_id	id for monitor fetch_latency
field_data_evictions_change_id	id for monitor field_data_evictions_change
flush_latency_id	id for monitor flush_latency
http_connections_anomaly_id	id for monitor http_connections_anomaly
indexing_latency_id	id for monitor indexing_latency
jvm_gc_old_collection_latency_id	id for monitor jvm_gc_old_collection_latency
jvm_gc_young_collection_latency_id	id for monitor jvm_gc_young_collection_latency
jvm_heap_memory_usage_id	id for monitor jvm_heap_memory_usage
jvm_memory_old_usage_id	id for monitor jvm_memory_old_usage
jvm_memory_young_usage_id	id for monitor jvm_memory_young_usage
node_free_space_id	id for monitor node_free_space
not_responding_id	id for monitor not_responding
query_cache_evictions_change_id	id for monitor query_cache_evictions_change
request_cache_evictions_change_id	id for monitor request_cache_evictions_change
search_query_change_id	id for monitor search_query_change
search_query_latency_id	id for monitor search_query_latency
task_time_in_queue_change_id	id for monitor task_time_in_queue_change

Related documentation

• Integration Datadog & ElasticSearch
• How to monitor ElasticSearch with Datadog