datadog-synthetics

This component provides the ability to implement Datadog synthetic tests.

Synthetic tests allow you to observe how your systems and applications are performing using simulated requests and actions from the AWS managed locations around the globe, and to monitor internal endpoints from Private Locations.

Usage

Stack Level: Regional

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

Stack Configuration

components:
  terraform:
    datadog-synthetics:
      metadata:
        component: "datadog-synthetics"
      settings:
        spacelift:
          workspace_enabled: true
      vars:
        enabled: true
        name: "datadog-synthetics"
        locations:
          - "all"
        # List of paths to Datadog synthetic test configurations
        synthetics_paths:
          - "catalog/synthetics/examples/*.yaml"
        synthetics_private_location_component_name: "datadog-synthetics-private-location"
        private_location_test_enabled: true

Synthetics Configuration Examples

Below are examples of Datadog browser and API synthetic tests.

The synthetic tests are defined in YAML using either the Datadog Terraform provider schema or the Datadog Synthetics API schema. See the terraform-datadog-platform Terraform module README for more details. We recommend using the API schema so you can more create and edit tests using the Datadog web API and then import them into this module by downloading the test using the Datadog REST API. (See the Datadog API documentation for the appropriate curl commands to use.)

# API schema
my-browser-test:
  name: My Browser Test
  status: live
  type: browser
  config:
    request:
      method: GET
      headers: {}
      url: https://example.com/login
    setCookie: |-
      DatadogTest=true
  message: "My Browser Test Failed"
  options:
    device_ids:
      - chrome.laptop_large
      - edge.tablet
      - firefox.mobile_small
    ignoreServerCertificateError: false
    disableCors: false
    disableCsp: false
    noScreenshot: false
    tick_every: 86400
    min_failure_duration: 0
    min_location_failed: 1
    retry:
      count: 0
      interval: 300
    monitor_options:
      renotify_interval: 0
    ci:
      executionRule: non_blocking
    rumSettings:
      isEnabled: false
    enableProfiling: false
    enableSecurityTesting: false
  locations:
    - aws:us-east-1
    - aws:us-west-2

# Terraform schema
my-api-test:
  name: "API Test"
  message: "API Test Failed"
  type: api
  subtype: http
  tags:
    - "managed-by:Terraform"
  status: "live"
  request_definition:
    url: "CHANGEME"
    method: GET
  request_headers:
    Accept-Charset: "utf-8, iso-8859-1;q=0.5"
    Accept: "text/json"
  options_list:
    tick_every: 1800
    no_screenshot: false
    follow_redirects: true
    retry:
      count: 2
      interval: 10
    monitor_options:
      renotify_interval: 300
  assertion:
    - type: statusCode
      operator: is
      target: "200"
    - type: body
      operator: validatesJSONPath
      targetjsonpath:
        operator: is
        targetvalue: true
        jsonpath: foo.bar

These configuration examples are defined in the YAML files in the catalog/synthetics/examples folder.

You can use different subfolders for your use-case. For example, you can have dev and prod subfolders to define different synthetic tests for the dev and prod environments.

Then use the synthetic_paths variable to point the component to the synthetic test configuration files.

The configuration files are processed and transformed in the following order:

The datadog-synthetics component loads the YAML configuration files from the filesystem paths specified by the synthetics_paths variable
Then, in the synthetics module, the YAML configuration files are merged and transformed from YAML into the Datadog Terraform provider schema
And finally, the Datadog Terraform provider uses the Datadog Synthetics API specifications to call the Datadog API and provision the synthetic tests

Variables

Required Variables

region (string) required: AWS Region
synthetics_paths (list(string)) required: List of paths to Datadog synthetic test configurations

Optional Variables

alert_tags (list(string)) optional

List of alert tags to add to all alert messages, e.g. ["@opsgenie"] or ["@devops", "@opsgenie"]

Default value: null

alert_tags_separator (string) optional

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

Default value: "\n"

config_parameters (map(any)) optional

Map of parameter values to interpolate into Datadog Synthetic configurations

Default value: { }

context_tags (set(string)) optional

List of context tags to add to each synthetic check

Default value:

[
  "namespace",
  "tenant",
  "environment",
  "stage"
]

context_tags_enabled (bool) optional

Whether to add context tags to add to each synthetic check

Default value: true

datadog_synthetics_globals (any) optional

Map of keys to add to every monitor

Default value: { }

locations (list(string)) optional

Array of locations used to run synthetic tests

Default value: [ ]

private_location_test_enabled (bool) optional

Use private locations or the public locations provided by datadog

Default value: false

synthetics_private_location_component_name (string) optional

The name of the Datadog synthetics private location component

Default value: null

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

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.

Required: No

Default value: { }

attributes (list(string)) optional

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.

Required: No

Default value: [ ]

context (any) optional

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.

Required: No

Default value:

{
  "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
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

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
\{<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).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

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.

Required: No

Default value: null

label_key_case (string) optional

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.

Required: No

Default value: null

label_order (list(string)) optional

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.

Required: No

Default value: null

label_value_case (string) optional

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.

Required: No

Default value: null

labels_as_tags (set(string)) optional

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.

Required: No

Default value:

[
  "default"
]

name (string) optional

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.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

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.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

datadog_synthetics_test_ids: IDs of the created Datadog synthetic tests
datadog_synthetics_test_maps: Map (name: id) of the created Datadog synthetic tests
datadog_synthetics_test_monitor_ids: IDs of the monitors associated with the Datadog synthetics tests
datadog_synthetics_test_names: Names of the created Datadog synthetic tests

Dependencies

Requirements

terraform, version: >= 1.0.0
aws, version: >= 4.9.0
datadog, version: >= 3.3.0

Modules

Name	Version	Source	Description
`datadog_configuration`	latest	`../datadog-configuration/modules/datadog_keys`	n/a
`datadog_synthetics`	1.3.0	`cloudposse/platform/datadog//modules/synthetics`	n/a
`datadog_synthetics_merge`	1.0.2	`cloudposse/config/yaml//modules/deepmerge`	n/a
`datadog_synthetics_private_location`	1.5.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`datadog_synthetics_yaml_config`	1.0.2	`cloudposse/config/yaml`	Convert all Datadog synthetics from YAML config to Terraform map
`iam_roles`	latest	`../account-map/modules/iam-roles`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a

References

Changelog

Changes approximately v1.329.0

API Schema accepted

Test can now be defined using the Datadog API schema, meaning that the test definition returned by

https://api.datadoghq.com/api/v1/synthetics/tests/api/{public_id}
https://api.datadoghq.com/api/v1/synthetics/tests/browser/{public_id}

can be directly used a map value (you still need to supply a key, though).

You can mix tests using the API schema with tests using the old Terraform schema. You could probably get away with mixing them in the same test, but it is not recommended.

Default locations

Previously, the default locations for Synthetics tests were "all" public locations. Now the default is no locations, in favor of locations being specified in each test configuration, which is more flexible. Also, since the tests are expensive, it is better to err on the side of too few test locations than too many.

Usage​

Stack Configuration​

Synthetics Configuration Examples​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Modules​

References​

Changelog​

Changes approximately v1.329.0​

API Schema accepted​

Default locations​

Usage

Stack Configuration

Synthetics Configuration Examples

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Modules

References

Changelog

Changes approximately v1.329.0

API Schema accepted

Default locations