Skip to main content

Component: datadog-monitor

This component is responsible for provisioning Datadog monitors and assigning Datadog roles to the monitors.

It depends on the datadog-configuration component to get the Datadog API keys.

Usage

Stack Level: Regional

Here's an example snippet for how to use this component:

components:
terraform:
datadog-monitor:
settings:
spacelift:
workspace_enabled: true
vars:
enabled: true
local_datadog_monitors_config_paths:
- "catalog/monitors/dev/*.yaml"

Conventions

Adjust Thresholds per Stack

Since there are so many parameters that may be adjusted for a given monitor, we define all monitors through YAML. By convention, we define the default monitors that should apply to all environments, and then adjust the thresholds per environment. This is accomplished using the datadog-monitor components variable local_datadog_monitors_config_paths which defines the path to the YAML configuration files. By passing a path for dev and prod, we can define configurations that are different per environment.

For example, you might have the following settings defined for prod and dev stacks that override the defaults.

For the dev stack:

components:
terraform:
datadog-monitor:
vars:
# Located in the components/terraform/datadog-monitor directory
local_datadog_monitors_config_paths:
- catalog/monitors/*.yaml
- catalog/monitors/dev/*.yaml # note this line

For prod stack:

components:
terraform:
datadog-monitor:
vars:
# Located in the components/terraform/datadog-monitor directory
local_datadog_monitors_config_paths:
- catalog/monitors/*.yaml
- catalog/monitors/prod/*.yaml # note this line

Behind the scenes (with atmos) we fetch all files from these glob patterns, template them, and merge them by key. If we peek into the *.yaml and dev/*.yaml files above you could see an example like this:

components/terraform/datadog-monitor/catalog/monitors/elb.yaml

elb-lb-httpcode-5xx-notify:
name: "(ELB) {{ env }} HTTP 5XX client error detected"
type: query alert
query: |
avg(last_15m):max:aws.elb.httpcode_elb_5xx{${context_dd_tags}} by {env,host} > 20
message: |
[${ dd_env }] [ {{ env }} ] lb:[ {{host}} ]
{{#is_warning}}
Number of HTTP 5XX client error codes generated by the load balancer > {{warn_threshold}}%
{{/is_warning}}
{{#is_alert}}
Number of HTTP 5XX client error codes generated by the load balancer > {{threshold}}%
{{/is_alert}}
Check LB
escalation_message: ""
tags: {}
options:
renotify_interval: 60
notify_audit: false
require_full_window: true
include_tags: true
timeout_h: 0
evaluation_delay: 60
new_host_delay: 300
new_group_delay: 0
groupby_simple_monitor: false
renotify_occurrences: 0
renotify_statuses: []
validate: true
notify_no_data: false
no_data_timeframe: 5
priority: 3
threshold_windows: {}
thresholds:
critical: 50
warning: 20
priority: 3
restricted_roles: null

components/terraform/datadog-monitor/catalog/monitors/dev/elb.yaml

elb-lb-httpcode-5xx-notify:
query: |
avg(last_15m):max:aws.elb.httpcode_elb_5xx{${context_dd_tags}} by {env,host} > 30
priority: 2
options:
thresholds:
critical: 30
warning: 10

Key Notes

Inheritance

The important thing to note here is that the default yaml is applied to every stage that it's deployed to. For dev specifically however, we want to override the thresholds and priority for this monitor. This merging is done by key of the monitor, in this case elb-lb-httpcode-5xx-notify.

Templating

The second thing to note is ${ dd_env }. This is terraform templating in action. While double braces ({{ env }}) refers to datadog templating, ${ dd_env } is a template variable we pass into our monitors. in this example we use it to specify a grouping int he message. This value is passed in and can be overridden via stacks.

We pass a value via:

components:
terraform:
datadog-monitor:
vars:
# Located in the components/terraform/datadog-monitor directory
local_datadog_monitors_config_paths:
- catalog/monitors/*.yaml
- catalog/monitors/dev/*.yaml
# templatefile() is used for all yaml config paths with these variables.
datadog_monitors_config_parameters:
dd_env: "dev"

This allows us to further use inheritance from stack configuration to keep our monitors dry, but configurable.

Another available option is to use our catalog as base monitors and then override them with your specific fine tuning.

components:
terraform:
datadog-monitor:
vars:
local_datadog_monitors_config_paths:
- https://raw.githubusercontent.com/cloudposse/terraform-datadog-platform/0.27.0/catalog/monitors/ec2.yaml
- catalog/monitors/ec2.yaml

Other Gotchas

Our integration action that checks for 'source_type_name' equals 'Monitor Alert' will also be true for synthetics. Whereas if we check for 'event_type' equals 'query_alert_monitor', that's only true for monitors, because synthetics will only be picked up by an integration action when event_type is synthetics_alert.

This is important if we need to distinguish between monitors and synthetics in OpsGenie, which is the case when we want to ensure clean messaging on OpsGenie incidents in Statuspage.

Requirements

NameVersion
terraform>= 1.0.0
aws>= 4.9.0
datadog>= 3.3.0

Providers

No providers.

Modules

NameSourceVersion
datadog_configuration../datadog-configuration/modules/datadog_keysn/a
datadog_monitorscloudposse/platform/datadog//modules/monitors1.4.1
datadog_monitors_mergecloudposse/config/yaml//modules/deepmerge1.0.2
iam_roles../account-map/modules/iam-rolesn/a
local_datadog_monitors_yaml_configcloudposse/config/yaml1.0.2
remote_datadog_monitors_yaml_configcloudposse/config/yaml1.0.2
thiscloudposse/label/null0.25.0

Resources

No resources.

Inputs

NameDescriptionTypeDefaultRequired
additional_tag_mapAdditional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.
map(string){}no
alert_tagsList of alert tags to add to all alert messages, e.g. ["@opsgenie"] or ["@devops", "@opsgenie"]list(string)nullno
alert_tags_separatorSeparator for the alert tags. All strings from the alert_tags variable will be joined into one string using the separator and then added to the alert messagestring"\n"no
attributesID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.
list(string)[]no
contextSingle object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.
any
{
"additional_tag_map": {},
"attributes": [],
"delimiter": null,
"descriptor_formats": {},
"enabled": true,
"environment": null,
"id_length_limit": null,
"label_key_case": null,
"label_order": [],
"label_value_case": null,
"labels_as_tags": [
"unset"
],
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
}
no
datadog_monitor_context_tagsList of context tags to add to each monitorset(string)
[
"namespace",
"tenant",
"environment",
"stage"
]
no
datadog_monitor_context_tags_enabledWhether to add context tags to each monitorbooltrueno
datadog_monitor_globalsGlobal parameters to add to each monitorany{}no
datadog_monitors_config_parametersMap of parameters to Datadog monitor configurationsmap(any){}no
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
stringnullno
descriptor_formatsDescribe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
{<br/> format = string<br/> labels = list(string)<br/>}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).
any{}no
enabledSet to false to prevent the module from creating any resourcesboolnullno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
id_length_limitLimit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.
numbernullno
label_key_caseControls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.
stringnullno
label_orderThe order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.
list(string)nullno
label_value_caseControls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.
stringnullno
labels_as_tagsSet of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.
set(string)
[
"default"
]
no
local_datadog_monitors_config_pathsList of paths to local Datadog monitor configurationslist(string)[]no
message_postfixAdditional information to put after each monitor messagestring""no
message_prefixAdditional information to put before each monitor messagestring""no
nameID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.
stringnullno
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
regex_replace_charsTerraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.
stringnullno
regionAWS Regionstringn/ayes
remote_datadog_monitors_base_pathBase path to remote Datadog monitor configurationsstring""no
remote_datadog_monitors_config_pathsList of paths to remote Datadog monitor configurationslist(string)[]no
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
map(string){}no
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno

Outputs

NameDescription
datadog_monitor_namesNames of the created Datadog monitors

Component Dependencies

References

CHANGELOG

PR #814

Removed Dead Code, Possible Breaking Change

The following inputs were removed because they no longer have any effect:

  • datadog_api_secret_key
  • datadog_app_secret_key
  • datadog_secrets_source_store_account
  • monitors_roles_map
  • role_paths
  • secrets_store_type

Except for monitors_roles_map and role_paths, these inputs were deprecated in an earlier PR, and replaced with outputs from datadog-configuration.

The implementation of monitors_roles_map and role_paths has been lost.