This component is responsible for provisioning Datadog Log Archives. It creates a single log archive pipeline for each AWS account. If the catchall flag is set, it creates a catchall archive within the same S3 bucket.

Each log archive filters for the tag env:$env where $env is the environment/account name (ie sbx, prd, tools, etc), as well as any tags identified in the additional_tags key. The catchall archive, as the name implies, filters for '*'.

A second bucket is created for cloudtrail, and a cloudtrail is configured to monitor the log archive bucket and log activity to the cloudtrail bucket. To forward these cloudtrail logs to datadog, the cloudtrail bucket's id must be added to the s3_buckets key for our datadog-lambda-forwarder component.

Both buckets support object lock, with overridable defaults of COMPLIANCE mode with a duration of 7 days.

Prerequisites

• Datadog integration set up in target environment
  • We rely on the datadog api and app keys added by our datadog integration component

Issues, Gotchas, Good-to-Knows

Destroy/reprovision process

Because of the protections for S3 buckets, if we want to destroy/replace our bucket, we need to do so in two passes or destroy the bucket manually and then use terraform to clean up the rest. If reprovisioning a recently provisioned bucket, the two-pass process works well. If the bucket has a full day or more of logs, though, deleting it manually first will avoid terraform timeouts, and then the terraform process can be used to clean up everything else.

Two step process to destroy via terraform

• first set s3_force_destroy var to true and apply
• next set enabled to false and apply or use tf destroy

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 from which Datadog receives logs.

components:
  terraform:
    datadog-logs-archive:
      settings:
        spacelift:
          workspace_enabled: true
      vars:
        enabled: true
  #       additional_query_tags:
  #         - "forwardername:*-dev-datadog-lambda-forwarder-logs"
  #         - "account:123456789012"

Requirements

Name	Version
terraform	>= 0.13.0
aws	>= 2.0
datadog	>= 3.3.0
local	>= 1.3

Providers

Name	Version
aws	>= 2.0
datadog	>= 3.7.0
http	>= 2.1.0

Modules

Name	Source	Version
cloudtrail	cloudposse/cloudtrail/aws	0.21.0
cloudtrail_s3_bucket	cloudposse/cloudtrail-s3-bucket/aws	0.23.1
iam_roles	../account-map/modules/iam-roles	n/a
s3_bucket	cloudposse/s3-bucket/aws	0.46.0
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_caller_identity.current	data source
aws_partition.current	data source
aws_ssm_parameter.datadog_api_key	data source
aws_ssm_parameter.datadog_app_key	data source
aws_ssm_parameter.datadog_aws_role_name	data source
aws_ssm_parameter.datadog_external_id	data source
datadog_logs_archive.catchall_archive	resource
datadog_logs_archive.logs_archive	resource
http.current_order	data source

Inputs

Name	Description	Type	Default	Required
additional_query_tags	Additional tags to include in query for logs for this archive	list	[]	no
catchall	Set to true to enable a catchall for logs unmatched by any queries. This should only be used in one environment/account	bool	false	no
datadog_aws_account_id	The AWS account ID Datadog's integration servers use for all integrations	string	464622532012	no
enable_glacier_transition	Enable/disable transition to glacier. Has no effect unless lifecycle_rules_enabled set to true	bool	true	no
glacier_transition_days	Number of days after which to transition objects to glacier storage	number	365	no
lifecycle_rules_enabled	Enable/disable lifecycle management rules for s3 objects	bool	true	no
object_lock_days_archive	Set duration of archive bucket object lock	number	7	yes
object_lock_days_cloudtrail	Set duration of cloudtrail bucket object lock	number	7	yes
object_lock_mode_archive	Set mode of archive bucket object lock	string	COMPLIANCE	yes
object_lock_mode_cloudtrail	Set mode of cloudtrail bucket object lock	string	COMPLIANCE	yes
s3_force_destroy	Set to true to delete non-empty buckets when enabled is set to false	bool	false	for destroy only

Outputs

