Awesome

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"

Requirements

Name	Version
<a name="requirement_terraform"></a> terraform	>= 1.0.0
<a name="requirement_aws"></a> aws	>= 4.0
<a name="requirement_datadog"></a> datadog	>= 3.3.0

Providers

Name	Version
<a name="provider_datadog"></a> datadog	>= 3.3.0

Modules

Name	Source	Version
<a name="module_datadog-integration"></a> datadog-integration	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
<a name="module_datadog_configuration"></a> datadog_configuration	../datadog-configuration/modules/datadog_keys	n/a
<a name="module_datadog_lambda_forwarder"></a> datadog_lambda_forwarder	cloudposse/datadog-lambda-forwarder/aws	1.5.3
<a name="module_iam_roles"></a> iam_roles	../account-map/modules/iam-roles	n/a
<a name="module_log_group_prefix"></a> log_group_prefix	cloudposse/label/null	0.25.0
<a name="module_this"></a> this	cloudposse/label/null	0.25.0

Resources

Name	Type
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

Inputs

Name	Description	Type	Default	Required
<a name="input_additional_tag_map"></a> additional_tag_map	Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.<br/>This is for some rare cases where resources want additional configuration of tags<br/>and therefore take a list of maps with tag key, value, and additional configuration.	`map(string)`	`{}`	no
<a name="input_attributes"></a> attributes	ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,<br/>in the order they appear in the list. New attributes are appended to the<br/>end of the list. The elements of the list are joined by the `delimiter`<br/>and treated as a single ID element.	`list(string)`	`[]`	no
<a name="input_cloudwatch_forwarder_event_patterns"></a> cloudwatch_forwarder_event_patterns	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<br/>Example:<pre>hcl<br/>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/>}</pre>	<pre>map(object({<br/> version = optional(list(string))<br/> id = optional(list(string))<br/> detail-type = optional(list(string))<br/> source = optional(list(string))<br/> account = optional(list(string))<br/> time = optional(list(string))<br/> region = optional(list(string))<br/> resources = optional(list(string))<br/> detail = optional(map(list(string)))<br/> }))</pre>	`{}`	no
<a name="input_cloudwatch_forwarder_log_groups"></a> cloudwatch_forwarder_log_groups	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 = "" }	`map(map(string))`	`{}`	no
<a name="input_context"></a> context	Single object for setting entire context at once.<br/>See description of individual variables for details.<br/>Leave string and numeric variables as `null` to use default value.<br/>Individual variable settings (non-null) override settings in context object,<br/>except for attributes, tags, and additional_tag_map, which are merged.	`any`	<pre>{<br/> "additional_tag_map": {},<br/> "attributes": [],<br/> "delimiter": null,<br/> "descriptor_formats": {},<br/> "enabled": true,<br/> "environment": null,<br/> "id_length_limit": null,<br/> "label_key_case": null,<br/> "label_order": [],<br/> "label_value_case": null,<br/> "labels_as_tags": [<br/> "unset"<br/> ],<br/> "name": null,<br/> "namespace": null,<br/> "regex_replace_chars": null,<br/> "stage": null,<br/> "tags": {},<br/> "tenant": null<br/>}</pre>	no
<a name="input_context_tags"></a> context_tags	List of context tags to add to each monitor	`set(string)`	<pre>[<br/> "namespace",<br/> "tenant",<br/> "environment",<br/> "stage"<br/>]</pre>	no
<a name="input_context_tags_enabled"></a> context_tags_enabled	Whether to add context tags to add to each monitor	`bool`	`true`	no
<a name="input_datadog_configuration_environment"></a> datadog_configuration_environment	AWS region where the Datadog configuration is deployed, useful for multi region setups, null uses default (gbl)	`string`	`null`	no
<a name="input_datadog_forwarder_lambda_environment_variables"></a> datadog_forwarder_lambda_environment_variables	Map of environment variables to pass to the Lambda Function	`map(string)`	`{}`	no
<a name="input_dd_api_key_kms_ciphertext_blob"></a> dd_api_key_kms_ciphertext_blob	CiphertextBlob stored in environment variable DD_KMS_API_KEY used by the lambda function, along with the KMS key, to decrypt Datadog API key	`string`	`""`	no
<a name="input_dd_artifact_filename"></a> dd_artifact_filename	The Datadog artifact filename minus extension	`string`	`"aws-dd-forwarder"`	no
<a name="input_dd_forwarder_version"></a> dd_forwarder_version	Version tag of Datadog lambdas to use. https://github.com/DataDog/datadog-serverless-functions/releases	`string`	`"3.66.0"`	no
<a name="input_dd_module_name"></a> dd_module_name	The Datadog GitHub repository name	`string`	`"datadog-serverless-functions"`	no
<a name="input_dd_tags_map"></a> dd_tags_map	A map of Datadog tags to apply to all logs forwarded to Datadog	`map(string)`	`{}`	no
<a name="input_delimiter"></a> delimiter	Delimiter to be used between ID elements.<br/>Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.	`string`	`null`	no
<a name="input_descriptor_formats"></a> descriptor_formats	Describe additional descriptors to be output in the `descriptors` output map.<br/>Map of maps. Keys are names of descriptors. Values are maps of the form<br/>`{<br/> format = string<br/> labels = list(string)<br/>}`<br/>(Type is `any` so the map values can later be enhanced to provide additional options.)<br/>`format` is a Terraform format string to be passed to the `format()` function.<br/>`labels` is a list of labels, in order, to pass to `format()` function.<br/>Label values will be normalized before being passed to `format()` so they will be<br/>identical to how they appear in `id`.<br/>Default is `{}` (`descriptors` output will be empty).	`any`	`{}`	no
<a name="input_enabled"></a> enabled	Set to false to prevent the module from creating any resources	`bool`	`null`	no
<a name="input_environment"></a> environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	`string`	`null`	no
<a name="input_forwarder_lambda_debug_enabled"></a> forwarder_lambda_debug_enabled	Whether to enable or disable debug for the Lambda forwarder	`bool`	`false`	no
<a name="input_forwarder_log_artifact_url"></a> forwarder_log_artifact_url	The URL for the code of the Datadog forwarder for Logs. It can be a local file, URL or git repo	`string`	`null`	no
<a name="input_forwarder_log_enabled"></a> forwarder_log_enabled	Flag to enable or disable Datadog log forwarder	`bool`	`false`	no
<a name="input_forwarder_log_layers"></a> forwarder_log_layers	List of Lambda Layer Version ARNs (maximum of 5) to attach to Datadog log forwarder lambda function	`list(string)`	`[]`	no
<a name="input_forwarder_log_retention_days"></a> forwarder_log_retention_days	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]	`number`	`14`	no
<a name="input_forwarder_rds_artifact_url"></a> forwarder_rds_artifact_url	The URL for the code of the Datadog forwarder for RDS. It can be a local file, url or git repo	`string`	`null`	no
<a name="input_forwarder_rds_enabled"></a> forwarder_rds_enabled	Flag to enable or disable Datadog RDS enhanced monitoring forwarder	`bool`	`false`	no
<a name="input_forwarder_rds_filter_pattern"></a> forwarder_rds_filter_pattern	Filter pattern for Lambda forwarder RDS	`string`	`""`	no
<a name="input_forwarder_rds_layers"></a> forwarder_rds_layers	List of Lambda Layer Version ARNs (maximum of 5) to attach to Datadog RDS enhanced monitoring lambda function	`list(string)`	`[]`	no
<a name="input_forwarder_vpc_logs_artifact_url"></a> forwarder_vpc_logs_artifact_url	The URL for the code of the Datadog forwarder for VPC Logs. It can be a local file, url or git repo	`string`	`null`	no
<a name="input_forwarder_vpc_logs_enabled"></a> forwarder_vpc_logs_enabled	Flag to enable or disable Datadog VPC flow log forwarder	`bool`	`false`	no
<a name="input_forwarder_vpc_logs_layers"></a> forwarder_vpc_logs_layers	List of Lambda Layer Version ARNs (maximum of 5) to attach to Datadog VPC flow log forwarder lambda function	`list(string)`	`[]`	no
<a name="input_forwarder_vpclogs_filter_pattern"></a> forwarder_vpclogs_filter_pattern	Filter pattern for Lambda forwarder VPC Logs	`string`	`""`	no
<a name="input_id_length_limit"></a> id_length_limit	Limit `id` to this many characters (minimum 6).<br/>Set to `0` for unlimited length.<br/>Set to `null` for keep the existing setting, which defaults to `0`.<br/>Does not affect `id_full`.	`number`	`null`	no
<a name="input_kms_key_id"></a> kms_key_id	Optional KMS key ID to encrypt Datadog Lambda function logs	`string`	`null`	no
<a name="input_label_key_case"></a> label_key_case	Controls the letter case of the `tags` keys (label names) for tags generated by this module.<br/>Does not affect keys of tags passed in via the `tags` input.<br/>Possible values: `lower`, `title`, `upper`.<br/>Default value: `title`.	`string`	`null`	no
<a name="input_label_order"></a> label_order	The order in which the labels (ID elements) appear in the `id`.<br/>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br/>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.	`list(string)`	`null`	no
<a name="input_label_value_case"></a> label_value_case	Controls the letter case of ID elements (labels) as included in `id`,<br/>set as tag values, and output by this module individually.<br/>Does not affect values of tags passed in via the `tags` input.<br/>Possible values: `lower`, `title`, `upper` and `none` (no transformation).<br/>Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs.<br/>Default value: `lower`.	`string`	`null`	no
<a name="input_labels_as_tags"></a> labels_as_tags	Set of labels (ID elements) to include as tags in the `tags` output.<br/>Default is to include all labels.<br/>Tags with empty values will not be included in the `tags` output.<br/>Set to `[]` to suppress all generated tags.<br/>Notes:<br/> The value of the `name` tag, if included, will be the `id`, not the `name`.<br/> Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be<br/> changed in later chained modules. Attempts to change it will be silently ignored.	`set(string)`	<pre>[<br/> "default"<br/>]</pre>	no
<a name="input_lambda_arn_enabled"></a> lambda_arn_enabled	Enable adding the Lambda Arn to this account integration	`bool`	`true`	no
<a name="input_lambda_policy_source_json"></a> lambda_policy_source_json	Additional IAM policy document that can optionally be passed and merged with the created policy document	`string`	`""`	no
<a name="input_lambda_reserved_concurrent_executions"></a> lambda_reserved_concurrent_executions	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	`number`	`-1`	no
<a name="input_lambda_runtime"></a> lambda_runtime	Runtime environment for Datadog Lambda	`string`	`"python3.8"`	no
<a name="input_log_collection_services"></a> log_collection_services	List of log collection services to enable	`list(string)`	<pre>[<br/> "apigw-access-logs",<br/> "apigw-execution-logs",<br/> "elbv2",<br/> "elb",<br/> "cloudfront",<br/> "lambda",<br/> "redshift",<br/> "s3"<br/>]</pre>	no
<a name="input_name"></a> name	ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br/>This is the only ID element not also included as a `tag`.<br/>The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input.	`string`	`null`	no
<a name="input_namespace"></a> 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
<a name="input_regex_replace_chars"></a> regex_replace_chars	Terraform regular expression (regex) string.<br/>Characters matching the regex will be removed from the ID elements.<br/>If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits.	`string`	`null`	no
<a name="input_region"></a> region	AWS Region	`string`	n/a	yes
<a name="input_s3_bucket_kms_arns"></a> s3_bucket_kms_arns	List of KMS key ARNs for s3 bucket encryption	`list(string)`	`[]`	no
<a name="input_s3_buckets"></a> s3_buckets	The names of S3 buckets to forward logs to Datadog	`list(string)`	`[]`	no
<a name="input_s3_buckets_with_prefixes"></a> s3_buckets_with_prefixes	The names S3 buckets and prefix to forward logs to Datadog	`map(object({ bucket_name : string, bucket_prefix : string }))`	`{}`	no
<a name="input_security_group_ids"></a> security_group_ids	List of security group IDs to use when the Lambda Function runs in a VPC	`list(string)`	`null`	no
<a name="input_stage"></a> stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
<a name="input_subnet_ids"></a> subnet_ids	List of subnet IDs to use when deploying the Lambda Function in a VPC	`list(string)`	`null`	no
<a name="input_tags"></a> tags	Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).<br/>Neither the tag keys nor the tag values will be modified by this module.	`map(string)`	`{}`	no
<a name="input_tenant"></a> tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	`string`	`null`	no
<a name="input_tracing_config_mode"></a> tracing_config_mode	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	`string`	`"PassThrough"`	no
<a name="input_vpclogs_cloudwatch_log_group"></a> vpclogs_cloudwatch_log_group	The name of the CloudWatch Log Group for VPC flow logs	`string`	`null`	no

