Skip to main content

Component: datadog-synthetics-private-location

This component provisions a Datadog synthetics private location on Datadog and a private location agent on EKS cluster.

Private locations allow you to monitor internal-facing applications or any private URLs that are not accessible from the public internet.


Stack Level: Regional

Use this in the catalog or use these variables to overwrite the catalog values.

workspace_enabled: true
enabled: true
name: "datadog-synthetics-private-location"
description: "Datadog Synthetics Private Location Agent"
kubernetes_namespace: "monitoring"
create_namespace: true
repository: ""
chart: "synthetics-private-location"
chart_version: "0.15.15"
timeout: 180
wait: true
atomic: true
cleanup_on_fail: true

Synthetics Private Location Config

docker run --rm datadog/synthetics-private-location-worker --help
The Datadog Synthetics Private Location Worker runs tests on privately accessible websites and brings results to Datadog

Access keys:
--accessKey Access Key for Datadog API authentication [string]
--secretAccessKey Secret Access Key for Datadog API authentication [string]
--datadogApiKey Datadog API key to send browser tests artifacts (e.g. screenshots) [string]
--privateKey Private Key used to decrypt test configurations [array]
--publicKey Public Key used by Datadog to encrypt test results. Composed of --publicKey.pem and --publicKey.fingerprint