Name	Description
archive_id	The ID of the environment-specific log archive
bucket_arn	The ARN of the bucket used for log archive storage
bucket_domain_name	The FQDN of the bucket used for log archive storage
bucket_id	The ID (name) of the bucket used for log archive storage
bucket_region	The region of the bucket used for log archive storage
cloudtrail_bucket_arn	The ARN of the bucket used for cloudtrail log storage
cloudtrail_bucket_domain_name	The FQDN of the bucket used for cloudtrail log storage
cloudtrail_bucket_id	The ID (name) of the bucket used for cloudtrail log storage
catchall_id	The ID of the catchall log archive

References

• cloudposse/s3-bucket/aws - Cloud Posse's S3 component
• [datadog_logs_archive resource] (https://registry.terraform.io/providers/DataDog/datadog/latest/docs/resources/logs_archive) - Datadog's provider documentation for the datadog_logs_archive resource

---

Note

This project is part of Cloud Posse's comprehensive "SweetOps" approach towards DevOps.

Learn More

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

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.

1. Review our Code of Conduct and Contributor Guidelines.
2. Fork the repo on GitHub
3. Clone the project to your own machine
4. Commit changes to your own branch
5. Push your work back up to your fork
6. 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

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 Cloud Posse, LLC.

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.

📚 See What's Included

• 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.

License

Preamble to the Apache License, Version 2.0

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.

Copyright © 2017-2024 Cloud Posse, LLC

Requirements

Name	Version
terraform	>= 0.13.0
aws	>= 4.9.0
datadog	>= 3.19
http	>= 2.1.0

Providers

Name	Version
aws	>= 4.9.0
datadog	>= 3.19
http	>= 2.1.0

Modules

Name	Source	Version
archive_bucket	cloudposse/s3-bucket/aws	3.1.2
bucket_policy	cloudposse/iam-policy/aws	1.0.1
cloudtrail	cloudposse/cloudtrail/aws	0.21.0
cloudtrail_s3_bucket	cloudposse/s3-bucket/aws	3.1.2
datadog_configuration	../datadog-configuration/modules/datadog_keys	n/a
iam_roles	../account-map/modules/iam-roles	n/a
this	cloudposse/label/null	0.25.0

Resources

Name	Type
datadog_logs_archive.catchall_archive	resource
datadog_logs_archive.logs_archive	resource
datadog_logs_archive_order.archive_order	resource
aws_caller_identity.current	data source
aws_iam_policy_document.default	data source
aws_partition.current	data source
aws_ssm_parameter.datadog_aws_role_name	data source
http_http.current_order	data source

Inputs

Name	Description	Type	Default	Required
additional_query_tags	Additional tags to be used in the query for this archive	list(any)	[]	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
catchall_enabled	Set to true to enable a catchall for logs unmatched by any queries. This should only be used in one environment/account	bool	false	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
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
enable_glacier_transition	Enable/disable transition to glacier for log archive bucket. Has no effect unless lifecycle_rules_enabled set to true	bool	true	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
glacier_transition_days	Number of days after which to transition objects to glacier storage in log archive bucket	number	365	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
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
lifecycle_rules_enabled	Enable/disable lifecycle management rules for log archive s3 objects	bool	true	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
object_lock_days_archive	Object lock duration for archive buckets in days	number	7	no
object_lock_days_cloudtrail	Object lock duration for cloudtrail buckets in days	number	7	no
object_lock_mode_archive	Object lock mode for archive bucket. Possible values are COMPLIANCE or GOVERNANCE	string	"COMPLIANCE"	no
object_lock_mode_cloudtrail	Object lock mode for cloudtrail bucket. Possible values are COMPLIANCE or GOVERNANCE	string	"COMPLIANCE"	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
s3_force_destroy	Set to true to delete non-empty buckets when enabled is set to false	bool	false	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
archive_id	The ID of the environment-specific log archive
bucket_arn	The ARN of the bucket used for log archive storage
bucket_domain_name	The FQDN of the bucket used for log archive storage
bucket_id	The ID (name) of the bucket used for log archive storage
bucket_region	The region of the bucket used for log archive storage
catchall_id	The ID of the catchall log archive
cloudtrail_bucket_arn	The ARN of the bucket used for access logging via cloudtrail
cloudtrail_bucket_domain_name	The FQDN of the bucket used for access logging via cloudtrail
cloudtrail_bucket_id	The ID (name) of the bucket used for access logging via cloudtrail