datadog-lambda-forwarder

This component is responsible for provision all the necessary infrastructure to deploy Datadog Lambda forwarders. It depends on the datadog-configuration component to get the Datadog API keys.

Usage

Stack Level: Regional

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

components:
  terraform:
    datadog-lambda-forwarder:
      settings:
        spacelift:
          workspace_enabled: true
      vars:
        enabled: true
        name: datadog-lambda-forwarder
        # Set `forwarder_rds_enabled`  to `true` and configure `rds-enhanced-monitoring` Log Group when:
        # 1. The account has RDS instances provisioned
        # 2. RDS Enhanced Monitoring is enabled
        # 3. CloudWatch Log Group `RDSOSMetrics` exists (it will be created by AWS automatically when RDS Enhanced Monitoring is enabled)
        forwarder_rds_enabled: true
        forwarder_log_enabled: true
        forwarder_vpc_logs_enabled: true
        cloudwatch_forwarder_log_groups:
          rds-enhanced-monitoring:
            name: "RDSOSMetrics"
            filter_pattern: ""
          eks-cluster:
            # Use either `name` or `name_prefix` with `name_suffix`
            # If `name_prefix` with `name_suffix` are used, the final `name` will be constructed using `name_prefix` + context + `name_suffix`,
            # e.g. "/aws/eks/eg-ue2-prod-eks-cluster/cluster"
            name_prefix: "/aws/eks/"
            name_suffix: "eks-cluster/cluster"
            filter_pattern: ""
          transfer-sftp:
            name: "/aws/transfer/s-xxxxxxxxxxxx"
            filter_pattern: ""

Note for other regions, you need to deploy the datadog-configuration component in the respective region - the datadog configuration will be moving to a regional implementation.

For example if you usually deploy to us-west-2 (and DD Configuration is gbl), deploy it to the new region and then deploy the lambda forwarder.

import:
  - orgs/acme/plat/dev/_defaults
  - mixins/region/us-east-1
  - catalog/datadog/configuration
  - catalog/datadog/lambda-forwarder

components:
  terraform:
    datadog-configuration:
      vars:
        datadog_secrets_store_type: SSM
        datadog_secrets_source_store_account_stage: auto
        datadog_secrets_source_store_account_region: "us-west-2"

    datadog-lambda-forwarder:
      vars:
        datadog_configuration_environment: "use1"

Variables

Required Variables

region (string) required: AWS Region

Optional Variables

cloudwatch_forwarder_event_patterns optional

Map of title to CloudWatch Event patterns to forward to Datadog. Event structure from here: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEventsandEventPatterns.html#CloudWatchEventsPatterns
Example:

cloudwatch_forwarder_event_rules = {<br/>
  "guardduty" = {<br/>
    source = ["aws.guardduty"]<br/>
    detail-type = ["GuardDuty Finding"]<br/>
  }<br/>
  "ec2-terminated" = {<br/>
    source = ["aws.ec2"]<br/>
    detail-type = ["EC2 Instance State-change Notification"]<br/>
    detail = {<br/>
      state = ["terminated"]<br/>
    }<br/>
  }<br/>
}<br/>
```<br/>
<br/>
<br/>

**Type:**
```hcl
map(object({
version     = optional(list(string))
id          = optional(list(string))
detail-type = optional(list(string))
source      = optional(list(string))
account     = optional(list(string))
time        = optional(list(string))
region      = optional(list(string))
resources   = optional(list(string))
detail      = optional(map(list(string)))
}))

Default value: { }

cloudwatch_forwarder_log_groups (map(map(string))) optional

