Awesome

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

Treat datadog like a separate cloud provider with integrations (datadog-integration) into your accounts.
Use the catalog convention to define a step of alerts. You can use ours or define your own. https://github.com/cloudposse/terraform-datadog-platform/tree/master/catalog/monitors
The monitors catalog for the datadog-monitor component support datadog monitor exports. You can use the status page of a monitor to export it from 'settings'. You can add the export to existing files or make new ones. Because the export is json formatted, it's also yaml compatible. If you prefer, you can convert the export to yaml using your text editor or a cli tool like yq.

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

Name	Version
<a name="requirement_terraform"></a> terraform	>= 1.0.0
<a name="requirement_aws"></a> aws	>= 4.9.0
<a name="requirement_datadog"></a> datadog	>= 3.3.0

Providers

No providers.

Modules

Name	Source	Version
<a name="module_datadog_configuration"></a> datadog_configuration	../datadog-configuration/modules/datadog_keys	n/a
<a name="module_datadog_monitors"></a> datadog_monitors	cloudposse/platform/datadog//modules/monitors	1.4.1
<a name="module_datadog_monitors_merge"></a> datadog_monitors_merge	cloudposse/config/yaml//modules/deepmerge	1.0.2
<a name="module_iam_roles"></a> iam_roles	../account-map/modules/iam-roles	n/a
<a name="module_local_datadog_monitors_yaml_config"></a> local_datadog_monitors_yaml_config	cloudposse/config/yaml	1.0.2
<a name="module_remote_datadog_monitors_yaml_config"></a> remote_datadog_monitors_yaml_config	cloudposse/config/yaml	1.0.2
<a name="module_this"></a> this	cloudposse/label/null	0.25.0

Resources

No resources.

Inputs

