datadog-logs-archive

This component provisions 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 (e.g. sbx, prd, tools), as well as any tags identified in the additional_query_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 and a duration of 7 days.

Prerequisites

Datadog integration set up in the target environment
- Relies 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, destroying/replacing the bucket may require two passes or a manual bucket delete followed by Terraform cleanup. If the bucket has a full day or more of logs, deleting it manually first helps avoid Terraform timeouts.
- Two-step process to destroy via Terraform:
  1. Set s3_force_destroy to true and apply
  2. Set enabled to false and apply, or run terraform destroy

Sponsorship

This project is supported by the Datadog Open Source Program.

As part of this collaboration, Datadog provides a dedicated sandbox account that we use for automated integration and acceptance testing. This contribution allows us to continuously validate changes against a real Datadog environment, improving reliability and reducing the risk of regressions.

We are grateful to Datadog for supporting our open source ecosystem and helping ensure that infrastructure code for Terraform remains stable and well-tested

Usage

Stack Level: Global

It's suggested to apply this component to all accounts from which Datadog receives logs.

Example Atmos snippet:

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

Variables

Required Variables

query_override (string) required: Override query for datadog archive. If null would be used query 'env:{stage} OR account:{aws account id} OR {additional_query_tags}'
region (string) required: AWS Region

Optional Variables

additional_query_tags (list(any)) optional

Additional tags to be used in the query for this archive

Default value: [ ]

archive_lifecycle_config optional

Lifecycle configuration for the archive S3 bucket

Type:

object({
abort_incomplete_multipart_upload_days         = optional(number, null)
enable_glacier_transition                      = optional(bool, true)
glacier_transition_days                        = optional(number, 365)
noncurrent_version_glacier_transition_days     = optional(number, 30)
enable_deeparchive_transition                  = optional(bool, false)
deeparchive_transition_days                    = optional(number, 0)
noncurrent_version_deeparchive_transition_days = optional(number, 0)
enable_standard_ia_transition                  = optional(bool, false)
standard_transition_days                       = optional(number, 0)
expiration_days                                = optional(number, 0)
noncurrent_version_expiration_days             = optional(number, 0)
})

Default value: { }

catchall_enabled (bool) optional

Set to true to enable a catchall for logs unmatched by any queries. This should only be used in one environment/account

Default value: false

cloudtrail_lifecycle_config optional

Lifecycle configuration for the cloudtrail S3 bucket

Type:

object({
abort_incomplete_multipart_upload_days         = optional(number, null)
enable_glacier_transition                      = optional(bool, true)
glacier_transition_days                        = optional(number, 365)
noncurrent_version_glacier_transition_days     = optional(number, 365)
enable_deeparchive_transition                  = optional(bool, false)
deeparchive_transition_days                    = optional(number, 0)
noncurrent_version_deeparchive_transition_days = optional(number, 0)
enable_standard_ia_transition                  = optional(bool, false)
standard_transition_days                       = optional(number, 0)
expiration_days                                = optional(number, 0)
noncurrent_version_expiration_days             = optional(number, 0)
})

Default value: { }

lifecycle_rules_enabled (bool) optional

Enable/disable lifecycle management rules for log archive s3 objects

Default value: true

object_lock_days_archive (number) optional

Object lock duration for archive buckets in days

Default value: 7

object_lock_days_cloudtrail (number) optional

Object lock duration for cloudtrail buckets in days

Default value: 7

object_lock_mode_archive (string) optional

Object lock mode for archive bucket. Possible values are COMPLIANCE or GOVERNANCE

Default value: "COMPLIANCE"

object_lock_mode_cloudtrail (string) optional

Object lock mode for cloudtrail bucket. Possible values are COMPLIANCE or GOVERNANCE

Default value: "COMPLIANCE"

s3_force_destroy (bool) optional

Set to true to delete non-empty buckets when enabled is set to false

Default value: false

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

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

Dependencies

Requirements

terraform, version: >= 0.13.0
aws, version: >= 4.9.0, < 6.0.0
datadog, version: >= 3.19
http, version: >= 2.1.0

Providers

aws, version: >= 4.9.0, < 6.0.0
datadog, version: >= 3.19
http, version: >= 2.1.0

Modules

Name	Version	Source	Description
`archive_bucket`	4.10.0	`cloudposse/s3-bucket/aws`	n/a
`bucket_policy`	2.0.2	`cloudposse/iam-policy/aws`	n/a
`cloudtrail`	0.24.0	`cloudposse/cloudtrail/aws`	n/a
`cloudtrail_label`	0.25.0	`cloudposse/label/null`	n/a
`cloudtrail_s3_bucket`	4.10.0	`cloudposse/s3-bucket/aws`	n/a
`datadog_configuration`	v1.535.11	`github.com/cloudposse-terraform-components/aws-datadog-credentials//src/modules/datadog_keys`	n/a
`iam_roles`	v1.536.0	`github.com/cloudposse-terraform-components/aws-account-map//src/modules/iam-roles`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

datadog_logs_archive.catchall_archive (resource)
datadog_logs_archive.logs_archive (resource)
datadog_logs_archive_order.archive_order (resource)

Data Sources

The following data sources are used by this module:

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)

Sponsorship​

Usage​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Sponsorship

Usage

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources