Merged in MON-82_add_readme_for_alerting_message (pull request #76)
MON-82 Add readme for alerting message module Approved-by: Quentin Manfroi <quentin.manfroi@yahoo.fr> Approved-by: Alexandre Gaillet <alexandre.gaillet@fr.clara.net> Approved-by: Boris Rousseau <boris.rousseau@morea.fr>
This commit is contained in:
commit
dcb275cab2
42
common/alerting-message/README.md
Normal file
42
common/alerting-message/README.md
Normal file
@ -0,0 +1,42 @@
|
||||
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}"
|
||||
|
||||
message_alert = "${var.oncall_24x7}"
|
||||
message_warning = "${var.oncall_business_hours}"
|
||||
message_nodata = "${var.oncall_nodata}"
|
||||
}
|
||||
```
|
||||
|
||||
Purpose
|
||||
-------
|
||||
|
||||
Creates a DataDog monitor alert message with the following inputs :
|
||||
|
||||
* A broadcast channel for critical alerts
|
||||
* A broadcast channel for nodata alerts
|
||||
* A broadcast channel for warning alerts
|
||||
* Prepend text free string
|
||||
* Append text free string
|
||||
|
||||
Inputs
|
||||
------
|
||||
|
||||
| Name | Description | Type | Default | Required |
|
||||
|------|-------------|:----:|:-----:|:-----:|
|
||||
| append_text | Optional free text string to append to alert | string | `` | no |
|
||||
| message_alert | Define a broadcast channel for critical alerts | string | - | yes |
|
||||
| message_nodata | Define a broadcast channel for nodata alerts | string | `` | no |
|
||||
| message_warning | Define a broadcast channel 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)
|
||||
@ -1,17 +1,27 @@
|
||||
variable "oncall_24x7" {
|
||||
type = "string"
|
||||
variable "message_alert" {
|
||||
description = "Define a broadcast channel for critical alerts"
|
||||
type = "string"
|
||||
}
|
||||
|
||||
variable "oncall_office_hours" {
|
||||
type = "string"
|
||||
variable "message_warning" {
|
||||
description = "Define a broadcast channel for warning alerts"
|
||||
type = "string"
|
||||
}
|
||||
|
||||
variable "message_nodata" {
|
||||
description = "Define a broadcast channel for nodata alerts"
|
||||
type = "string"
|
||||
default = ""
|
||||
}
|
||||
|
||||
variable "prepend_text" {
|
||||
type = "string"
|
||||
default = ""
|
||||
description = "Optional free text string to prepend to alert"
|
||||
type = "string"
|
||||
default = ""
|
||||
}
|
||||
|
||||
variable "append_text" {
|
||||
type = "string"
|
||||
default = ""
|
||||
description = "Optional free text string to append to alert"
|
||||
type = "string"
|
||||
default = ""
|
||||
}
|
||||
|
||||
@ -1,18 +1,20 @@
|
||||
data "template_file" "alerting-message" {
|
||||
template = <<EOF
|
||||
$${prepend_text}
|
||||
{{#is_alert}}$${oncall_24x7}{{/is_alert}}
|
||||
{{#is_recovery}}$${oncall_24x7}{{/is_recovery}}
|
||||
{{#is_warning}}$${oncall_office_hours}{{/is_warning}}
|
||||
{{#is_warning_recovery}}$${oncall_office_hours}{{/is_warning_recovery}}
|
||||
{{#is_no_data}}$${oncall_24x7}{{/is_no_data}}
|
||||
{{#is_alert}}$${message_alert}{{/is_alert}}
|
||||
{{#is_recovery}}$${message_alert}{{/is_recovery}}
|
||||
{{#is_warning}}$${message_warning}{{/is_warning}}
|
||||
{{#is_warning_recovery}}$${message_warning}{{/is_warning_recovery}}
|
||||
{{#is_no_data}}$${message_nodata}{{/is_no_data}}
|
||||
{{#is_no_data_recovery}}$${message_nodata}{{/is_no_data_recovery}}
|
||||
$${append_text}
|
||||
EOF
|
||||
|
||||
vars {
|
||||
oncall_24x7 = "${var.oncall_24x7}"
|
||||
oncall_office_hours = "${var.oncall_office_hours}"
|
||||
prepend_text = "${var.prepend_text}"
|
||||
append_text = "${var.append_text}"
|
||||
message_alert = "${var.message_alert}"
|
||||
message_warning = "${var.message_warning}"
|
||||
message_nodata = "${coalesce(var.message_nodata,var.message_alert)}"
|
||||
prepend_text = "${var.prepend_text}"
|
||||
append_text = "${var.append_text}"
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user