feat(cloudwatch): add option to show labels on pie chart #34745

Kasra-G · 2025-06-18T05:38:00Z

Issue # (if applicable)

Closes #28929

Reason for this change

Cloudwatch Dashboard console has this option but cdk GraphWidget does not

Description of changes

adds a new optional boolean parameter to GraphWidgetProps called displayLabelsOnChart
- naming obtained from description of the option in the AWS Console
updates aws-cloudwatch README.md with sample usage

Describe any new or updated permissions being added

N/A

Description of how you validated changes

Created new unit and integration test and ran them

Checklist

My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

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

aws-cdk-automation

(This review is outdated)

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

aws-cdk-automation · 2025-06-19T08:44:42Z

AWS CodeBuild CI Report

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

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

vishaalmehrishi · 2025-08-20T10:11:01Z

packages/aws-cdk-lib/aws-cloudwatch/lib/graph.ts

+   *
+   * @default false
+   */
+  readonly displayLabelsOnChart?: boolean;


Since this applies specifically to pie charts, the name can be more specific:

Suggested change

readonly displayLabelsOnChart?: boolean;

readonly displayLabelsOnPieChart?: boolean;

I think this depends on how confident we are that cloudwatch won't add more widgets in the future that have the same option to show labels on the graph. Ideally we would have something like a PieGraph class so we could have props that only make sense for pie charts. I think that would be too big of a change for this feature, though.

I plan on just adding the validation and extra unit test. Please let me know if you disagree, and if we should still move forward with the rename.

I think this depends on how confident we are that cloudwatch won't add more widgets in the future that have the same option to show labels on the graph

I did think about, but I saw the comment above stating that it is for Pie charts only, which is what prompted the suggestion.

I think it's fine to keep the current naming, but let's update the JSdoc to clarify that this only works for Pie charts for now.

packages/aws-cdk-lib/aws-cloudwatch/lib/graph.ts

vishaalmehrishi · 2025-08-20T10:27:48Z

packages/aws-cdk-lib/aws-cloudwatch/test/graphs.test.ts

    }]);
  });