Name	Description	Type	Default	Required
<a name="input_additional_tag_map"></a> additional_tag_map	Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.<br/>This is for some rare cases where resources want additional configuration of tags<br/>and therefore take a list of maps with tag key, value, and additional configuration.	`map(string)`	`{}`	no
<a name="input_alert_tags"></a> alert_tags	List of alert tags to add to all alert messages, e.g. `["@opsgenie"]` or `["@devops", "@opsgenie"]`	`list(string)`	`null`	no
<a name="input_alert_tags_separator"></a> alert_tags_separator	Separator 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 message	`string`	`"\n"`	no
<a name="input_attributes"></a> attributes	ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,<br/>in the order they appear in the list. New attributes are appended to the<br/>end of the list. The elements of the list are joined by the `delimiter`<br/>and treated as a single ID element.	`list(string)`	`[]`	no
<a name="input_context"></a> context	Single object for setting entire context at once.<br/>See description of individual variables for details.<br/>Leave string and numeric variables as `null` to use default value.<br/>Individual variable settings (non-null) override settings in context object,<br/>except for attributes, tags, and additional_tag_map, which are merged.	`any`	<pre>{<br/> "additional_tag_map": {},<br/> "attributes": [],<br/> "delimiter": null,<br/> "descriptor_formats": {},<br/> "enabled": true,<br/> "environment": null,<br/> "id_length_limit": null,<br/> "label_key_case": null,<br/> "label_order": [],<br/> "label_value_case": null,<br/> "labels_as_tags": [<br/> "unset"<br/> ],<br/> "name": null,<br/> "namespace": null,<br/> "regex_replace_chars": null,<br/> "stage": null,<br/> "tags": {},<br/> "tenant": null<br/>}</pre>	no
<a name="input_datadog_monitor_context_tags"></a> datadog_monitor_context_tags	List of context tags to add to each monitor	`set(string)`	<pre>[<br/> "namespace",<br/> "tenant",<br/> "environment",<br/> "stage"<br/>]</pre>	no
<a name="input_datadog_monitor_context_tags_enabled"></a> datadog_monitor_context_tags_enabled	Whether to add context tags to each monitor	`bool`	`true`	no
<a name="input_datadog_monitor_globals"></a> datadog_monitor_globals	Global parameters to add to each monitor	`any`	`{}`	no
<a name="input_datadog_monitors_config_parameters"></a> datadog_monitors_config_parameters	Map of parameters to Datadog monitor configurations	`map(any)`	`{}`	no
<a name="input_delimiter"></a> delimiter	Delimiter to be used between ID elements.<br/>Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.	`string`	`null`	no
<a name="input_descriptor_formats"></a> descriptor_formats	Describe additional descriptors to be output in the `descriptors` output map.<br/>Map of maps. Keys are names of descriptors. Values are maps of the form<br/>`{<br/> format = string<br/> labels = list(string)<br/>}`<br/>(Type is `any` so the map values can later be enhanced to provide additional options.)<br/>`format` is a Terraform format string to be passed to the `format()` function.<br/>`labels` is a list of labels, in order, to pass to `format()` function.<br/>Label values will be normalized before being passed to `format()` so they will be<br/>identical to how they appear in `id`.<br/>Default is `{}` (`descriptors` output will be empty).	`any`	`{}`	no
<a name="input_enabled"></a> enabled	Set to false to prevent the module from creating any resources	`bool`	`null`	no
<a name="input_environment"></a> environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	`string`	`null`	no
<a name="input_id_length_limit"></a> id_length_limit	Limit `id` to this many characters (minimum 6).<br/>Set to `0` for unlimited length.<br/>Set to `null` for keep the existing setting, which defaults to `0`.<br/>Does not affect `id_full`.	`number`	`null`	no
<a name="input_label_key_case"></a> label_key_case	Controls the letter case of the `tags` keys (label names) for tags generated by this module.<br/>Does not affect keys of tags passed in via the `tags` input.<br/>Possible values: `lower`, `title`, `upper`.<br/>Default value: `title`.	`string`	`null`	no
<a name="input_label_order"></a> label_order	The order in which the labels (ID elements) appear in the `id`.<br/>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br/>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.	`list(string)`	`null`	no
<a name="input_label_value_case"></a> label_value_case	Controls the letter case of ID elements (labels) as included in `id`,<br/>set as tag values, and output by this module individually.<br/>Does not affect values of tags passed in via the `tags` input.<br/>Possible values: `lower`, `title`, `upper` and `none` (no transformation).<br/>Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs.<br/>Default value: `lower`.	`string`	`null`	no
<a name="input_labels_as_tags"></a> labels_as_tags	Set of labels (ID elements) to include as tags in the `tags` output.<br/>Default is to include all labels.<br/>Tags with empty values will not be included in the `tags` output.<br/>Set to `[]` to suppress all generated tags.<br/>Notes:<br/> The value of the `name` tag, if included, will be the `id`, not the `name`.<br/> Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be<br/> changed in later chained modules. Attempts to change it will be silently ignored.	`set(string)`	<pre>[<br/> "default"<br/>]</pre>	no
<a name="input_local_datadog_monitors_config_paths"></a> local_datadog_monitors_config_paths	List of paths to local Datadog monitor configurations	`list(string)`	`[]`	no
<a name="input_message_postfix"></a> message_postfix	Additional information to put after each monitor message	`string`	`""`	no
<a name="input_message_prefix"></a> message_prefix	Additional information to put before each monitor message	`string`	`""`	no
<a name="input_name"></a> name	ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br/>This is the only ID element not also included as a `tag`.<br/>The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input.	`string`	`null`	no
<a name="input_namespace"></a> namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	`string`	`null`	no
<a name="input_regex_replace_chars"></a> regex_replace_chars	Terraform regular expression (regex) string.<br/>Characters matching the regex will be removed from the ID elements.<br/>If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits.	`string`	`null`	no
<a name="input_region"></a> region	AWS Region	`string`	n/a	yes
<a name="input_remote_datadog_monitors_base_path"></a> remote_datadog_monitors_base_path	Base path to remote Datadog monitor configurations	`string`	`""`	no
<a name="input_remote_datadog_monitors_config_paths"></a> remote_datadog_monitors_config_paths	List of paths to remote Datadog monitor configurations	`list(string)`	`[]`	no
<a name="input_stage"></a> stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
<a name="input_tags"></a> tags	Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).<br/>Neither the tag keys nor the tag values will be modified by this module.	`map(string)`	`{}`	no
<a name="input_tenant"></a> tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	`string`	`null`	no

Outputs

Name	Description
<a name="output_datadog_monitor_names"></a> datadog_monitor_names	Names of the created Datadog monitors

Related How-to Guides

How to Monitor Everything with Datadog

Component Dependencies

datadog-integration

References

cloudposse/terraform-aws-components - Cloud Posse's upstream component

[!TIP]

👽 Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform. Works with Github Actions, Atlantis, or Spacelift.
<details> <summary>Watch demo of using Atmos with Terraform</summary> <img src="https://github.com/cloudposse/atmos/blob/main/docs/demo.gif?raw=true"/> Example of running <a href="https://atmos.tools"><code>atmos</code></a> to manage infrastructure from our <a href="https://atmos.tools/quick-start/">Quick Start</a> tutorial. </detalis>

Related Projects

Check out these related projects.

Cloud Posse Terraform Modules - Our collection of reusable Terraform modules used by our reference architectures.
Atmos - Atmos is like docker-compose but for your infrastructure

[!TIP]

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

✅ We build it together with your team. ✅ Your team owns everything. ✅ 100% Open Source and backed by fanatical support. 

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-datadog-monitor&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
<details><summary>📚 Learn More</summary> 
Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.

Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.

Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.

Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.

GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-datadog-monitor&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

Day-2: Your Operational Mastery

Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.

Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.

Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.

Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.

Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.

Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.

Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-datadog-monitor&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
</details>

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

Review our Code of Conduct and Contributor Guidelines.
Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

📰 Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-datadog-monitor&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

<details> <summary>Preamble to the Apache License, Version 2.0</summary>

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

</details>

Trademarks

All other trademarks referenced herein are the property of their respective owners.