services.x-monitoring

services:
  serviceA:
    x-monitoring:
      CWAgentCollectEmf: bool|SidecarConfig

Shorthands for monitoring features.

CWAgentCollectEmf

Option that automatically add the CW Agent to the task definition and allow EMF Collection.

The AWS_EMF_AGENT_ENDPOINT environment variable for the other services is automatically set to point to the CW Agent.

A new SSM Parameter is created with the configuration necessary, and exposed to the container as CW_CONFIG_CONTENT

See the AWS CloudWatch agent & EMF Configuration for details of what’s configured under the hood.

boolean value

When set to true|false, enables the sidecar using the latest CloudWatch agent image from AWS ECR Public .

SidecarConfig

This configuration allows you to define more options to control the behaviour of the used sidecar image. You must explicitly set either UseLatest or OverrideImage

x-monitoring:
  CWAgentCollectEmf:
    InterpolateWithDigest: bool
    OverrideImage: str
    UseLatest: bool

Hint

UseLatest is the default behaviour when using a boolean.

OverrideImage

x-monitoring:
  CWAgentCollectEmf:
    InterpolateWithDigest: false
    OverrideImage: public.ecr.aws/cloudwatch-agent/cloudwatch-agent:1.247357.0b252275

Note

We recommend to use the latest image generally speaking

InterpolateWithDigest

Automatically enables attempt to resolve the image digest. Uses the services.x-docker_opts to resolve the digest.

Hint

This setting is recommended if you want to ensure that the image used is going to be consistently the same throughout the lifecycle of your Task Definition revision.

x-monitoring:
  CWAgentCollectEmf:
    InterpolateWithDigest: true
    UseLatest: true