https://github.com/cloudposse/terraform-datadog-platform

Terraform module to configure and provision Datadog monitors, custom RBAC roles with permissions, Datadog synthetic tests, Datadog child organizations, and other Datadog resources from a YAML configuration, complete with automated tests.
https://github.com/cloudposse/terraform-datadog-platform

datadog monitoring synthetics terraform terraform-modules terratest

Last synced: 3 days ago
JSON representation

Terraform module to configure and provision Datadog monitors, custom RBAC roles with permissions, Datadog synthetic tests, Datadog child organizations, and other Datadog resources from a YAML configuration, complete with automated tests.

• Host: GitHub
• URL: https://github.com/cloudposse/terraform-datadog-platform
• Owner: cloudposse
• License: apache-2.0
• Created: 2017-08-30T14:52:37.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-12-11T03:14:35.000Z (13 days ago)
• Last Synced: 2024-12-11T04:20:45.128Z (13 days ago)
• Topics: datadog, monitoring, synthetics, terraform, terraform-modules, terratest
• Language: HCL
• Homepage: https://cloudposse.com/accelerate
• Size: 1.33 MB
• Stars: 105
• Watchers: 19
• Forks: 55
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        





    




Terraform module to provision Datadog resources.

The module consists of the following submodules:

  - [monitors](modules/monitors) - to provision Datadog [monitors](https://docs.datadoghq.com/api/v1/monitors/)

  - [synthetics](modules/synthetics) - to provision Datadog [synthetics](https://docs.datadoghq.com/synthetics/)

  - [permissions](modules/permissions) - to look up all available Datadog [permissions](https://docs.datadoghq.com/account_management/rbac/permissions/)

  - [roles](modules/roles) - to provision Datadog [roles](https://docs.datadoghq.com/account_management/rbac)

  - [slo](modules/slo) - to provision Datadog [Service Level Objectives](https://docs.datadoghq.com/monitors/service_level_objectives/)

  - [child_organization](modules/child_organization) - to provision Datadog [child organizations](https://docs.datadoghq.com/account_management/multi_organization/)

  - [organization_settings](modules/organization_settings) - to manage Datadog organization's settings

__Notes on Datadog child organizations:__

* Users can be added to the parent-organization and/or multiple child-organizations and switch between them from the user account settings menu

* The parent-organization can view the usage of individual child-organizations, allowing them to track trends in usage

* The Multi-organization account feature is not enabled by default. Contact Datadog support to have it enabled

* Free and Trial organizations cannot enable SAML

* We can only create Datadog child organizations with terraform, but cannot destroy them. When trying to destroy, the following error is thrown:

  ```

    Warning: Cannot delete organization.

    Remove organization by contacting support (https://docs.datadoghq.com/help).

  ```

> [!TIP]

> #### 👽 Use Atmos with Terraform

> Cloud Posse uses [`atmos`](https://atmos.tools) to easily orchestrate multiple environments using Terraform. 


> Works with [Github Actions](https://atmos.tools/integrations/github-actions/), [Atlantis](https://atmos.tools/integrations/atlantis), or [Spacelift](https://atmos.tools/integrations/spacelift).

>

> 

> Watch demo of using Atmos with Terraform

> 


> Example of running atmos to manage infrastructure from our Quick Start tutorial.

> 

## Introduction

Datadog resources (monitors, roles, etc.) are defined as [catalog](catalog) of YAML configuration files.

We maintain a comprehensive [catalog](catalog) of Datadog resources and welcome contributions via pull request!

The [examples/complete](examples/complete) in this module uses the catalog to provision the monitors on Datadog.

The [examples/synthetics](examples/synthetics) shows how to provision synthetic tests on Datadog for monitoring.

Consult the [synthetics README](modules/synthetics) module for more details.

The [examples/rbac](examples/rbac) shows how to use custom RBAC to provision Datadog roles with permissions and assign roles to monitors.

The [examples/slo](examples/slo) shows how to provision Service Level Objectives on Datadog for SLO monitoring.

The [examples/child_organization](examples/child_organization) shows how to provision Datadog child organizations.

The [examples/organization_settings](examples/organization_settings) shows how to provision Datadog organization settings.

## Usage

Provision Datadog monitors from the catalog of YAML definitions:

```hcl

module "monitor_configs" {

  source  = "cloudposse/config/yaml"

  version = "1.0.2"

  map_config_local_base_path = path.module

  map_config_paths           = var.monitor_paths

  context = module.this.context

}

module "datadog_monitors" {

  source = "cloudposse/platform/datadog//modules/monitors"

  # version = "x.x.x"

  datadog_monitors     = module.monitor_configs.map_configs

  alert_tags           = var.alert_tags

  alert_tags_separator = var.alert_tags_separator

  context = module.this.context

}

```

Provision Datadog synthetics:

```hcl

locals {

  synthetics_files = flatten([for p in var.synthetic_paths : fileset(path.module, p)])

  synthetics_list  = [for f in local.synthetics_files : yamldecode(file(f))]

  synthetics_map   = merge(local.synthetics_list...)

}

module "datadog_synthetics" {

  source = "cloudposse/platform/datadog//modules/synthetics"

  # version = "x.x.x"

  datadog_synthetics   = local.synthetics_map

  alert_tags           = var.alert_tags

  alert_tags_separator = var.alert_tags_separator

  context = module.this.context

}

```

Provision Datadog monitors, Datadog roles with defined permissions, and assign roles to monitors:

```hcl

module "monitor_configs" {

  source  = "cloudposse/config/yaml"

  version = "1.0.2"

  map_config_local_base_path = path.module

  map_config_paths           = var.monitor_paths

  context = module.this.context

}

module "role_configs" {

  source  = "cloudposse/config/yaml"

  version = "1.0.2"

  map_config_local_base_path = path.module

  map_config_paths           = var.role_paths

  context = module.this.context

}

locals {

  monitors_write_role_name    = module.datadog_roles.datadog_roles["monitors-write"].name

  monitors_downtime_role_name = module.datadog_roles.datadog_roles["monitors-downtime"].name

  monitors_roles_map = {

    aurora-replica-lag              = [local.monitors_write_role_name, local.monitors_downtime_role_name]

    ec2-failed-status-check         = [local.monitors_write_role_name, local.monitors_downtime_role_name]

    redshift-health-status          = [local.monitors_downtime_role_name]

    k8s-deployment-replica-pod-down = [local.monitors_write_role_name]

  }

}

module "datadog_roles" {

  source = "cloudposse/platform/datadog//modules/roles"

  # version = "x.x.x"

  datadog_roles = module.role_configs.map_configs

  context = module.this.context

}

module "datadog_monitors" {

  source = "cloudposse/platform/datadog//modules/monitors"

  # version = "x.x.x"

  datadog_monitors     = module.monitor_configs.map_configs

  alert_tags           = var.alert_tags

  alert_tags_separator = var.alert_tags_separator

  restricted_roles_map = local.monitors_roles_map

  context = module.this.context

}

```

Provision a Datadog child organization:

```hcl

module "datadog_child_organization" {

  source = "cloudposse/platform/datadog//modules/child_organization"

  # version = "x.x.x"

  organization_name                = "test"

  saml_enabled                     = false  # Note that Free and Trial organizations cannot enable SAML

  saml_autocreate_users_domains    = []

  saml_autocreate_users_enabled    = false

  saml_idp_initiated_login_enabled = true

  saml_strict_mode_enabled         = false

  private_widget_share             = false

  saml_autocreate_access_role      = "ro"

  context = module.this.context

}

```

> [!IMPORTANT]

> In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation

> and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version

> you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic

> approach for updating versions to avoid unexpected changes.

## Examples

Review the [examples](examples) folder to see how to use the Datadog modules.

Also checkout our [terraform-aws-components](https://github.com/cloudposse/terraform-aws-components) repository for more examples of how to use a mixture of modules to enhance monitors, slos, and synthetics with inheritence and templating!

## Makefile Targets

```text

Available targets:

  help                                Help screen

  help/all                            Display help for all targets

  help/short                          This help short screen

  lint                                Lint terraform code

```

## Requirements

| Name | Version |

|------|---------|

|  [terraform](#requirement\_terraform) | >= 1.0.0 |

|  [datadog](#requirement\_datadog) | >= 3.0.0 |

## Providers

| Name | Version |

|------|---------|

|  [datadog](#provider\_datadog) | >= 3.0.0 |

## Modules

| Name | Source | Version |

|------|--------|---------|

|  [this](#module\_this) | cloudposse/label/null | 0.25.0 |

## Resources

| Name | Type |

|------|------|

| [datadog_monitor.default](https://registry.terraform.io/providers/datadog/datadog/latest/docs/resources/monitor) | resource |

## Inputs

| Name | Description | Type | Default | Required |

|------|-------------|------|---------|:--------:|

|  [additional\_tag\_map](#input\_additional\_tag\_map) | Additional 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\_tags](#input\_alert\_tags) | List of alert tags to add to all alert messages, e.g. `["@opsgenie"]` or `["@devops", "@opsgenie"]` | `list(string)` | `null` | no |

|  [alert\_tags\_separator](#input\_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 |

|  [attributes](#input\_attributes) | ID 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 |

|  [context](#input\_context) | Single 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\_monitors](#input\_datadog\_monitors) | Map of Datadog monitor configurations. See catalog for examples | 
map(object({
    name                = string
    type                = string
    message             = string
    escalation_message  = string
    query               = string
    tags                = list(string)
    notify_no_data      = bool
    new_host_delay      = number
    evaluation_delay    = number
    no_data_timeframe   = number
    renotify_interval   = number
    notify_audit        = bool
    timeout_h           = number
    enable_logs_sample  = bool
    include_tags        = bool
    require_full_window = bool
    locked              = bool
    force_delete        = bool
    threshold_windows   = map(any)
    thresholds          = map(any)
  }))
 | n/a | yes |

|  [delimiter](#input\_delimiter) | Delimiter to be used between ID elements.
Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. | `string` | `null` | no |

|  [descriptor\_formats](#input\_descriptor\_formats) | Describe additional descriptors to be output in the `descriptors` output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
`{
   format = string
   labels = list(string)
}`
(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 |

|  [enabled](#input\_enabled) | Set to false to prevent the module from creating any resources | `bool` | `null` | no |

|  [environment](#input\_environment) | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | `string` | `null` | no |

|  [id\_length\_limit](#input\_id\_length\_limit) | Limit `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`. | `number` | `null` | no |

|  [label\_key\_case](#input\_label\_key\_case) | Controls 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`. | `string` | `null` | no |

|  [label\_order](#input\_label\_order) | The 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)` | `null` | no |

|  [label\_value\_case](#input\_label\_value\_case) | Controls 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`. | `string` | `null` | no |

|  [labels\_as\_tags](#input\_labels\_as\_tags) | Set 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 |

|  [name](#input\_name) | ID 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. | `string` | `null` | no |

|  [namespace](#input\_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 |

|  [regex\_replace\_chars](#input\_regex\_replace\_chars) | Terraform 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. | `string` | `null` | no |

|  [restricted\_roles\_map](#input\_restricted\_roles\_map) | Map of monitors names to sets of Datadog roles to restrict access to each monitor | `map(set(string))` | `{}` | no |

|  [stage](#input\_stage) | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | no |

|  [tags](#input\_tags) | Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).
Neither the tag keys nor the tag values will be modified by this module. | `map(string)` | `{}` | no |

|  [tenant](#input\_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 |

|------|-------------|

|  [datadog\_monitor\_ids](#output\_datadog\_monitor\_ids) | IDs of the created Datadog monitors |

|  [datadog\_monitor\_names](#output\_datadog\_monitor\_names) | Names of the created Datadog monitors |

|  [datadog\_monitors](#output\_datadog\_monitors) | Datadog monitor outputs |

## Related Projects

Check out these related projects.

- [terraform-aws-datadog-integration](https://github.com/cloudposse/terraform-aws-datadog-integration) - Terraform module to configure Datadog AWS integration

- [terraform-yaml-config](https://github.com/cloudposse/terraform-yaml-config) - Terraform module to convert local and remote YAML configuration templates into Terraform lists and maps

## References

For additional context, refer to some of these links.

- [Terraform Datadog monitor resources](https://registry.terraform.io/providers/DataDog/datadog/latest/docs/resources/monitor) - Provides a Datadog monitor resource. Used to create and manage Datadog monitors

- [Create a monitor](https://docs.datadoghq.com/api/v1/monitors/#create-a-monitor) - Create datadog monitors

- [Datadog Synthetic Monitoring](https://docs.datadoghq.com/synthetics/) - Official Datadog documentation on Synthetic Monitoring

- [Terraform Datadog role resources](https://registry.terraform.io/providers/DataDog/datadog/latest/docs/resources/role) - Provides a Datadog role resource. Used to create and manage Datadog roles

- [Datadog permissions](https://registry.terraform.io/providers/DataDog/datadog/latest/docs/data-sources/permissions) - Use this data source to retrieve the list of Datadog permissions by name and their corresponding ID, for use in the role resource

- [Role Based Access Control](https://docs.datadoghq.com/account_management/rbac) - Roles categorize users and define what account permissions those users have, such as what data they can read or what account assets they can modify

- [Managing Multiple-Organization Accounts](https://docs.datadoghq.com/account_management/multi_organization) - It is possible to manage multiple child-organizations from one parent-organization account. This is typically used by Managed Service Providers that have customers which should not have access to each others' data

> [!TIP]

> #### Use Terraform Reference Architectures for AWS

>

> Use Cloud Posse's ready-to-go [terraform architecture blueprints](https://cloudposse.com/reference-architecture/) 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.


>

> 

> 📚 Learn More

>

> 


>

> Cloud Posse is the leading [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-datadog-platform&utm_content=commercial_support) 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.

>

> 

>

> #### 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.

>

> 

> 

## ✨ 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](https://github.com/cloudposse/terraform-datadog-platform/issues).

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

 1. Review our [Code of Conduct](https://github.com/cloudposse/terraform-datadog-platform/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md).

 2. **Fork** the repo on GitHub

 3. **Clone** the project to your own machine

 4. **Commit** changes to your own branch

 5. **Push** your work back up to your fork

 6. 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](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-datadog-platform&utm_content=slack) 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](https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-datadog-platform&utm_content=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 

[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-datadog-platform&utm_content=office_hours) 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



Preamble to the Apache License, Version 2.0







Complete license is available in the [`LICENSE`](LICENSE) file.

```text

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.

```

## Trademarks

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

---

Copyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)