terraform-aws-datadog-lambda-forwarder

Terraform module to provision all the necessary infrastructure to deploy Datadog Lambda forwarders

---

This project is part of our comprehensive "SweetOps" approach towards DevOps.

It's 100% Open Source and licensed under the APACHE2.

We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!

Security & Compliance

Security scanning is graciously provided by Bridgecrew. Bridgecrew is the leading fully hosted, cloud-native solution providing continuous Terraform security and compliance.

Benchmark	Description
	Infrastructure Security Compliance
	Center for Internet Security, KUBERNETES Compliance
	Center for Internet Security, AWS Compliance
	Center for Internet Security, AZURE Compliance
	Payment Card Industry Data Security Standards Compliance
	National Institute of Standards and Technology Compliance
	Information Security Management System, ISO/IEC 27001 Compliance
	Service Organization Control 2 Compliance
	Center for Internet Security, GCP Compliance
	Health Insurance Portability and Accountability Compliance

Usage

IMPORTANT: We do not pin modules to versions in our examples because of the difficulty of keeping the versions in the documentation in sync with the latest released versions. We highly recommend that in your code you pin the version to the exact version you are using so that your infrastructure remains stable, and update versions in a systematic way so that they do not catch you by surprise.

Also, because of a bug in the Terraform registry (hashicorp/terraform#21417), the registry shows many of our inputs as required when in fact they are optional. The table below correctly indicates which inputs are required.

For a complete example, see examples/complete.

For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.

To enable Datadog forwarder for RDS Enhanced monitoring:

module "datadog_lambda_forwarder" {
  source = "cloudposse/datadog-lambda-forwarder/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  forwarder_rds_enabled = true
}

To enable Datadog forwarder for a CloudTrail S3 bucket:

module "datadog_lambda_forwarder" {
  source = "cloudposse/datadog-lambda-forwarder/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  forwarder_log_enabled = true
  s3_buckets            = ["cloudtrail-audit-bucket"]
  s3_bucket_kms_arns    = ["arn:aws:kms:us-west-2:1234567890:key/b204f3d2-1111-2222-94333332-4444ccc222"]
}

To enable Datadog forwarder for RDS authentication CloudWatch logs:

module "datadog_lambda_forwarder" {
  source = "cloudposse/datadog-lambda-forwarder/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  forwarder_log_enabled = true
  cloudwatch_forwarder_log_groups = {
    postgres = {
      name           = "/aws/rds/cluster/pg-main/postgresql"
      filter_pattern = ""
    }
  }
}

To enable Datadog forwarder for VPC Flow Logs CloudWatch logs:

module "datadog_lambda_forwarder" {
  source = "cloudposse/datadog-lambda-forwarder/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  forwarder_vpc_logs_enabled   = true
  vpclogs_cloudwatch_log_group = "/aws/vpc/flowlogs/vpc1"
}

To use a local copy of the lambda code you can specify the artifact url:

module "datadog_lambda_forwarder" {
  source = "cloudposse/datadog-lambda-forwarder/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  forwarder_rds_enabled      = true
  forwarder_rds_artifact_url = file("${path.module}/function.zip")
}

Examples

Here is an example of using this module:

• examples/complete - complete example of using this module

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Requirements

Name	Version
terraform	>= 0.13
archive	>= 2.2.0
aws	>= 3.30.0

Providers

Name	Version
archive	>= 2.2.0
aws	>= 3.30.0

Modules

Name	Source	Version
forwarder_log_artifact	git::https://github.com/bwmetcalf/terraform-external-module-artifact.git	remove-template-provider
forwarder_log_label	cloudposse/label/null	0.25.0
forwarder_log_s3_label	cloudposse/label/null	0.25.0
forwarder_rds_artifact	git::https://github.com/bwmetcalf/terraform-external-module-artifact.git	remove-template-provider
forwarder_rds_label	cloudposse/label/null	0.25.0
forwarder_vpclogs_artifact	git::https://github.com/bwmetcalf/terraform-external-module-artifact.git	remove-template-provider
forwarder_vpclogs_label	cloudposse/label/null	0.25.0
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_cloudwatch_log_group.forwarder_log	resource
aws_cloudwatch_log_group.forwarder_rds	resource
aws_cloudwatch_log_group.forwarder_vpclogs	resource
aws_cloudwatch_log_subscription_filter.cloudwatch_log_subscription_filter	resource
aws_cloudwatch_log_subscription_filter.datadog_log_subscription_filter_rds	resource
aws_cloudwatch_log_subscription_filter.datadog_log_subscription_filter_vpclogs	resource
aws_iam_policy.lambda_forwarder_log	resource
aws_iam_policy.lambda_forwarder_log_s3	resource
aws_iam_policy.lambda_forwarder_rds	resource
aws_iam_policy.lambda_forwarder_vpclogs	resource
aws_iam_role.lambda_forwarder_log	resource
aws_iam_role.lambda_forwarder_rds	resource
aws_iam_role.lambda_forwarder_vpclogs	resource
aws_iam_role_policy_attachment.datadog_s3	resource
aws_iam_role_policy_attachment.lambda_forwarder_log	resource
aws_iam_role_policy_attachment.lambda_forwarder_rds	resource
aws_iam_role_policy_attachment.lambda_forwarder_vpclogs	resource
aws_lambda_function.forwarder_log	resource
aws_lambda_function.forwarder_rds	resource
aws_lambda_function.forwarder_vpclogs	resource
aws_lambda_permission.allow_s3_bucket	resource
aws_lambda_permission.cloudwatch_enhanced_rds_monitoring	resource
aws_lambda_permission.cloudwatch_groups	resource
aws_lambda_permission.cloudwatch_vpclogs	resource
aws_s3_bucket_notification.s3_bucket_notification	resource
archive_file.forwarder_rds	data source
archive_file.forwarder_vpclogs	data source
aws_caller_identity.current	data source
aws_cloudwatch_log_group.cloudwatch_log_group	data source
aws_iam_policy_document.assume_role	data source
aws_iam_policy_document.lambda_default	data source
aws_iam_policy_document.s3_log_bucket	data source
aws_partition.current	data source
aws_region.current	data source
aws_ssm_parameter.api_key	data source

Inputs

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
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
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(object({ name = string filter_pattern = 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
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
dd_api_key_source	One of: ARN for AWS Secrets Manager (asm) to retrieve the Datadog (DD) api key, ARN for the KMS (kms) key used to decrypt the ciphertext_blob of the api key, or the name of the SSM (ssm) parameter used to retrieve the Datadog API key	object({ resource = string identifier = string })	{ "identifier": "", "resource": "" }	no
dd_artifact_filename	The Datadog artifact filename minus extension	string	"aws-dd-forwarder"	no
dd_forwarder_version	Version tag of Datadog lambdas to use. https://github.com/DataDog/datadog-serverless-functions/releases	string	"3.39.0"	no
dd_module_name	The Datadog GitHub repository name	string	"datadog-serverless-functions"	no
dd_tags	A list of Datadog tags to apply to all logs forwarded to Datadog	list(string)	[]	no
dd_tags_map	A map of Datadog tags to apply to all logs forwarded to Datadog. This will override dd_tags.	map(string)	{}	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
forwarder_iam_path	Path to the IAM roles and policies created	string	"/"	no
forwarder_lambda_datadog_host	Datadog Site to send data to. Possible values are datadoghq.com, datadoghq.eu, us3.datadoghq.com and ddog-gov.com	string	"datadoghq.com"	no
forwarder_lambda_debug_enabled	Whether to enable or disable debug for the Lambda forwarder	bool	false	no
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
forwarder_log_enabled	Flag to enable or disable Datadog log forwarder	bool	false	no
forwarder_log_layers	List of Lambda Layer Version ARNs (maximum of 5) to attach to Datadog log forwarder lambda function	list(string)	[]	no
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
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
forwarder_rds_enabled	Flag to enable or disable Datadog RDS enhanced monitoring forwarder	bool	false	no
forwarder_rds_filter_pattern	Filter pattern for Lambda forwarder RDS	string	""	no
forwarder_rds_layers	List of Lambda Layer Version ARNs (maximum of 5) to attach to Datadog RDS enhanced monitoring lambda function	list(string)	[]	no
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
forwarder_vpc_logs_enabled	Flag to enable or disable Datadog VPC flow log forwarder	bool	false	no
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
forwarder_vpclogs_filter_pattern	Filter pattern for Lambda forwarder VPC Logs	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
kms_key_id	Optional KMS key ID to encrypt Datadog Lambda function logs	string	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 be changed in later chained modules. Attempts to change it will be silently ignored.	set(string)	[ "default" ]	no
lambda_memory_size	Amount of memory in MB your Lambda Function can use at runtime	number	128	no
lambda_policy_source_json	Additional IAM policy document that can optionally be passed and merged with the created policy document	string	""	no
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
lambda_runtime	Runtime environment for Datadog Lambda	string	"python3.7"	no
lambda_timeout	Amount of time your Datadog Lambda Function has to run in seconds	number	120	no
log_permissions_boundary	ARN of the policy that is used to set the permissions boundary for the lambda-log role managed by this module.	string	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
rds_permissions_boundary	ARN of the policy that is used to set the permissions boundary for the lambda-rds role managed by this module.	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
s3_bucket_kms_arns	List of KMS key ARNs for s3 bucket encryption	list(string)	[]	no
s3_buckets	The names and ARNs of S3 buckets to forward logs to Datadog	list(string)	null	no
security_group_ids	List of security group IDs to use when the Lambda Function runs in a VPC	list(string)	null	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
subnet_ids	List of subnet IDs to use when deploying the Lambda Function in a VPC	list(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
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
vpc_logs_permissions_boundary	ARN of the policy that is used to set the permissions boundary for the lambda-vpc-logs role managed by this module.	string	null	no
vpclogs_cloudwatch_log_group	The name of the CloudWatch Log Group for VPC flow logs	string	null	no

Outputs

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

Share the Love

Like this project? Please give it a ★ on our GitHub! (it helps us a lot)

Are you using this project or any of our other projects? Consider leaving a testimonial. =)

Related Projects

Check out these related projects.

• terraform-null-label - Terraform module designed to generate consistent names and tags for resources. Use terraform-null-label to implement a strict naming convention.

References

For additional context, refer to some of these links.

• Terraform Standard Module Structure - HashiCorp's standard module structure is a file and directory layout we recommend for reusable modules distributed in separate repositories.
• Terraform Module Requirements - HashiCorp's guidance on all the requirements for publishing a module. Meeting the requirements for publishing a module is extremely easy.
• Terraform random_integer Resource - The resource random_integer generates random values from a given range, described by the min and max attributes of a given resource.
• Terraform Version Pinning - The required_version setting can be used to constrain which versions of the Terraform CLI can be used with your configuration

Help

Got a question? We got answers.

File a GitHub issue, send us an email or join our Slack Community.

DevOps Accelerator for Startups

We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.

• Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
• Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
• 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.

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.

Discourse Forums

Participate in our Discourse Forums. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.

Newsletter

Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.

Office Hours

Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!

Contributing

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 our other projects, we would love to hear from you! Shoot us an email.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

1. Fork the repo on GitHub
2. Clone the project to your own machine
3. Commit changes to your own branch
4. Push your work back up to your fork
5. 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!

Copyrights

Copyright © 2021-2022 Cloud Posse, LLC

License

See LICENSE for full details.

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.

Trademarks

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

About

This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!

We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.

We offer paid support on all of our projects.

Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.

Contributors

PePe Amengual	RB	Erik Osterman	Andriy Knysh