MON-82 Add readme for alerting message module

This commit is contained in:
Quentin Manfroi 2018-03-24 17:12:22 +01:00
parent e50ef46639
commit ac1d515598
2 changed files with 49 additions and 6 deletions

View File

@ -0,0 +1,39 @@
Alerting Message Datadog Generator
==================================
How to use this module
----------------------
```
module "datadog-message-alerting" {
source = "git::ssh://git@bitbucket.org/morea/terraform.feature.datadog.git//common/alerting-message?ref={revision}"
oncall_24x7 = "${var.oncall_24x7}"
oncall_office_hours = "${var.oncall_office_hours}"
}
```
Purpose
-------
Creates a DataDog monitor alert message with the following inputs :
* PagerDuty NBH service name
* PagerDuty BH service name
* Prepend test free string
* Append text free string
Inputs
------
| Name | Description | Type | Default | Required |
|------|-------------|:----:|:-----:|:-----:|
| append_text | Optional free text string to append to alert | string | `` | no |
| oncall_24x7 | Define PagerDuty NBH service name for alerts and nodata | string | - | yes |
| oncall_office_hours | Define PagerDuty BH service name for warning alerts | string | - | yes |
| prepend_text | Optional free text string to prepend to alert | string | `` | no |
Related documentation
---------------------
DataDog documentation: [https://docs.datadoghq.com/integrations/azure_app_services](https://docs.datadoghq.com/integrations/azure_app_services)

View File

@ -1,17 +1,21 @@
variable "oncall_24x7" { variable "oncall_24x7" {
type = "string" description = "Define PagerDuty NBH service name for alerts and nodata"
type = "string"
} }
variable "oncall_office_hours" { variable "oncall_office_hours" {
type = "string" description = "Define PagerDuty BH service name for warning alerts"
type = "string"
} }
variable "prepend_text" { variable "prepend_text" {
type = "string" description = "Optional free text string to prepend to alert"
default = "" type = "string"
default = ""
} }
variable "append_text" { variable "append_text" {
type = "string" description = "Optional free text string to append to alert"
default = "" type = "string"
default = ""
} }