Skip to content

fix(cloudfront): metrics not including correct region config - #38688

Open
georeeve wants to merge 3 commits into
aws:mainfrom
georeeve:cf-metrics
Open

fix(cloudfront): metrics not including correct region config#38688
georeeve wants to merge 3 commits into
aws:mainfrom
georeeve:cf-metrics

Conversation

@georeeve

Copy link
Copy Markdown
Contributor

Issue # (if applicable)

Closes #19245.

Reason for this change

CDK currently does not include the required Region: 'Global' dimension in the dimensions object for its CloudFront metric() functions. This means the metrics do not work without having to overwrite the dimensions object manually (losing the benefit of the distribution ID being automatically populated).

I have also set the region prop to default to us-east-1, as this is also required. It saves the client from having to specify it manually, although at least that doesn't involve overwriting the object.

https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/programming-cloudwatch-metrics.html#cloudfront-metrics-global-values

Description of changes

Add Region: 'Global' dimension, and region: 'us-east-1' by default to code and tests.

Describe any new or updated permissions being added

Description of how you validated changes

Manual testing and running the test suite

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 repeat-contributor [Pilot] contributed between 3-5 PRs to the CDK bug This issue is a bug. p2 labels Aug 27, 2026
@aws-cdk-automation
aws-cdk-automation requested a review from a team August 27, 2026 22:17

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

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

The pull request linter fails with the following errors:

❌ Fixes must contain a change to an integration test file and the resulting snapshot.

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.

✅ A exemption request has been requested. Please wait for a maintainer's review.

@georeeve
georeeve marked this pull request as ready for review August 28, 2026 07:51
@georeeve

Copy link
Copy Markdown
Contributor Author

Exemption Request - The existing integration tests cover the metrics just fine (and I have updated the snapshots to match the new defaults), just the metrics weren't working on CloudWatch due to the missing region props.

@aws-cdk-automation aws-cdk-automation added the pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. label Aug 28, 2026
@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 Aug 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug This issue is a bug. p2 pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. repeat-contributor [Pilot] contributed between 3-5 PRs to the CDK

Projects

None yet

Development

Successfully merging this pull request may close these issues.

(cloudwatch): CloudFront alarm doesn't reference metrics emitted from the service

2 participants