Update to required versions of agents or Amazon EKS add-on - Amazon CloudWatch
Update the Amazon CloudWatch Observability EKS add-onUpdate the CloudWatch agent and ADOT agent
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Update to required versions of agents or Amazon EKS add-on

After August 9, 2024, CloudWatch Application Signals will no longer support older versions of the Amazon CloudWatch Observability EKS add-on, the CloudWatch agent, and the Amazon Distro for OpenTelemetry auto-instrumentation agent.

  • For the Amazon CloudWatch Observability EKS add-on, versions older than v1.7.0-eksbuild.1 won't be supported.

  • For the CloudWatch agent, versions older than 1.300040.0 won't be supported.

  • For the Amazon Distro for OpenTelemetry auto-instrumentation agent:

    • For Java, versions older than 1.32.2 won't be supported.

    • For Python, versions older than 0.2.0 won't be supported.

Important

The latest versions of the agents include updates to the Application Signals metric schema. These updates are not backward compatible, and this can result in data issues if incompatible versions are used. To help ensure a seamless transition to the new functionality, do the following:

  • If your application is running on Amazon EKS, be sure to restart all your instrumented applications after you update the Amazon CloudWatchObservability add-on.

  • For applications running on other platforms, be sure to upgrade both the CloudWatch agent and the Amazon OpenTelemetry auto-instrumentation agent to the latest versions.

The instructions in the following sections can help you update to a supported version.

Update the Amazon CloudWatch Observability EKS add-on

To the Amazon CloudWatch Observability EKS add-on, you can use the Amazon Web Services Management Console or the Amazon CLI.

Use the console

To upgrade the add-on using the console

  1. Open the Amazon EKS console at https://console.amazonaws.cn/eks/home#/clusters.

  2. Choose the name of the Amazon EKS cluster to update.

  3. Choose the Add-ons tab, then choose Amazon CloudWatch Observability.

  4. Choose Edit, select the version you want to update to, and then choose Save changes.

    Be sure to choose v1.7.0-eksbuild.1 or later.

  5. Enter one of the following Amazon CLI commands to restart your services.

      # Restart a deployment
  kubectl rollout restart deployment/name
  # Restart a daemonset
  kubectl rollout restart daemonset/name
  # Restart a statefulset
  kubectl rollout restart statefulset/name

Use the Amazon CLI

To upgrade the add-on using the Amazon CLI

  1. Enter the following command to find the latest version.

    aws eks describe-addon-versions \
--addon-name amazon-cloudwatch-observability

  2. Enter the following command to update the add-on. Replace $VERSION with a version that is v1.7.0-eksbuild.1 or later. Replace $AWS_REGION and $CLUSTER with your Region and cluster name.

    aws eks update-addon \
--region $AWS_REGION \
--cluster-name $CLUSTER \
--addon-name amazon-cloudwatch-observability \
--addon-version $VERSION \
# required only if the advanced configuration is used.
--configuration-values $JSON_CONFIG
    Note

    If you're using an custom configuration for the add-on, you can find an example of the configuration to use for $JSON_CONFIG in Enable CloudWatch Application Signals.

  3. Enter one of the following Amazon CLI commands to restart your services.

      # Restart a deployment
  kubectl rollout restart deployment/name
  # Restart a daemonset
  kubectl rollout restart daemonset/name
  # Restart a statefulset
  kubectl rollout restart statefulset/name

Update the CloudWatch agent and ADOT agent

If your services are running on architectures other than Amazon EKS, you will need to upgrade both the CloudWatch agent and the ADOT auto-instrumentation agent to use the latest Application Signals features.

Update on Amazon ECS

To upgrade your agents for services running on Amazon ECS

  1. Create a new task definition revision. For more information, see Updating a task definition using the console.

  2. Replace the $IMAGE of the ecs-cwagent container with the latest image tag from cloudwatch-agent on Amazon ECR.

    If you upgrade to a fixed version, be sure to use a version equal to or later than 1.300040.0.

  3. Replace the $IMAGE of the init container with the latest image tag from the following locations:

  4. Update the Application Signals environment variables in your app container by following the instructions at Step 4: Instrument your application with the CloudWatch agent.

  5. Deploy your service with the new task definition.

Update on Amazon EC2 or other architectures

To upgrade your agents for services running on Amazon EC2 or other architectures

  1. Follow the instructions at Download the CloudWatch agent package and upgrade the CloudWatch agent to the latest version. Be sure to select version 1.300040.0 or later.

  2. Download the latest version of the Amazon Distro for OpenTelemetry auto-instrumentation agent from one of the following locations:

  3. Apply the updated Application Signals environment variables to your application, then start your application. For more information, see Step 3: Instrument your application and start it.