Terraform module to provision all the necessary infrastructure to deploy Datadog Lambda forwarders
Tip
Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform.
Works with Github Actions, Atlantis, or Spacelift.
Watch demo of using Atmos with Terraform
Example of running
atmos to manage infrastructure from our Quick Start tutorial.
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 a S3 bucket with prefix:
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_with_prefixes = {
MyBucketWithPrefix = {bucket_name = "my-bucket-with-prefix", bucket_prefix = "events/"}
AnotherWithPrefix = {bucket_name = "another-with-prefix", bucket_prefix = "records/"}
}
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")
}Important
In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.
Here is an example of using this module:
examples/complete- complete example of using this module
Available targets:
help Help screen
help/all Display help for all targets
help/short This help short screen
lint Lint terraform code
| Name | Version |
|---|---|
| terraform | >= 1.3.0 |
| archive | >= 2.2.0 |
| aws | >= 3.0 |
| Name | Version |
|---|---|
| archive | >= 2.2.0 |
| aws | >= 3.0 |
| Name | Source | Version |
|---|---|---|
| cloudwatch_event | cloudposse/cloudwatch-events/aws | 0.6.1 |
| forwarder_log_artifact | cloudposse/module-artifact/external | 0.8.0 |
| forwarder_log_label | cloudposse/label/null | 0.25.0 |
| forwarder_log_s3_label | cloudposse/label/null | 0.25.0 |
| forwarder_rds_artifact | cloudposse/module-artifact/external | 0.8.0 |
| forwarder_rds_label | cloudposse/label/null | 0.25.0 |
| forwarder_vpclogs_artifact | cloudposse/module-artifact/external | 0.8.0 |
| forwarder_vpclogs_label | cloudposse/label/null | 0.25.0 |
| this | cloudposse/label/null | 0.25.0 |
| 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 |
| api_key_ssm_arn | ARN of the SSM parameter for the Datadog API key. Passing this removes the need to fetch the key from the SSM parameter store. This could be the case if the SSM Key is in a different region than the lambda. |
string |
null |
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 delimiterand treated as a single ID element. |
list(string) |
[] |
no |
| cloudwatch_forwarder_event_patterns | Map of title => CloudWatch Event patterns to forward to Datadog. Event structure from here: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEventsandEventPatterns.html#CloudWatchEventsPatterns Example: hcl |
map(object({ |
{} |
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({ |
{} |
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 |
{ |
no |
| datadog_forwarder_lambda_environment_variables | Map of environment variables to pass to the Lambda Function | map(string) |
{} |
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({ |
{ |
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 beidentical 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, us5.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 bechanged in later chained modules. Attempts to change it will be silently ignored. |
set(string) |
[ |
no |
| lambda_custom_policy_name | Additional IAM policy document that can optionally be passed and merged with the created policy document | string |
"DatadogForwarderCustomPolicy" |
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.11" |
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 of S3 buckets to forward logs to Datadog | list(string) |
[] |
no |
| s3_buckets_with_prefixes | The names S3 buckets and prefix to forward logs to Datadog | map(object({ bucket_name : string, bucket_prefix : string })) |
{} |
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 |
| 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 |
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.
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_integerResource - 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
Tip
Use Cloud Posse's 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.
📚 Learn More
Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.
Your team can operate like a pro today.
Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.
- Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
- Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
- Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
- Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
- GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.
- Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
- Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
- Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
- Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
- Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
- Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
- Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.
This project is under active development, and we encourage contributions from our community.
Many thanks to our outstanding contributors:
For 🐛 bug reports & feature requests, please use the issue tracker.
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!
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.
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.
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!
Preamble to the Apache License, Version 2.0
Complete license is available in the LICENSE file.
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.
All other trademarks referenced herein are the property of their respective owners.
Copyright © 2021-2024 Cloud Posse, LLC
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
![renovate[bot] avatar](https://avatars.githubusercontent.com/in/2740?v=4 "renovate[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent