synthetics

Datadig synthetics

This module creates Datadog synthetic tests. It accepts all the configuration parameters supported by the Datadog Terraform resource except BasicAuth authentication wherever it occurs.

Usage

The datadog_synthetics input takes a map of test definitions. You must supply the keys for the map, but the values can follow either of two schemas described below.

API Schema

Datadog provides a REST API for managing synthetic tests. We refer to the responses to the API requests for test definitions as the "API Schema" for the tests. (Note that some items in the response are read-only, and are ignored if included in the definition of a test.) There are errors and omissions in the documentation of the API output, and where we have found API results that differ from the documentation, we have used the API results as the source of truth.

You can retrieve test definitions from the Datadog API in 3 ways:

1. You can retrieve an individual API test
2. You can retrieve an individual browser test
3. You can retrieve a list of all tests

NOTE: As of this writing (2023-10-20), the list of all tests fails to include the steps in a multistep browser test. You must use the individual browser test API to retrieve the test definition including the steps. This is a known issue with Datadog, and hopefully will be fixed soon, but verify that it is fixed before relying on the list of all tests if you are using multistep browser tests.

The datadog_synthetics input takes a map of test definitions. You must supply the keys for the map, but the values can simply be the output of applying Terraform's jsondecode() to the output of the API. In the case of the list of all tests, you must iterate over the list and supply a key for each test. We recommend that you use the test's name as the key.

For any test, you can optionally add enabled = false to disable/delete the test.

NOTE: Since this module is implemented in Terraform, any field in the API schema that does not have a counterpart in the Terraform schema will be ignored. As of this writing (Datadog Terraform provider version 3.30.0), that includes the metatdata field in the steps of a multistep API test.

See https://github.com/DataDog/terraform-provider-datadog/issues/2155

Terraform schema

Historically, and preserved for backward compatibility, you can configure tests using the datadog_synthetics input, which takes an object that is a map of synthetic tests, each test matching the schema of the datadog_sythetics_test Terraform resource. See examples with suffix -terraform.yaml in examples/synthetics/terraform-schema/catalog.

One distinction of this schema is that there is no config member. Instead, elements of config, such as assertions, are pulled up to the top level and rendered in the singular, e.g. assertion. Another change is that options is renamed options_list. When in doubt, refer to the Terraform code to see how the input is mapped to the Terraform resource.

Note that the Terraform resource does not support the details of the element field for the steps of a multistep browser test. This module allows you to use an object following the API schema, or you can use a string that is the JSON encoding of the object. However, if you use the JSON string encoding, and you are using a "user locator", you must supply the element_user_locator attribute even though it is already included in the JSON encoding, or else the Terraform provider will show perpetual drift.

As with the API schema, you can optionally add enabled = false to disable/delete the test.

Unsupported inputs

Any of the "BasicAuth" inputs are not supported due to their complexity and rare usage. Usually you can use the headers input instead. BasicAuth support could be added if there is a need.

Locations

The locations input takes a list of locations used to run the test. It defaults to the special value "all" which is used to indicate all public locations. Any locations included in the locations list will be added to the list of locations specified in the individual test; they will not replace the list of locations specified in the test.

Requirements

Name	Version
terraform	>= 1.0.0
datadog	>= 3.43.1

Providers

Name	Version
datadog	>= 3.43.1

Modules

Name	Source	Version
this	cloudposse/label/null	0.25.0

Resources

Name	Type
datadog_synthetics_test.default	resource
datadog_synthetics_locations.public_locations	data source

Inputs

Name	Description	Type	Default	Required
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	List of alert tags to add to all alert messages, e.g. ["@opsgenie"] or ["@devops", "@opsgenie"]	list(string)	[]	no
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	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	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_synthetics	Map of Datadog synthetic test configurations using Terraform or API schema. See README for details.	any	n/a	yes
default_tags_enabled	If true, all tests will have tags from null-label added to them	bool	true	no
delimiter	Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all.	string	null	no
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 {<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
enabled	Set to false to prevent the module from creating any resources	bool	null	no
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	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	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	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	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	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
locations	Array of locations used to run synthetic tests, or "all" to use all public locations. These locations will be added to any locations specified in the locations attribute of a test.	list(string)	[ "all" ]	no
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	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	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
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
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	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_synthetic_tests	The synthetic tests created in DataDog
datadog_synthetics_test_ids	IDs 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