feat: expose docker label config for datadog agent

Author: Mathew-Estafanous

examples/ecs_fargate/main.tf

@@ -13,11 +13,14 @@ module "datadog_ecs_fargate_task" {
   # Configure Datadog
   dd_api_key                       = var.dd_api_key
   dd_site                          = var.dd_site
-  dd_service                       = var.dd_service
   dd_tags                          = "team:cont-p, owner:container-monitoring"
   dd_essential                     = true
   dd_is_datadog_dependency_enabled = true
 
+  dd_service = "test-service"
+  dd_env     = "test"
+  dd_version = "1.2.3"
+
   dd_environment = [
     {
       name  = "DD_CUSTOM_FEATURE",

modules/ecs_fargate/datadog.tf

@@ -310,6 +310,11 @@ locals {
     local.dd_environment,
   )
 
+  dd_agent_docker_labels = merge(
+    local.ust_docker_labels,
+    var.dd_docker_labels,
+  )
+
   # Datadog Agent container definition
   dd_agent_container = [
     merge(
@@ -318,7 +323,7 @@ locals {
         image        = "${var.dd_registry}:${var.dd_image_version}"
         essential    = var.dd_essential
         environment  = local.dd_agent_env
-        dockerLabels = local.ust_docker_labels
+        dockerLabels = local.dd_agent_docker_labels
         cpu          = var.dd_cpu
         memory       = var.dd_memory_limit_mib
         secrets = var.dd_api_key_secret != null ? [
@@ -386,7 +391,7 @@ locals {
         user             = "0"
         mountPoints      = var.dd_log_collection.fluentbit_config.mountPoints
         environment      = local.dd_log_agent_env
-        dockerLabels     = local.ust_docker_labels
+        dockerLabels     = local.dd_agent_docker_labels
         portMappings     = []
         systemControls   = []
         volumesFrom      = []
@@ -417,7 +422,7 @@ locals {
       command          = ["/cws-instrumentation", "setup", "--cws-volume-mount", "/cws-instrumentation-volume"]
       mountPoints      = local.cws_mount
       environment      = local.ust_env_vars
-      dockerLabels     = local.ust_docker_labels
+      dockerLabels     = local.dd_agent_docker_labels
       portMappings     = []
       systemControls   = []
       volumesFrom      = []

modules/ecs_fargate/variables.tf

@@ -96,6 +96,12 @@ variable "dd_environment" {
   nullable    = false
 }
 
+variable "dd_docker_labels" {
+  description = "Datadog Agent container docker labels"
+  type        = map(map(string))
+  default     = {}
+}
+
 variable "dd_tags" {
   description = "Datadog Agent global tags (eg. `key1:value1, key2:value2`)"
   type        = string

smoke_tests/ecs_fargate/ust-docker-labels.tf

@@ -29,6 +29,10 @@ module "dd_task_ust_docker_labels" {
     enabled = true,
   }
 
+  dd_docker_labels = {
+    "com.datadoghq.tags.service" : "docker-agent-service",
+  }
+
   # Configure Task Definition with multiple containers
   family = "${var.test_prefix}-ust-docker-labels"
   container_definitions = jsonencode([
@@ -42,7 +46,7 @@ module "dd_task_ust_docker_labels" {
       image     = "nginx:latest",
       essential = false,
       dockerLabels = {
-        "com.datadoghq.tags.service" : "different_name",
+        "com.datadoghq.tags.service" : "overwritten_name",
         "custom.label" = "custom-value"
       }
     }

tests/ust_docker_labels_test.go

@@ -38,7 +38,10 @@ func (s *ECSFargateSuite) TestUSTDockerLabels() {
 	s.True(found, "Container dummy-app not found in definitions")
 	AssertDockerLabels(s.T(), dummyApp, expectedUSTLabels)
 
+	// Expect UST docker labels to be present on all Datadog containers with
+	// overwritten labels when UST docker labels are specified.
 	datadogContainers := []string{"datadog-agent", "datadog-log-router", "cws-instrumentation-init"}
+	expectedUSTLabels["com.datadoghq.tags.service"] = "docker-agent-service"
 	for _, containerName := range datadogContainers {
 		container, found := GetContainer(containers, containerName)
 		s.True(found, "Container %s not found in definitions", containerName)