Worker configuration:
--site Datadog site (,, or [string] [required] [default: ""]
--concurrency Maximum number of tests executed in parallel [number] [default: 10]
--maxNumberMessagesToFetch Maximum number of tests that can be fetched at the same time [number] [default: 10]
--proxyDatadog Proxy URL used to send requests to Datadog [string] [default: none]
--dumpConfig Display non-secret worker configuration parameters [boolean]
--enableStatusProbes Enable the probes system for Kubernetes [boolean] [default: false]
--statusProbesPort The port for the probes server to listen on [number] [default: 8080]
--config Path to JSON config file [default: "/etc/datadog/synthetics-check-runner.json"]

Tests configuration:
--maxTimeout Maximum test execution duration, in milliseconds [number] [default: 60000]
--proxyTestRequests Proxy URL used to send test requests [string] [default: none]
--proxyIgnoreSSLErrors Discard SSL errors when using a proxy [boolean] [default: false]
--dnsUseHost Use local DNS config for API tests and HTTP steps in browser tests (currently [""]) [boolean] [default: true]
--dnsServer DNS server IPs used in given order for API tests and HTTP steps in browser tests (--dnsServer="" --dnsServer="") and after local DNS config, if --dnsUseHost is present [array] [default: ["",""]]

Network filtering:
--allowedIPRanges Grant access to IP ranges (has precedence over --blockedIPRanges) [default: none]
--blockedIPRanges Deny access to IP ranges (e.g. --blockedIPRanges.4="" --blockedIPRanges.6="::1/128") [default: none]
--enableDefaultBlockedIpRanges Deny access to all reserved IP ranges, except for those explicitly set in --allowedIPRanges [boolean] [default: false]
--allowedDomainNames Grant access to domain names for API tests (has precedence over --blockedDomainNames, e.g. --allowedDomainNames="*") [array] [default: none]
--blockedDomainNames Deny access to domain names for API tests (e.g. --blockedDomainNames="" --blockedDomainNames="*.com") [array] [default: none]

--enableIPv6 Use IPv6 to perform tests. (Warning: IPv6 in Docker is only supported with Linux host) [boolean] [default: false]
--version Show version number [boolean]
-f, --logFormat Format log output [choices: "pretty", "pretty-compact", "json"] [default: "pretty"]
-h, --help Show help [boolean]

/etc/datadog/certs/ .pem certificates present in this directory will be imported and trusted as certificate authorities for API and browser tests

Environment variables:
Command options can also be set via environment variables (DATADOG_API_KEY="...", DATADOG_WORKER_CONCURRENCY="15", DATADOG_DNS_USE_HOST="true")
For options that accept multiple arguments, JSON string array notation should be used (DATADOG_TESTS_DNS_SERVER='["", ""]')

Supported environment variables:



terraform>= 1.0.0
aws>= 4.0
datadog>= 3.3.0
helm>= 2.3.0
kubernetes>= 2.14.0, != 2.21.0
local>= 1.3
template>= 2.0


aws>= 4.0
datadog>= 3.3.0




aws_eks_cluster_auth.eksdata source


additional_tag_mapAdditional 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.
atomicIf set, installation process purges chart on fail. The wait flag will be set automatically if atomic is usedbooltrueno
attributesID 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.
chartChart name to be installed. The chart name can be local path, a URL to a chart, or the name of the chart if repository is specified. It is also possible to use the <repository>/<chart> format here if you are running Terraform on a system that the repository has been added to with helm repo add but this is not recommendedstringn/ayes
chart_versionSpecify the exact chart version to install. If this is not specified, the latest version is installedstringnullno
cleanup_on_failAllow deletion of new resources created in this upgrade when upgrade failsbooltrueno
contextSingle 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.
"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": [
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
create_namespaceCreate the Kubernetes namespace if it does not yet existbooltrueno
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
descriptionRelease description attribute (visible in the history)stringnullno
descriptor_formatsDescribe 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).
eks_component_nameThe name of the eks componentstring"eks/cluster"no
enabledSet to false to prevent the module from creating any resourcesboolnullno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
helm_manifest_experiment_enabledEnable storing of the rendered manifest for helm_release so the full diff of what is changing can been seen in the planboolfalseno
id_length_limitLimit 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.
kube_data_auth_enabledIf true, use an aws_eks_cluster_auth data source to authenticate to the EKS cluster.
Disabled by kubeconfig_file_enabled or kube_exec_auth_enabled.
kube_exec_auth_aws_profileThe AWS config profile for aws eks get-token to usestring""no
kube_exec_auth_aws_profile_enabledIf true, pass kube_exec_auth_aws_profile as the profile to aws eks get-tokenboolfalseno
kube_exec_auth_enabledIf true, use the Kubernetes provider exec feature to execute aws eks get-token to authenticate to the EKS cluster.
Disabled by kubeconfig_file_enabled, overrides kube_data_auth_enabled.
kube_exec_auth_role_arnThe role ARN for aws eks get-token to usestring""no
kube_exec_auth_role_arn_enabledIf true, pass kube_exec_auth_role_arn as the role ARN to aws eks get-tokenbooltrueno
kubeconfig_contextContext to choose from the Kubernetes kube config filestring""no
kubeconfig_exec_auth_api_versionThe Kubernetes API version of the credentials returned by the exec auth pluginstring""no
kubeconfig_fileThe Kubernetes provider config_path setting to use when kubeconfig_file_enabled is truestring""no
kubeconfig_file_enabledIf true, configure the Kubernetes provider with kubeconfig_file and use that kubeconfig file for authenticating to the EKS clusterboolfalseno
kubernetes_namespaceKubernetes namespace to install the release intostringn/ayes
label_key_caseControls 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.
label_orderThe 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.
label_value_caseControls 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.
labels_as_tagsSet 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.
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.
nameID 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.
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
private_location_tagsList of static tags to associate with the synthetics private locationset(string)[]no
regex_replace_charsTerraform 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.
regionAWS Regionstringn/ayes
repositoryRepository URL where to locate the requested chartstringnullno
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno
timeoutTime in seconds to wait for any individual kubernetes operation (like Jobs for hooks). Defaults to 300 secondsnumbernullno
verifyVerify the package before installing it. Helm uses a provenance file to verify the integrity of the chart; this must be hosted alongside the chartboolfalseno
waitWill wait until all resources are in a ready state before marking the release as successful. It will wait for as long as timeout. Defaults to trueboolnullno


metadataBlock status of the deployed release
synthetics_private_location_idSynthetics private location ID



PR #814

Possible Breaking Change

Previously this component directly created the Kubernetes namespace for the agent when create_namespace was set to true. Now this component delegates that responsibility to the helm-release module, which better coordinates the destruction of resources at destruction time (for example, ensuring that the Helm release is completely destroyed and finalizers run before deleting the namespace).

Generally the simplest upgrade path is to destroy the Helm release, then destroy the namespace, then apply the new configuration. Alternatively, you can use terraform state mv to move the existing namespace to the new Terraform "address", which will preserve the existing deployment and reduce the possibility of the destroy failing and leaving the Kubernetes cluster in a bad state.