Version: Latest

ecs-adot-collector

This component deploys the AWS Distro for OpenTelemetry (ADOT) collector as an ECS service. It collects metrics from ECS tasks and forwards them to Amazon Managed Prometheus for visualization in Grafana.

Usage

Stack Level: Regional

This component is the ECS counterpart to the EKS Prometheus scraper/Promtail setup for Grafana monitoring. It runs the ADOT collector as a Fargate task that:

Scrapes Prometheus metrics from ECS services via service discovery
Collects ECS container metrics
Forwards all metrics to Amazon Managed Prometheus

Prerequisites

An ECS cluster deployed via the ecs component
Amazon Managed Prometheus workspace deployed via the managed-prometheus/workspace component
VPC with private subnets

Example Configuration

components:
  terraform:
    ecs-adot-collector:
      vars:
        enabled: true
        name: ecs-adot-collector
        # ADOT collector image
        adot_image: "public.ecr.aws/aws-observability/aws-otel-collector:latest"
        # Task resources
        task_cpu: 256
        task_memory: 512
        desired_count: 1
        # Logging
        log_retention_days: 30
        # Prometheus scraping configuration
        scrape_interval: "30s"
        # ECS service discovery - discover and scrape all ECS tasks
        ecs_service_discovery_enabled: true
        ecs_service_discovery_port: 9090
        # Network configuration
        assign_public_ip: false
        # Dependencies - looked up from current stack
        prometheus_workspace_endpoint: !terraform.state prometheus workspace_endpoint
        ecs_cluster_name: !terraform.state ecs/cluster cluster_name
        vpc_id: !terraform.state vpc vpc_id
        subnet_ids: !terraform.state vpc private_subnet_ids

Custom Scrape Configurations

You can add additional scrape targets beyond ECS service discovery:

vars:
  scrape_configs:
    - job_name: "custom-app"
      targets:
        - "app.internal:9090"
      metrics_path: "/metrics"
      scrape_interval: "15s"

Variables

Required Variables

ecs_cluster_name (string) required: The name of the ECS cluster to deploy the ADOT collector to
prometheus_workspace_endpoint (string) required: The Amazon Managed Prometheus workspace endpoint URL for remote write
region (string) required: AWS Region
subnet_ids (list(string)) required: List of subnet IDs for the ADOT collector task
vpc_id (string) required: VPC ID where the ECS cluster is deployed

Optional Variables

adot_image (string) optional

The ADOT collector container image

Default value: "public.ecr.aws/aws-observability/aws-otel-collector:latest"

assign_public_ip (bool) optional

Assign public IP to the ADOT collector task (set to false for private subnets)

Default value: false

desired_count (number) optional

Number of ADOT collector tasks to run

Default value: 1

ecs_service_discovery_enabled (bool) optional

Enable ECS service discovery for Prometheus scraping

Default value: true

log_retention_days (number) optional

CloudWatch log retention in days

Default value: 30

scrape_configs optional

Additional Prometheus scrape configurations for specific targets

Type:

list(object({
job_name        = string
targets         = list(string)
metrics_path    = optional(string, "/metrics")
scrape_interval = optional(string, "")
}))

Default value: [ ]

scrape_interval (string) optional

Prometheus scrape interval

Default value: "30s"

security_group_ids (list(string)) optional

Additional security group IDs to attach to the ADOT collector task

Default value: [ ]

task_cpu (number) optional

CPU units for the ADOT collector task

Default value: 256

task_memory (number) optional

Memory (MiB) for the ADOT collector task

Default value: 512

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

cloudwatch_log_group_name: The name of the CloudWatch log group for ADOT collector logs
ecs_service_arn: The ARN of the ECS service running the ADOT collector
ecs_service_name: The name of the ECS service running the ADOT collector
id: The ID of this component deployment
security_group_id: The ID of the security group for the ADOT collector
task_definition_arn: The ARN of the ADOT collector task definition
task_execution_role_arn: The ARN of the IAM role used for ECS task execution
task_role_arn: The ARN of the IAM role used by the ADOT collector task

Dependencies

Requirements

terraform, version: >= 1.0.0
aws, version: >= 4.0, < 6.0.0

Providers

aws, version: >= 4.0, < 6.0.0

Modules

Name	Version	Source	Description
`iam_roles`	latest	`../account-map/modules/iam-roles`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

aws_cloudwatch_log_group.adot (resource)
aws_ecs_service.adot (resource)
aws_ecs_task_definition.adot (resource)
aws_iam_role.task (resource)
aws_iam_role.task_execution (resource)
aws_iam_role_policy.ecs_service_discovery (resource)
aws_iam_role_policy_attachment.prometheus_remote_write (resource)
aws_iam_role_policy_attachment.task_execution (resource)
aws_security_group.adot (resource)

Data Sources

The following data sources are used by this module:

Usage​

Prerequisites​

Example Configuration​

Custom Scrape Configurations​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Usage

Prerequisites

Example Configuration

Custom Scrape Configurations

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources