MON-226 Auto readme and outputs for the basic monitors
This commit is contained in:
parent
687b04876d
commit
cd0feccf59
@ -96,6 +96,7 @@ The `//` is very important, it's a terraform specific syntax used to separate gi
|
|||||||
- [cloud-sql](https://bitbucket.org/morea/terraform.feature.datadog/src/master/cloud/gcp/cloud-sql/)
|
- [cloud-sql](https://bitbucket.org/morea/terraform.feature.datadog/src/master/cloud/gcp/cloud-sql/)
|
||||||
- [common](https://bitbucket.org/morea/terraform.feature.datadog/src/master/cloud/gcp/cloud-sql/common/)
|
- [common](https://bitbucket.org/morea/terraform.feature.datadog/src/master/cloud/gcp/cloud-sql/common/)
|
||||||
- [mysql](https://bitbucket.org/morea/terraform.feature.datadog/src/master/cloud/gcp/cloud-sql/mysql/)
|
- [mysql](https://bitbucket.org/morea/terraform.feature.datadog/src/master/cloud/gcp/cloud-sql/mysql/)
|
||||||
|
- [pubsub](https://bitbucket.org/morea/terraform.feature.datadog/src/master/cloud/gcp/pubsub/)
|
||||||
- [common](https://bitbucket.org/morea/terraform.feature.datadog/src/master/common/)
|
- [common](https://bitbucket.org/morea/terraform.feature.datadog/src/master/common/)
|
||||||
- [alerting-message](https://bitbucket.org/morea/terraform.feature.datadog/src/master/common/alerting-message/)
|
- [alerting-message](https://bitbucket.org/morea/terraform.feature.datadog/src/master/common/alerting-message/)
|
||||||
- [filter-tags](https://bitbucket.org/morea/terraform.feature.datadog/src/master/common/filter-tags/)
|
- [filter-tags](https://bitbucket.org/morea/terraform.feature.datadog/src/master/common/filter-tags/)
|
||||||
|
|||||||
@ -1,26 +1,54 @@
|
|||||||
How to use this module
|
# CLOUD GCP PUBSUB DataDog monitors
|
||||||
----------------------
|
|
||||||
|
## How to use this module
|
||||||
|
|
||||||
```
|
```
|
||||||
module "datadog-monitors-gcp-pubsub" {
|
module "datadog-monitors-cloud-gcp-pubsub" {
|
||||||
source = "git::ssh://git@bitbucket.org/morea/terraform.feature.datadog.git//cloud/gcp/pubsub?ref={revision}"
|
source = "git::ssh://git@bitbucket.org/morea/terraform.feature.datadog.git//cloud/gcp/pubsub?ref={revision}"
|
||||||
|
|
||||||
project_id = "${var.gcp_project_id}"
|
|
||||||
environment = "${var.environment}"
|
environment = "${var.environment}"
|
||||||
message = "${module.datadog-message-alerting.alerting-message}"
|
message = "${module.datadog-message-alerting.alerting-message}"
|
||||||
}
|
}
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Purpose
|
## Purpose
|
||||||
-------
|
|
||||||
Creates DataDog monitors with the following checks :
|
|
||||||
|
|
||||||
*
|
Creates DataDog monitors with the following checks:
|
||||||
|
|
||||||
Inputs
|
- GCP pubsub sending messages operations
|
||||||
------
|
- GCP pubsub sending messages with result unavailable
|
||||||
|
|
||||||
|
## Inputs
|
||||||
|
|
||||||
|
| Name | Description | Type | Default | Required |
|
||||||
|
|------|-------------|:----:|:-----:|:-----:|
|
||||||
|
| delay | Delay in seconds for the metric evaluation | string | `900` | no |
|
||||||
|
| environment | Architecture environment | string | - | yes |
|
||||||
|
| filter_tags_custom | Tags used for custom filtering when filter_tags_use_defaults is false | string | `*` | no |
|
||||||
|
| filter_tags_use_defaults | Use default filter tags convention | string | `true` | no |
|
||||||
|
| message | Message sent when a monitor is triggered | string | - | yes |
|
||||||
|
| project_id | ID of the GCP Project | string | - | yes |
|
||||||
|
| sending_operations_count_extra_tags | Extra tags for GCP Pub/Sub Sending Operations Count monitor | list | `<list>` | no |
|
||||||
|
| sending_operations_count_message | Custom message for the GCP Pub/Sub Sending Operations Count monitor | string | `` | no |
|
||||||
|
| sending_operations_count_silenced | Groups to mute for GCP Pub/Sub Sending Operations Count monitor | map | `<map>` | no |
|
||||||
|
| sending_operations_count_threshold_critical | Critical threshold | string | `0` | no |
|
||||||
|
| sending_operations_count_time_aggregator | Timeframe for the GCP Pub/Sub Sending Operations Count monitor | string | `sum` | no |
|
||||||
|
| sending_operations_count_timeframe | Timeframe for the GCP Pub/Sub Sending Operations Count monitor | string | `last_30m` | no |
|
||||||
|
| unavailable_sending_operations_count_extra_tags | Extra tags for GCP Pub/Sub Unavailable Sending Operations Count monitor | list | `<list>` | no |
|
||||||
|
| unavailable_sending_operations_count_message | Custom message for the GCP Pub/Sub Unavailable Sending Operations Count monitor | string | `` | no |
|
||||||
|
| unavailable_sending_operations_count_silenced | Groups to mute for GCP Pub/Sub Unavailable Sending Operations Count monitor | map | `<map>` | no |
|
||||||
|
| unavailable_sending_operations_count_threshold_critical | Critical threshold | string | `4` | no |
|
||||||
|
| unavailable_sending_operations_count_threshold_warning | Warning threshold | string | `2` | no |
|
||||||
|
| unavailable_sending_operations_count_time_aggregator | Timeframe for the GCP Pub/Sub Unavailable Sending Operations Count monitor | string | `sum` | no |
|
||||||
|
| unavailable_sending_operations_count_timeframe | Timeframe for the GCP Pub/Sub Unavailable Sending Operations Count monitor | string | `last_10m` | no |
|
||||||
|
|
||||||
|
## Outputs
|
||||||
|
|
||||||
|
| Name | Description |
|
||||||
|
|------|-------------|
|
||||||
|
| sending_operations_count_id | id for monitor sending_operations_count |
|
||||||
|
| unavailable_sending_operations_count_id | id for monitor unavailable_sending_operations_count |
|
||||||
|
|
||||||
Related documentation
|
Related documentation
|
||||||
------------
|
------------
|
||||||
|
|||||||
9
cloud/gcp/pubsub/outputs.tf
Normal file
9
cloud/gcp/pubsub/outputs.tf
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
output "sending_operations_count_id" {
|
||||||
|
description = "id for monitor sending_operations_count"
|
||||||
|
value = "${datadog_monitor.sending_operations_count.*.id}"
|
||||||
|
}
|
||||||
|
|
||||||
|
output "unavailable_sending_operations_count_id" {
|
||||||
|
description = "id for monitor unavailable_sending_operations_count"
|
||||||
|
value = "${datadog_monitor.unavailable_sending_operations_count.*.id}"
|
||||||
|
}
|
||||||
Loading…
x
Reference in New Issue
Block a user