Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(ecs): enable Enhanced Observability for Container Insights #32622

Open
wants to merge 23 commits into
base: main
Choose a base branch
from

Conversation

MPOgbourne
Copy link

@MPOgbourne MPOgbourne commented Dec 21, 2024

Issue # (if applicable)

Closes #32618.

Reason for this change

Container Insights with enhanced observability was recently announced and released for ECS. Cloudformation and the L1 CFN construct support setting this at cluster level. This adds the Container Insights with enhanced observability as an option for the existing L2 Cluster construct.

Description of changes

ENHANCED was added to the ContainerInsights enum. A new containerInsightsV2 property was added to the Cluster construct with the type ContainerInsights. The existing containerInsights property was marked as deprecated.

Description of how you validated changes

Unit and Integration tests were added.

Checklist


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@github-actions github-actions bot added effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK labels Dec 21, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team December 21, 2024 06:22
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

@MPOgbourne MPOgbourne changed the title feat(aws-ecs): enable Enhanced Observability for Container Insights feat(ecs): enable Enhanced Observability for Container Insights Dec 21, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review December 21, 2024 06:26

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Dec 21, 2024
Copy link
Contributor

@nmussy nmussy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, mostly nitpicks and additional integration coverage

packages/aws-cdk-lib/aws-ecs/lib/cluster.ts Outdated Show resolved Hide resolved
/**
* The CloudWatch Container Insights configuration for the cluster
*
* @default - Container Insights configuration will not be set for the cluster
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A bit ambiguous, that does not indicate the actual default value. I'm assuming the insights would be disabled?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The default is not entirely straightforward. If no setting is specified, no setting for container insights is set on the cluster, and the container insights setting is inherited from any account level ecs settings. Most likely, container insights would be disabled, but that isn't guaranteed. I updated the default message to " Container Insights will be disabled for this cluster, but this may be overridden by ECS account level settings." If we'd prefer to just just say it's disabled, I'm fine with that as well.

packages/aws-cdk-lib/aws-ecs/lib/cluster.ts Outdated Show resolved Hide resolved
@aws-cdk-automation aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Dec 27, 2024
@MPOgbourne MPOgbourne requested a review from nmussy December 27, 2024 15:16
Copy link
Contributor

@nmussy nmussy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Few more nits, LGTM otherwise thanks 👍

packages/aws-cdk-lib/aws-ecs/lib/cluster.ts Outdated Show resolved Hide resolved
packages/aws-cdk-lib/aws-ecs/README.md Outdated Show resolved Hide resolved
packages/aws-cdk-lib/aws-ecs/lib/cluster.ts Show resolved Hide resolved
@MPOgbourne MPOgbourne requested a review from nmussy December 27, 2024 21:37
Copy link
Contributor

@nmussy nmussy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Thanks for the changes

@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Dec 28, 2024
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 419d2f5
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 pr/needs-maintainer-review This PR needs a review from a Core Team Member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

(aws-ecs): Add support for Container Insights with enhanced observability
3 participants