+  test('add displayLabelsOnChart to GraphWidget', () => {


Let's add a test which verifies what happens when the graph type is not a pie chart.

vishaalmehrishi · 2025-08-28T09:55:01Z

Hi @Kasra-G , just checking if you need any further feedback/support to update this PR.

Kasra-G · 2025-08-28T15:42:15Z

Thanks for the check-in. Haven't had a chance to make the changes yet, I do intend on getting that done before the PR gets marked stale

Pull request has been modified.

Kasra-G · 2025-09-01T02:30:44Z

Not sure why request-cli-integ-test is failing, I simply squashed, rebased to tip of mainline, and force pushed. I suppose I could look through my reflog and force push back to the previous version.

Edit: Force pushed back to the previous version and I guess the check is still failing. Not sure what I can do, my guess is that the check itself is broken given I see several other open PRs with the same error

Kasra-G · 2025-09-01T03:20:24Z

@vishaalmehrishi I have made the appropriate changes but for some reason the PR code build is not rerunning and I am getting some file not found error in the request-cli-integ-test/cli-changes workflow, even when I pushed the commit you previously reviewed which had no workflow issues prior. Not sure how I can resolve that.

I noticed my other PR is also not running the PR code build, did that change recently?

Kasra-G · 2025-09-01T03:41:59Z

Seems the issue might be that pr code build only runs for branches targeting v2-release. Any reason why we wouldn't want these builds running for pull requests targeting main?

https://github.com/aws/aws-cdk/blob/main/.github/workflows/codebuild-pr-build.yml#L12-L13

mergify · 2025-09-01T10:45:32Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

mergify · 2025-09-01T11:13:41Z

This pull request has been removed from the queue for the following reason: checks failed.

The merge conditions cannot be satisfied due to failing checks:

You may have to fix your CI before adding the pull request to the queue again.
If you update this pull request, to fix the CI, it will automatically be requeued once the queue conditions match again.
If you think this was a flaky issue instead, you can requeue the pull request, without updating it, by posting a @mergifyio requeue comment.

mergify · 2025-09-01T11:40:50Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

vishaalmehrishi · 2025-09-01T11:49:00Z

@Mergifyio requeue

mergify · 2025-09-01T11:49:07Z

requeue

✅ The queue state of this pull request has been cleaned. It can be re-embarked automatically

mergify · 2025-09-01T11:53:05Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

mergify · 2025-09-01T13:35:43Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

github-actions · 2025-09-01T13:35:58Z

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

aws-cdk-automation requested a review from a team June 18, 2025 05:38

github-actions bot added beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2 labels Jun 18, 2025

aws-cdk-automation previously requested changes Jun 18, 2025

View reviewed changes

Kasra-G changed the title ~~feat(aws-cloudwatch): add option to show labels on pie chart~~ feat(cloudwatch): add option to show labels on pie chart Jun 18, 2025

Kasra-G marked this pull request as ready for review June 18, 2025 05:54

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jun 18, 2025

Kasra-G added 3 commits June 19, 2025 01:13

add option to show labels on pie chart

c4b614a

update readme

cc482e7

fix integ tests

b120954

Kasra-G force-pushed the ft/aws-cloudwatch/labeled-pie branch from f2c794c to b120954 Compare June 19, 2025 08:13

github-actions bot mentioned this pull request Jul 1, 2025

Monthly PR metrics report #34865

Closed

vishaalmehrishi previously requested changes Aug 20, 2025

View reviewed changes

vishaalmehrishi self-assigned this Aug 20, 2025

Kasra-G force-pushed the ft/aws-cloudwatch/labeled-pie branch from b120954 to 94295c3 Compare September 1, 2025 02:24

Kasra-G force-pushed the ft/aws-cloudwatch/labeled-pie branch from 94295c3 to b120954 Compare September 1, 2025 02:33

Kasra-G added 2 commits August 31, 2025 23:09

add validation for when view is not PIE but displayLabelsOnChart is set

03ced87

fix comment

18f673c

Kasra-G requested a review from vishaalmehrishi September 1, 2025 03:21

vishaalmehrishi approved these changes Sep 1, 2025

View reviewed changes

Merge branch 'main' into ft/aws-cloudwatch/labeled-pie

4f17045

aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Sep 1, 2025

Merge branch 'main' into ft/aws-cloudwatch/labeled-pie

256f889

mergify bot merged commit 83f0a61 into aws:main Sep 1, 2025
18 checks passed

github-actions bot locked as resolved and limited conversation to collaborators Sep 1, 2025

Kasra-G deleted the ft/aws-cloudwatch/labeled-pie branch September 2, 2025 03:53

	readonly displayLabelsOnChart?: boolean;
	readonly displayLabelsOnPieChart?: boolean;

feat(cloudwatch): add option to show labels on pie chart #34745

feat(cloudwatch): add option to show labels on pie chart #34745

Uh oh!

Conversation

Kasra-G commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue # (if applicable)

Reason for this change

Description of changes

Describe any new or updated permissions being added

Description of how you validated changes

Checklist

Uh oh!

aws-cdk-automation left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aws-cdk-automation commented Jun 19, 2025

AWS CodeBuild CI Report

Uh oh!

vishaalmehrishi Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

Kasra-G Aug 25, 2025

Choose a reason for hiding this comment

Uh oh!

vishaalmehrishi Aug 25, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

vishaalmehrishi Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

vishaalmehrishi commented Aug 28, 2025

Uh oh!

Kasra-G commented Aug 28, 2025

Uh oh!

Kasra-G commented Sep 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Kasra-G commented Sep 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Kasra-G commented Sep 1, 2025

Uh oh!

mergify bot commented Sep 1, 2025

Uh oh!

mergify bot commented Sep 1, 2025

The merge conditions cannot be satisfied due to failing checks:

Uh oh!

mergify bot commented Sep 1, 2025

Uh oh!

vishaalmehrishi commented Sep 1, 2025

Uh oh!

mergify bot commented Sep 1, 2025

✅ The queue state of this pull request has been cleaned. It can be re-embarked automatically

Uh oh!

mergify bot commented Sep 1, 2025

Uh oh!

mergify bot commented Sep 1, 2025

Uh oh!

Uh oh!

github-actions bot commented Sep 1, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Kasra-G commented Jun 18, 2025 •

edited

Loading

aws-cdk-automation left a comment •

edited

Loading

Kasra-G commented Sep 1, 2025 •

edited

Loading

Kasra-G commented Sep 1, 2025 •

edited

Loading