Outputs

Name	Description
<a name="output_lambda_forwarder_log_function_arn"></a> lambda_forwarder_log_function_arn	Datadog Lambda forwarder CloudWatch/S3 function ARN
<a name="output_lambda_forwarder_log_function_name"></a> lambda_forwarder_log_function_name	Datadog Lambda forwarder CloudWatch/S3 function name
<a name="output_lambda_forwarder_rds_enhanced_monitoring_function_name"></a> lambda_forwarder_rds_enhanced_monitoring_function_name	Datadog Lambda forwarder RDS Enhanced Monitoring function name
<a name="output_lambda_forwarder_rds_function_arn"></a> lambda_forwarder_rds_function_arn	Datadog Lambda forwarder RDS Enhanced Monitoring function ARN
<a name="output_lambda_forwarder_vpc_log_function_arn"></a> lambda_forwarder_vpc_log_function_arn	Datadog Lambda forwarder VPC Flow Logs function ARN
<a name="output_lambda_forwarder_vpc_log_function_name"></a> lambda_forwarder_vpc_log_function_name	Datadog Lambda forwarder VPC Flow Logs function name

References

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

[!NOTE] This project is part of Cloud Posse's comprehensive "SweetOps" approach towards DevOps.
<details><summary>Learn More</summary>
It's 100% Open Source and licensed under the APACHE2.
</details>

Related Projects

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

✨ Contributing

This project is under active development, and we encourage contributions from our community. Many thanks to our outstanding contributors:

🐛 Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

💻 Developing

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!

🌎 Slack Community

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.

📰 Newsletter

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.

📆 Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-datadog-lambda-forwarder&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>

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!

About

This project is maintained by <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-datadog-lambda-forwarder&utm_content=">Cloud Posse, LLC</a>. <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-datadog-lambda-forwarder&utm_content="><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>

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.

<details> <summary>📚 See What's Included</summary>

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.

</details>

License

<details> <summary>Preamble to the Apache License, Version 2.0</summary>

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.

</details>

Trademarks

All other trademarks referenced herein are the property of their respective owners.