Merge pull request #1955 from alphagov/whi-tw/enable-otel-forms-admin

cadmiumcat · web-flow · commit 08b14c6c807e · 2026-03-16T10:38:41.000Z
Enable OpenTelemetry for Forms Admin service
diff --git a/infra/deployments/forms/forms-admin/main.tf b/infra/deployments/forms/forms-admin/main.tf
@@ -23,6 +23,8 @@ module "forms_admin" {
   previous_auth_provider            = var.forms_admin_settings.previous_auth_provider
   cloudwatch_metrics_enabled        = var.forms_admin_settings.cloudwatch_metrics_enabled
   analytics_enabled                 = var.forms_admin_settings.analytics_enabled
+  enable_opentelemetry              = var.forms_admin_settings.enable_opentelemetry
+  opentelemetry_head_sampler_ratio  = var.forms_runner_settings.opentelemetry_head_sampler_ratio
   act_as_user_enabled               = var.forms_admin_settings.act_as_user_enabled
   welsh_enabled                     = var.forms_admin_settings.welsh_enabled
   org_admin_alerts_enabled          = var.forms_admin_settings.org_admin_alerts_enabled
diff --git a/infra/deployments/forms/inputs.tf b/infra/deployments/forms/inputs.tf
@@ -129,21 +129,23 @@ EOF
 variable "forms_admin_settings" {
   description = "Forms Admin configuration values"
   type = object({
-    cpu                         = number
-    memory                      = number
-    min_capacity                = number
-    max_capacity                = number
-    enable_maintenance_mode     = bool
-    auth_provider               = string
-    previous_auth_provider      = string
-    cloudwatch_metrics_enabled  = bool
-    analytics_enabled           = bool
-    act_as_user_enabled         = bool
-    welsh_enabled               = bool
-    org_admin_alerts_enabled    = bool
-    govuk_app_domain            = string
-    synchronize_to_mailchimp    = bool
-    synchronize_orgs_from_govuk = bool
+    cpu                              = number
+    memory                           = number
+    min_capacity                     = number
+    max_capacity                     = number
+    enable_maintenance_mode          = bool
+    auth_provider                    = string
+    previous_auth_provider           = string
+    cloudwatch_metrics_enabled       = bool
+    analytics_enabled                = bool
+    enable_opentelemetry             = optional(bool, false)
+    opentelemetry_head_sampler_ratio = string
+    act_as_user_enabled              = bool
+    welsh_enabled                    = bool
+    org_admin_alerts_enabled         = bool
+    govuk_app_domain                 = string
+    synchronize_to_mailchimp         = bool
+    synchronize_orgs_from_govuk      = bool
   })
   nullable = false
 }
diff --git a/infra/deployments/forms/tfvars/dev.tfvars b/infra/deployments/forms/tfvars/dev.tfvars
@@ -68,21 +68,23 @@ container_registry      = "711966560482.dkr.ecr.eu-west-2.amazonaws.com"
 dlq_arn                 = "arn:aws:sqs:eu-west-2:711966560482:eventbridge-dead-letter-queue"
 send_logs_to_cyber      = true
 forms_admin_settings = {
-  cpu                         = 256
-  memory                      = 512
-  min_capacity                = 3
-  max_capacity                = 3
-  enable_maintenance_mode     = false
-  auth_provider               = "auth0"
-  previous_auth_provider      = null
-  cloudwatch_metrics_enabled  = true
-  analytics_enabled           = true
-  act_as_user_enabled         = true
-  welsh_enabled               = true
-  org_admin_alerts_enabled    = true
-  govuk_app_domain            = "integration.publishing.service.gov.uk"
-  synchronize_to_mailchimp    = false
-  synchronize_orgs_from_govuk = false
+  cpu                              = 256
+  memory                           = 512
+  min_capacity                     = 3
+  max_capacity                     = 3
+  enable_maintenance_mode          = false
+  auth_provider                    = "auth0"
+  previous_auth_provider           = null
+  cloudwatch_metrics_enabled       = true
+  analytics_enabled                = true
+  enable_opentelemetry             = true
+  opentelemetry_head_sampler_ratio = "0.1"
+  act_as_user_enabled              = true
+  welsh_enabled                    = true
+  org_admin_alerts_enabled         = true
+  govuk_app_domain                 = "integration.publishing.service.gov.uk"
+  synchronize_to_mailchimp         = false
+  synchronize_orgs_from_govuk      = false
 }
 forms_product_page_settings = {
   cpu          = 256
diff --git a/infra/deployments/forms/tfvars/production.tfvars b/infra/deployments/forms/tfvars/production.tfvars
@@ -124,21 +124,23 @@ container_registry      = "711966560482.dkr.ecr.eu-west-2.amazonaws.com"
 dlq_arn                 = "arn:aws:sqs:eu-west-2:711966560482:eventbridge-dead-letter-queue"
 send_logs_to_cyber      = true
 forms_admin_settings = {
-  cpu                         = 512
-  memory                      = 1024
-  min_capacity                = 6
-  max_capacity                = 36
-  enable_maintenance_mode     = false
-  auth_provider               = "auth0"
-  previous_auth_provider      = null
-  cloudwatch_metrics_enabled  = true
-  analytics_enabled           = true
-  act_as_user_enabled         = false
-  welsh_enabled               = true
-  org_admin_alerts_enabled    = false
-  govuk_app_domain            = "publishing.service.gov.uk"
-  synchronize_to_mailchimp    = true
-  synchronize_orgs_from_govuk = true
+  cpu                              = 512
+  memory                           = 1024
+  min_capacity                     = 6
+  max_capacity                     = 36
+  enable_maintenance_mode          = false
+  auth_provider                    = "auth0"
+  previous_auth_provider           = null
+  cloudwatch_metrics_enabled       = true
+  analytics_enabled                = true
+  enable_opentelemetry             = true
+  opentelemetry_head_sampler_ratio = "0.1"
+  act_as_user_enabled              = false
+  welsh_enabled                    = true
+  org_admin_alerts_enabled         = false
+  govuk_app_domain                 = "publishing.service.gov.uk"
+  synchronize_to_mailchimp         = true
+  synchronize_orgs_from_govuk      = true
 }
 forms_product_page_settings = {
   cpu          = 256
diff --git a/infra/deployments/forms/tfvars/staging.tfvars b/infra/deployments/forms/tfvars/staging.tfvars
@@ -33,21 +33,23 @@ container_registry      = "711966560482.dkr.ecr.eu-west-2.amazonaws.com"
 dlq_arn                 = "arn:aws:sqs:eu-west-2:711966560482:eventbridge-dead-letter-queue"
 send_logs_to_cyber      = true
 forms_admin_settings = {
-  cpu                         = 256
-  memory                      = 512
-  min_capacity                = 3
-  max_capacity                = 3
-  enable_maintenance_mode     = false
-  auth_provider               = "auth0"
-  previous_auth_provider      = null
-  cloudwatch_metrics_enabled  = true
-  analytics_enabled           = true
-  act_as_user_enabled         = true
-  welsh_enabled               = true
-  org_admin_alerts_enabled    = true
-  govuk_app_domain            = "staging.publishing.service.gov.uk"
-  synchronize_to_mailchimp    = false
-  synchronize_orgs_from_govuk = false
+  cpu                              = 256
+  memory                           = 512
+  min_capacity                     = 3
+  max_capacity                     = 3
+  enable_maintenance_mode          = false
+  auth_provider                    = "auth0"
+  previous_auth_provider           = null
+  cloudwatch_metrics_enabled       = true
+  analytics_enabled                = true
+  enable_opentelemetry             = false
+  opentelemetry_head_sampler_ratio = "0.1"
+  act_as_user_enabled              = true
+  welsh_enabled                    = true
+  org_admin_alerts_enabled         = true
+  govuk_app_domain                 = "staging.publishing.service.gov.uk"
+  synchronize_to_mailchimp         = false
+  synchronize_orgs_from_govuk      = false
 }
 forms_product_page_settings = {
   cpu          = 256
diff --git a/infra/deployments/forms/tfvars/user-research.tfvars b/infra/deployments/forms/tfvars/user-research.tfvars
@@ -31,21 +31,23 @@ container_registry      = "711966560482.dkr.ecr.eu-west-2.amazonaws.com"
 dlq_arn                 = "arn:aws:sqs:eu-west-2:711966560482:eventbridge-dead-letter-queue"
 send_logs_to_cyber      = true
 forms_admin_settings = {
-  cpu                         = 256
-  memory                      = 512
-  min_capacity                = 0
-  max_capacity                = 0
-  enable_maintenance_mode     = false
-  auth_provider               = "user_research"
-  previous_auth_provider      = null
-  cloudwatch_metrics_enabled  = false
-  analytics_enabled           = false
-  act_as_user_enabled         = false
-  welsh_enabled               = true
-  org_admin_alerts_enabled    = false
-  govuk_app_domain            = ""
-  synchronize_to_mailchimp    = false
-  synchronize_orgs_from_govuk = false
+  cpu                              = 256
+  memory                           = 512
+  min_capacity                     = 0
+  max_capacity                     = 0
+  enable_maintenance_mode          = false
+  auth_provider                    = "user_research"
+  previous_auth_provider           = null
+  cloudwatch_metrics_enabled       = false
+  analytics_enabled                = false
+  enable_opentelemetry             = false
+  opentelemetry_head_sampler_ratio = "0.1"
+  act_as_user_enabled              = false
+  welsh_enabled                    = true
+  org_admin_alerts_enabled         = false
+  govuk_app_domain                 = ""
+  synchronize_to_mailchimp         = false
+  synchronize_orgs_from_govuk      = false
 }
 forms_product_page_settings = {
   cpu          = 256
diff --git a/infra/modules/forms-admin/main.tf b/infra/modules/forms-admin/main.tf
@@ -67,29 +67,31 @@ data "aws_iam_policy_document" "ecs_task_role_permissions" {
 }
 
 module "ecs_service" {
-  source                       = "../ecs-service"
-  env_name                     = var.env_name
-  application                  = "forms-admin"
-  root_domain                  = var.root_domain
-  sub_domain                   = local.sub_domain
-  internal_sub_domain          = local.internal_sub_domain
-  listener_priority            = 301
-  include_domain_root_listener = false
-  image                        = local.image
-  cpu                          = var.cpu
-  memory                       = var.memory
-  readonly_root_filesystem     = true
-  container_port               = 3000
-  permit_internet_egress       = true
-  permit_postgres_egress       = true
-  vpc_id                       = var.vpc_id
-  vpc_cidr_block               = var.vpc_cidr_block
-  private_subnet_ids           = var.private_subnet_ids
-  alb_arn_suffix               = var.alb_arn_suffix
-  alb_listener_arn             = var.alb_listener_arn
-  internal_alb_listener_arn    = var.internal_alb_listener_arn
-  ecs_cluster_arn              = var.ecs_cluster_arn
-  cloudfront_secret            = var.cloudfront_secret
+  source                           = "../ecs-service"
+  env_name                         = var.env_name
+  application                      = "forms-admin"
+  enable_opentelemetry             = var.enable_opentelemetry
+  opentelemetry_head_sampler_ratio = var.opentelemetry_head_sampler_ratio
+  root_domain                      = var.root_domain
+  sub_domain                       = local.sub_domain
+  internal_sub_domain              = local.internal_sub_domain
+  listener_priority                = 301
+  include_domain_root_listener     = false
+  image                            = local.image
+  cpu                              = var.cpu
+  memory                           = var.memory
+  readonly_root_filesystem         = true
+  container_port                   = 3000
+  permit_internet_egress           = true
+  permit_postgres_egress           = true
+  vpc_id                           = var.vpc_id
+  vpc_cidr_block                   = var.vpc_cidr_block
+  private_subnet_ids               = var.private_subnet_ids
+  alb_arn_suffix                   = var.alb_arn_suffix
+  alb_listener_arn                 = var.alb_listener_arn
+  internal_alb_listener_arn        = var.internal_alb_listener_arn
+  ecs_cluster_arn                  = var.ecs_cluster_arn
+  cloudfront_secret                = var.cloudfront_secret
 
   kinesis_subscription_role_arn = var.kinesis_subscription_role_arn
 
diff --git a/infra/modules/forms-admin/variables.tf b/infra/modules/forms-admin/variables.tf
@@ -174,3 +174,15 @@ variable "kinesis_subscription_role_arn" {
   description = "The arn of the role that is allowed to subscribe to the kinesis stream"
   type        = string
 }
+
+variable "enable_opentelemetry" {
+  type        = bool
+  description = "Enable AWS Distro for OpenTelemetry (ADOT) sidecar for distributed tracing to X-Ray"
+  default     = false
+}
+
+variable "opentelemetry_head_sampler_ratio" {
+  type        = string
+  description = "Sampling ratio configuration in OpenTelemetry. This tells the Ruby SDK to sample spans such that only this ratio of traces gets exported. This assumes we are using a `TraceIdRatioBased` sampler. By default all spans are sampled"
+  default     = "1"
+}
