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.
Stack Level: Regional
Here's an example snippet for how to use this component:
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: trueBelow 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.barThese 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-syntheticscomponent loads the YAML configuration files from the filesystem paths specified by thesynthetics_pathsvariable -
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
| Name | Version |
|---|---|
| terraform | >= 1.0.0 |
| aws | >= 4.9.0 |
| datadog | >= 3.3.0 |
No providers.
| Name | Source | Version |
|---|---|---|
| datadog_configuration | ../datadog-configuration/modules/datadog_keys | n/a |
| datadog_synthetics | cloudposse/platform/datadog//modules/synthetics | 1.3.0 |
| datadog_synthetics_merge | cloudposse/config/yaml//modules/deepmerge | 1.0.2 |
| datadog_synthetics_private_location | cloudposse/stack-config/yaml//modules/remote-state | 1.5.0 |
| datadog_synthetics_yaml_config | cloudposse/config/yaml | 1.0.2 |
| iam_roles | ../account-map/modules/iam-roles | n/a |
| this | cloudposse/label/null | 0.25.0 |
No resources.
| 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) |
null |
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 delimiterand treated as a single ID element. |
list(string) |
[] |
no |
| config_parameters | Map of parameter values to interpolate into Datadog Synthetic configurations | map(any) |
{} |
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 |
{ |
no |
| context_tags | List of context tags to add to each synthetic check | set(string) |
[ |
no |
| context_tags_enabled | Whether to add context tags to add to each synthetic check | bool |
true |
no |
| datadog_synthetics_globals | Map of keys to add to every monitor | any |
{} |
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 beidentical 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 bechanged in later chained modules. Attempts to change it will be silently ignored. |
set(string) |
[ |
no |
| locations | Array of locations used to run synthetic tests | list(string) |
[] |
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 |
| private_location_test_enabled | Use private locations or the public locations provided by datadog | bool |
false |
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 |
| region | AWS Region | string |
n/a | yes |
| stage | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | string |
null |
no |
| synthetics_paths | List of paths to Datadog synthetic test configurations | list(string) |
n/a | yes |
| synthetics_private_location_component_name | The name of the Datadog synthetics private location component | 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 |
| Name | Description |
|---|---|
| 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 |
- Datadog Synthetics
- Getting Started with Synthetic Monitoring
- Synthetic Monitoring Guides
- Using Synthetic Test Monitors
- Create An API Test With The API
- Manage Your Browser Tests Programmatically
- Browser Tests
- Synthetics API
- Terraform resource
datadog_synthetics_test
Note
This project is part of Cloud Posse's comprehensive "SweetOps" approach towards DevOps.
Learn More
It's 100% Open Source and licensed under the APACHE2.
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
This project is under active development, and we encourage contributions from our community. Many thanks to our outstanding contributors:
Please use the issue tracker to report any bugs or file feature requests.
If you are interested in being a contributor and want to get involved in developing this project or help out with Cloud Posse's other projects, we would love to hear from you!
Hit us up in Slack, in the #cloudposse channel.
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!
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.
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.
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!
This project is maintained by Cloud Posse, LLC.
We are a DevOps Accelerator for funded startups and enterprises. Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly. We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.
Your team can operate like a pro today.
Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.
📚 See What's Included
- Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
- Deployment Strategy. You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
- Site Reliability Engineering. You'll have total visibility into your apps and microservices.
- Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
- GitOps. You'll be able to operate your infrastructure via Pull Requests.
- Training. You'll receive hands-on training so your team can operate what we build.
- Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
- Troubleshooting. You'll get help to triage when things aren't working.
- Code Reviews. You'll receive constructive feedback on Pull Requests.
- Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.
Preamble to the Apache License, Version 2.0
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.
Copyright © 2017-2024 Cloud Posse, LLC