MON-32 - Regenerate README and outputs added

This commit is contained in:
Alexandre Gaillet 2018-07-24 11:36:11 +02:00 committed by Quentin Manfroi
parent 5d2746c16a
commit d620d436ba
7 changed files with 277 additions and 232 deletions

View File

@ -80,6 +80,10 @@ The `//` is very important, it's a terraform specific syntax used to separate gi
- [aws](https://bitbucket.org/morea/terraform.feature.datadog/src/master/cloud/aws/) - [aws](https://bitbucket.org/morea/terraform.feature.datadog/src/master/cloud/aws/)
- [alb](https://bitbucket.org/morea/terraform.feature.datadog/src/master/cloud/aws/alb/) - [alb](https://bitbucket.org/morea/terraform.feature.datadog/src/master/cloud/aws/alb/)
- [apigateway](https://bitbucket.org/morea/terraform.feature.datadog/src/master/cloud/aws/apigateway/) - [apigateway](https://bitbucket.org/morea/terraform.feature.datadog/src/master/cloud/aws/apigateway/)
- [elasticache](https://bitbucket.org/morea/terraform.feature.datadog/src/master/cloud/aws/elasticache/)
- [common](https://bitbucket.org/morea/terraform.feature.datadog/src/master/cloud/aws/elasticache/common/)
- [memcached](https://bitbucket.org/morea/terraform.feature.datadog/src/master/cloud/aws/elasticache/memcached/)
- [redis](https://bitbucket.org/morea/terraform.feature.datadog/src/master/cloud/aws/elasticache/redis/)
- [elasticsearch](https://bitbucket.org/morea/terraform.feature.datadog/src/master/cloud/aws/elasticsearch/) - [elasticsearch](https://bitbucket.org/morea/terraform.feature.datadog/src/master/cloud/aws/elasticsearch/)
- [elb](https://bitbucket.org/morea/terraform.feature.datadog/src/master/cloud/aws/elb/) - [elb](https://bitbucket.org/morea/terraform.feature.datadog/src/master/cloud/aws/elb/)
- [kinesis-firehose](https://bitbucket.org/morea/terraform.feature.datadog/src/master/cloud/aws/kinesis-firehose/) - [kinesis-firehose](https://bitbucket.org/morea/terraform.feature.datadog/src/master/cloud/aws/kinesis-firehose/)

View File

@ -1,43 +1,29 @@
AWS ElastiCache Service DataDog monitors # CLOUD AWS ELASTICACHE COMMON DataDog monitors
========================================
How to use this module ## How to use this module
----------------------
``` ```
module "datadog-monitors-aws-elasticache" { module "datadog-monitors-cloud-aws-elasticache-common" {
source = "../common" source = "git::ssh://git@bitbucket.org/morea/terraform.feature.datadog.git//cloud/aws/elasticache/common?ref={revision}"
message = "${module.datadog-message-alerting.alerting-message}"
environment = "${var.environment}" environment = "${var.environment}"
filter_tags = "${var.filter_tags}" message = "${module.datadog-message-alerting.alerting-message}"
resource = "${var.type_of_resource}"
} }
``` ```
This module is loaded by default when you define `memcached` or `redis` monitors ## Purpose
Purpose
-------
Creates DataDog monitors with the following checks: Creates DataDog monitors with the following checks:
* Eviction - Elasticache ${var.resource} eviction
* Eviction growing - Elasticache ${var.resource} max connections reached
* Swap - Elasticache ${var.resource} connections
* Max connections - Elasticache ${var.resource} swap
* No connection - Elasticache ${var.resource} free memory
* Free Memory - Elasticache ${var.resource} evictions is growing
Related documentation ## Inputs
---------------------
DataDog documentation: [https://docs.datadoghq.com/integrations/amazon_elasticache/](https://docs.datadoghq.com/integrations/amazon_elasticache/)
AWS ElasticSearch Service Instance metrics documentation: [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elasticache-metricscollected.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elasticache-metricscollected.html)
Inputs
------
| Name | Description | Type | Default | Required | | Name | Description | Type | Default | Required |
|------|-------------|:----:|:-----:|:-----:| |------|-------------|:----:|:-----:|:-----:|
@ -76,3 +62,20 @@ Inputs
| swap_threshold_warning | Elasticache swap warning threshold in percentage | string | - | yes | | swap_threshold_warning | Elasticache swap warning threshold in percentage | string | - | yes |
| swap_time_aggregator | Monitor aggregator for Elasticache memcached swap [available values: min, max or avg] | string | - | yes | | swap_time_aggregator | Monitor aggregator for Elasticache memcached swap [available values: min, max or avg] | string | - | yes |
| swap_timeframe | Monitor timeframe for Elasticache swap [available values: `last_#m` (1, 5, 10, 15, or 30), `last_#h` (1, 2, or 4), or `last_1d`] | string | - | yes | | swap_timeframe | Monitor timeframe for Elasticache swap [available values: `last_#m` (1, 5, 10, 15, or 30), `last_#h` (1, 2, or 4), or `last_1d`] | string | - | yes |
## Outputs
| Name | Description |
|------|-------------|
| elasticache_eviction_growing_id | id for monitor elasticache_eviction_growing |
| elasticache_eviction_id | id for monitor elasticache_eviction |
| elasticache_free_memory_id | id for monitor elasticache_free_memory |
| elasticache_max_connection_id | id for monitor elasticache_max_connection |
| elasticache_no_connection_id | id for monitor elasticache_no_connection |
| elasticache_swap_id | id for monitor elasticache_swap |
Related documentation
---------------------
DataDog documentation: [https://docs.datadoghq.com/integrations/amazon_elasticache/](https://docs.datadoghq.com/integrations/amazon_elasticache/)

View File

@ -0,0 +1,29 @@
output "elasticache_eviction_id" {
description = "id for monitor elasticache_eviction"
value = "${datadog_monitor.elasticache_eviction.id}"
}
output "elasticache_max_connection_id" {
description = "id for monitor elasticache_max_connection"
value = "${datadog_monitor.elasticache_max_connection.id}"
}
output "elasticache_no_connection_id" {
description = "id for monitor elasticache_no_connection"
value = "${datadog_monitor.elasticache_no_connection.id}"
}
output "elasticache_swap_id" {
description = "id for monitor elasticache_swap"
value = "${datadog_monitor.elasticache_swap.id}"
}
output "elasticache_free_memory_id" {
description = "id for monitor elasticache_free_memory"
value = "${datadog_monitor.elasticache_free_memory.id}"
}
output "elasticache_eviction_growing_id" {
description = "id for monitor elasticache_eviction_growing"
value = "${datadog_monitor.elasticache_eviction_growing.id}"
}

View File

@ -1,51 +1,25 @@
AWS ElastiCache Memcached Service DataDog monitors # CLOUD AWS ELASTICACHE MEMCACHED DataDog monitors
==================================================
How to use this module ## How to use this module
----------------------
``` ```
module "datadog-monitors-aws-elasticache-redis" { module "datadog-monitors-cloud-aws-elasticache-memcached" {
source = "git::ssh://git@bitbucket.org/morea/terraform.feature.datadog.git//cloud/aws/elasticache/memcached?ref={revision}" source = "git::ssh://git@bitbucket.org/morea/terraform.feature.datadog.git//cloud/aws/elasticache/memcached?ref={revision}"
message = "${module.datadog-message-alerting.alerting-message}"
environment = "${var.environment}" environment = "${var.environment}"
message = "${module.datadog-message-alerting.alerting-message}"
} }
``` ```
Purpose ## Purpose
-------
Creates DataDog monitors with the following checks :
Memcached specific: Creates DataDog monitors with the following checks:
* Get Hit - Elasticache memcached get hits
* CPU High - Elasticache memcached CPU
Elasticache common: ## Inputs
* Eviction
* Eviction growing
* Swap
* Max connections
* No connection
* Free Memory
Related documentation
---------------------
DataDog documentation:
* [https://docs.datadoghq.com/integrations/amazon_elasticache/](https://docs.datadoghq.com/integrations/amazon_elasticache/)
* [https://www.datadoghq.com/blog/monitoring-elasticache-performance-metrics-with-redis-or-memcached/](https://www.datadoghq.com/blog/monitoring-elasticache-performance-metrics-with-redis-or-memcached/)
AWS ElasticSearch Service Instance metrics documentation: [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elasticache-metricscollected.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elasticache-metricscollected.html)
Inputs
------
| Name | Description | Type | Default | Required | | Name | Description | Type | Default | Required |
|------|-------------|:----:|:-----:|:-----:| |------|-------------|:----:|:-----:|:-----:|
@ -95,3 +69,20 @@ Inputs
| swap_threshold_warning | Elasticache swap warning threshold in Bytes | string | `40000000` | no | | swap_threshold_warning | Elasticache swap warning threshold in Bytes | string | `40000000` | no |
| swap_time_aggregator | Monitor aggregator for Elasticache memcached swap [available values: min, max or avg] | string | `min` | no | | swap_time_aggregator | Monitor aggregator for Elasticache memcached swap [available values: min, max or avg] | string | `min` | no |
| swap_timeframe | Monitor timeframe for Elasticache swap [available values: `last_#m` (1, 5, 10, 15, or 30), `last_#h` (1, 2, or 4), or `last_1d`] | string | `last_5m` | no | | swap_timeframe | Monitor timeframe for Elasticache swap [available values: `last_#m` (1, 5, 10, 15, or 30), `last_#h` (1, 2, or 4), or `last_1d`] | string | `last_5m` | no |
## Outputs
| Name | Description |
|------|-------------|
| memcached_cpu_high_id | id for monitor memcached_cpu_high |
| memcached_get_hits_id | id for monitor memcached_get_hits |
Related documentation
---------------------
DataDog documentation:
* [https://docs.datadoghq.com/integrations/amazon_elasticache/](https://docs.datadoghq.com/integrations/amazon_elasticache/)
* [https://www.datadoghq.com/blog/monitoring-elasticache-performance-metrics-with-redis-or-memcached/](https://www.datadoghq.com/blog/monitoring-elasticache-performance-metrics-with-redis-or-memcached/)

View File

@ -0,0 +1,9 @@
output "memcached_get_hits_id" {
description = "id for monitor memcached_get_hits"
value = "${datadog_monitor.memcached_get_hits.id}"
}
output "memcached_cpu_high_id" {
description = "id for monitor memcached_cpu_high"
value = "${datadog_monitor.memcached_cpu_high.id}"
}

View File

@ -1,53 +1,27 @@
AWS ElastiCache Redis Service DataDog monitors # CLOUD AWS ELASTICACHE REDIS DataDog monitors
==============================================
How to use this module ## How to use this module
----------------------
``` ```
module "datadog-monitors-aws-elasticache-redis" { module "datadog-monitors-cloud-aws-elasticache-redis" {
source = "git::ssh://git@bitbucket.org/morea/terraform.feature.datadog.git//cloud/aws/elasticache/redis?ref={revision}" source = "git::ssh://git@bitbucket.org/morea/terraform.feature.datadog.git//cloud/aws/elasticache/redis?ref={revision}"
message = "${module.datadog-message-alerting.alerting-message}"
environment = "${var.environment}" environment = "${var.environment}"
message = "${module.datadog-message-alerting.alerting-message}"
} }
``` ```
## Purpose
Purpose
-------
Creates DataDog monitors with the following checks: Creates DataDog monitors with the following checks:
Redis specific: - Elasticache redis cache hits
- Elasticache redis CPU
- Elasticache redis replication lag
- Elasticache redis is receiving no commands
* Cache hits ## Inputs
* CPU high
* Commands received
* Replication lag
Elasticache common:
* Eviction
* Eviction growing
* Swap
* Max connections
* No connection
* Free Memory
Related documentation
---------------------
DataDog documentation:
* [https://docs.datadoghq.com/integrations/amazon_elasticache/](https://docs.datadoghq.com/integrations/amazon_elasticache/)
* [https://www.datadoghq.com/dashboards/elasticache-dashboard-redis/](https://www.datadoghq.com/dashboards/elasticache-dashboard-redis/)
* [https://www.datadoghq.com/blog/monitoring-elasticache-performance-metrics-with-redis-or-memcached/](https://www.datadoghq.com/blog/monitoring-elasticache-performance-metrics-with-redis-or-memcached/)
AWS ElasticSearch Service Instance metrics documentation: [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elasticache-metricscollected.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elasticache-metricscollected.html)
Inputs
------
| Name | Description | Type | Default | Required | | Name | Description | Type | Default | Required |
|------|-------------|:----:|:-----:|:-----:| |------|-------------|:----:|:-----:|:-----:|
@ -106,3 +80,19 @@ Inputs
| swap_threshold_warning | Elasticache swap warning threshold in Bytes | string | `40000000` | no | | swap_threshold_warning | Elasticache swap warning threshold in Bytes | string | `40000000` | no |
| swap_time_aggregator | Monitor aggregator for Elasticache memcached swap [available values: min, max or avg] | string | `min` | no | | swap_time_aggregator | Monitor aggregator for Elasticache memcached swap [available values: min, max or avg] | string | `min` | no |
| swap_timeframe | Monitor timeframe for Elasticache swap [available values: `last_#m` (1, 5, 10, 15, or 30), `last_#h` (1, 2, or 4), or `last_1d`] | string | `last_5m` | no | | swap_timeframe | Monitor timeframe for Elasticache swap [available values: `last_#m` (1, 5, 10, 15, or 30), `last_#h` (1, 2, or 4), or `last_1d`] | string | `last_5m` | no |
## Outputs
| Name | Description |
|------|-------------|
| redis_cache_hits_id | id for monitor redis_cache_hits |
| redis_commands_id | id for monitor redis_commands |
| redis_cpu_high_id | id for monitor redis_cpu_high |
| redis_replication_lag_id | id for monitor redis_replication_lag |
## Related documentation
* [https://docs.datadoghq.com/integrations/amazon_elasticache/](https://docs.datadoghq.com/integrations/amazon_elasticache/)
* [https://www.datadoghq.com/blog/monitoring-elasticache-performance-metrics-with-redis-or-memcached/](https://www.datadoghq.com/blog/monitoring-elasticache-performance-metrics-with-redis-or-memcached/)

View File

@ -0,0 +1,19 @@
output "redis_cache_hits_id" {
description = "id for monitor redis_cache_hits"
value = "${datadog_monitor.redis_cache_hits.id}"
}
output "redis_cpu_high_id" {
description = "id for monitor redis_cpu_high"
value = "${datadog_monitor.redis_cpu_high.id}"
}
output "redis_replication_lag_id" {
description = "id for monitor redis_replication_lag"
value = "${datadog_monitor.redis_replication_lag.id}"
}
output "redis_commands_id" {
description = "id for monitor redis_commands"
value = "${datadog_monitor.redis_commands.id}"
}