Map of CloudWatch Log Groups with a filter pattern that the Lambda forwarder will send logs from. For example: { mysql1 = { name = "/aws/rds/maincluster", filter_pattern = "" }

Default value: { }

context_tags (set(string)) optional

List of context tags to add to each monitor

Default value:

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

context_tags_enabled (bool) optional

Whether to add context tags to add to each monitor

Default value: true

datadog_configuration_environment (string) optional

AWS region where the Datadog configuration is deployed, useful for multi region setups, null uses default (gbl)

Default value: null

datadog_forwarder_lambda_environment_variables (map(string)) optional

Map of environment variables to pass to the Lambda Function

Default value: { }

dd_api_key_kms_ciphertext_blob (string) optional

CiphertextBlob stored in environment variable DD_KMS_API_KEY used by the lambda function, along with the KMS key, to decrypt Datadog API key

Default value: ""

dd_artifact_filename (string) optional

The Datadog artifact filename minus extension

Default value: "aws-dd-forwarder"

dd_forwarder_version (string) optional

Version tag of Datadog lambdas to use. https://github.com/DataDog/datadog-serverless-functions/releases

Default value: "3.66.0"

dd_module_name (string) optional

The Datadog GitHub repository name

Default value: "datadog-serverless-functions"

dd_tags_map (map(string)) optional

A map of Datadog tags to apply to all logs forwarded to Datadog

Default value: { }

forwarder_lambda_debug_enabled (bool) optional

Whether to enable or disable debug for the Lambda forwarder

Default value: false

forwarder_log_artifact_url (string) optional

The URL for the code of the Datadog forwarder for Logs. It can be a local file, URL or git repo

Default value: null

forwarder_log_enabled (bool) optional

Flag to enable or disable Datadog log forwarder

Default value: false

forwarder_log_layers (list(string)) optional

List of Lambda Layer Version ARNs (maximum of 5) to attach to Datadog log forwarder lambda function

Default value: [ ]

forwarder_log_retention_days (number) optional

Number of days to retain Datadog forwarder lambda execution logs. One of [0 1 3 5 7 14 30 60 90 120 150 180 365 400 545 731 1827 3653]

Default value: 14

forwarder_rds_artifact_url (string) optional

The URL for the code of the Datadog forwarder for RDS. It can be a local file, url or git repo

Default value: null

forwarder_rds_enabled (bool) optional

Flag to enable or disable Datadog RDS enhanced monitoring forwarder

Default value: false

forwarder_rds_filter_pattern (string) optional

Filter pattern for Lambda forwarder RDS

Default value: ""

forwarder_rds_layers (list(string)) optional

List of Lambda Layer Version ARNs (maximum of 5) to attach to Datadog RDS enhanced monitoring lambda function

Default value: [ ]

forwarder_vpc_logs_artifact_url (string) optional

The URL for the code of the Datadog forwarder for VPC Logs. It can be a local file, url or git repo

Default value: null

forwarder_vpc_logs_enabled (bool) optional

Flag to enable or disable Datadog VPC flow log forwarder

Default value: false

forwarder_vpc_logs_layers (list(string)) optional

List of Lambda Layer Version ARNs (maximum of 5) to attach to Datadog VPC flow log forwarder lambda function

Default value: [ ]

forwarder_vpclogs_filter_pattern (string) optional

Filter pattern for Lambda forwarder VPC Logs

Default value: ""

kms_key_id (string) optional

Optional KMS key ID to encrypt Datadog Lambda function logs

Default value: null

lambda_arn_enabled (bool) optional

Enable adding the Lambda Arn to this account integration

Default value: true

lambda_policy_source_json (string) optional

Additional IAM policy document that can optionally be passed and merged with the created policy document

Default value: ""

lambda_reserved_concurrent_executions (number) optional

Amount of reserved concurrent executions for the lambda function. A value of 0 disables Lambda from being triggered and -1 removes any concurrency limitations. Defaults to Unreserved Concurrency Limits -1

Default value: -1

lambda_runtime (string) optional

Runtime environment for Datadog Lambda

Default value: "python3.8"

log_collection_services (list(string)) optional

List of log collection services to enable

Default value:

[
  "apigw-access-logs",
  "apigw-execution-logs",
  "elbv2",
  "elb",
  "cloudfront",
  "lambda",
  "redshift",
  "s3"
]

s3_bucket_kms_arns (list(string)) optional

List of KMS key ARNs for s3 bucket encryption

Default value: [ ]

s3_buckets (list(string)) optional

The names of S3 buckets to forward logs to Datadog

Default value: [ ]

s3_buckets_with_prefixes (map(object({ bucket_name : string, bucket_prefix : string }))) optional

The names S3 buckets and prefix to forward logs to Datadog

Default value: { }

security_group_ids (list(string)) optional

List of security group IDs to use when the Lambda Function runs in a VPC

Default value: null

subnet_ids (list(string)) optional

List of subnet IDs to use when deploying the Lambda Function in a VPC

Default value: null

tracing_config_mode (string) optional

Can be either PassThrough or Active. If PassThrough, Lambda will only trace the request from an upstream service if it contains a tracing header with 'sampled=1'. If Active, Lambda will respect any tracing header it receives from an upstream service

Default value: "PassThrough"

vpclogs_cloudwatch_log_group (string) optional

The name of the CloudWatch Log Group for VPC flow logs

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

lambda_forwarder_log_function_arn: Datadog Lambda forwarder CloudWatch/S3 function ARN
lambda_forwarder_log_function_name: Datadog Lambda forwarder CloudWatch/S3 function name
lambda_forwarder_rds_enhanced_monitoring_function_name: Datadog Lambda forwarder RDS Enhanced Monitoring function name
lambda_forwarder_rds_function_arn: Datadog Lambda forwarder RDS Enhanced Monitoring function ARN
lambda_forwarder_vpc_log_function_arn: Datadog Lambda forwarder VPC Flow Logs function ARN
lambda_forwarder_vpc_log_function_name: Datadog Lambda forwarder VPC Flow Logs function name

Dependencies

Requirements

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

Providers

datadog, version: >= 3.3.0

Modules

Name	Version	Source	Description
`datadog-integration`	1.5.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`datadog_configuration`	latest	`../datadog-configuration/modules/datadog_keys`	n/a
`datadog_lambda_forwarder`	1.5.3	`cloudposse/datadog-lambda-forwarder/aws`	n/a
`iam_roles`	latest	`../account-map/modules/iam-roles`	n/a
`log_group_prefix`	0.25.0	`cloudposse/label/null`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

datadog_integration_aws_lambda_arn.log_collector (resource)
datadog_integration_aws_lambda_arn.rds_collector (resource)
datadog_integration_aws_lambda_arn.vpc_logs_collector (resource)
datadog_integration_aws_log_collection.main (resource)

Data Sources

The following data sources are used by this module:

References

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

Changelog

PR #814

Fix for `enabled = false` or Destroy and Recreate

Previously, when enabled = false was set, the component would not necessarily function as desired (deleting any existing resources and not creating any new ones). Also, previously, when deleting the component, there was a race condition where the log group could be deleted before the lambda function was deleted, causing the lambda function to trigger automatic recreation of the log group. This would result in re-creation failing because Terraform would try to create the log group but it already existed.

These issues have been fixed in this PR.

Usage​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

References​

Changelog​

PR #814​

Fix for enabled = false or Destroy and Recreate​

Usage

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources

References

Changelog

PR #814

Fix for `enabled = false` or Destroy and Recreate