Component: datadog-integration

This component is responsible for provisioning Datadog AWS integrations. It depends on the datadog-configuration component to get the Datadog API keys.

See Datadog's documentation about provisioning keys for more information.

Usage

Stack Level: Global

Here's an example snippet for how to use this component. It's suggested to apply this component to all accounts which you want to track AWS metrics with DataDog.

components:
  terraform:
    datadog-integration:
      settings:
        spacelift:
          workspace_enabled: true
      vars:
        enabled: true

Requirements

Name	Version
terraform	>= 1.0.0
aws	>= 4.9.0
datadog	>= 3.3.0

Providers

Name	Version
aws	>= 4.9.0

Modules

Name	Source	Version
datadog_configuration	../datadog-configuration/modules/datadog_keys	n/a
datadog_integration	cloudposse/datadog-integration/aws	1.2.0
iam_roles	../account-map/modules/iam-roles	n/a
store_write	cloudposse/ssm-parameter-store/aws	0.11.0
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_regions.all	data source

Inputs

Name	Description	Type	Default	Required
account_specific_namespace_rules	An object, (in the form {"namespace1":true/false, "namespace2":true/false} ), that enables or disables metric collection for specific AWS namespaces for this AWS account only	map(string)	{}	no
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
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
context_host_and_filter_tags	Automatically add host and filter tags for these context keys	list(string)	[ "namespace", "tenant", "stage" ]	no
cspm_resource_collection_enabled	Enable Datadog Cloud Security Posture Management scanning of your AWS account. See announcement for details.	bool	null	no
datadog_aws_account_id	The AWS account ID Datadog's integration servers use for all integrations	string	"464622532012"	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
excluded_regions	An array of AWS regions to exclude from metrics collection	list(string)	[]	no
filter_tags	An array of EC2 tags (in the form key:value) that defines a filter that Datadog use when collecting metrics from EC2. Wildcards, such as ? (for single characters) and * (for multiple characters) can also be used	list(string)	[]	no
host_tags	An array of tags (in the form key:value) to add to all hosts and metrics reporting through this integration	list(string)	[]	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
included_regions	An array of AWS regions to include in metrics collection	list(string)	[]	no
integrations	List of AWS permission names to apply for different integrations (e.g. 'all', 'core')	list(string)	[ "all" ]	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
metrics_collection_enabled	When enabled, a metric-by-metric crawl of the CloudWatch API pulls data and sends it to Datadog. New metrics are pulled every ten minutes, on average.	bool	null	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
region	AWS Region	string	n/a	yes
resource_collection_enabled	Some Datadog products leverage information about how your AWS resources (such as S3 Buckets, RDS snapshots, and CloudFront distributions) are configured. When resource_collection_enabled is true, Datadog collects this information by making read-only API calls into your AWS account.	bool	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
aws_account_id	AWS Account ID of the IAM Role for the Datadog integration
aws_role_name	Name of the AWS IAM Role for the Datadog integration
datadog_external_id	Datadog integration external ID

References

• Datadog's documentation about provisioning keys
• cloudposse/terraform-aws-components - Cloud Posse's upstream component

CHANGELOG

PR #814

Possible Breaking Change

The module "datadog_integration" and module "store_write" had been changed in an earlier PR from a module without a count to a module with a count of zero or one. This PR changes it back to a module without a count. If you were using the module with a count of zero or one, applying this new version will cause it be destroyed and recreated. This should only cause a very brief outage in your Datadog monitoring.

New Integration Options

This PR adds the following new integration options:

• cspm_resource_collection_enabled - Enable Datadog Cloud Security Posture Management scanning of your AWS account. See announcement for details.
• metrics_collection_enabled - When enabled, a metric-by-metric crawl of the CloudWatch API pulls data and sends it to Datadog. New metrics are pulled every ten minutes, on average.
• resource_collection_enabled - Some Datadog products leverage information about how your AWS resources ( such as S3 Buckets, RDS snapshots, and CloudFront distributions) are configured. When resource_collection_enabled is true, Datadog collects this information by making read-only API calls into your AWS account.