feat(appsync): add EnhancedMetricsConfigProperty for GraphQL api by aki-kii · Pull Request #35328 · aws/aws-cdk

aki-kii · 2025-08-25T17:00:46Z

Issue # (if applicable)

Closes #29933 .

Reason for this change

A property in L1 construct was not in L2 construct.

Description of changes

Add enhancedMetricsConfig property to GraphqlApiProps and set in the CfnGraphQLApi constructor.

The enhanced Metrics Config now includes the operationLevelMetricsEnabled property, which has changed from an enum of "ENABLED" and "DISABLED" to a boolean.
The properties of EnhancedMetricsConfig are not flattened because they interact with each other.
For example, if operationLevelMetricsConfig is enabled, dataSourceLevelMetricsBehavior will default to PER_DATA_SOURCE_METRICS.

Describe any new or updated permissions being added

Description of how you validated changes

Added both unit and integration tests.

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

mazyu36

Thank you for the contribution.
Before reviewing the details, let me confirm.
Don’t we need to add the metricConfig property to Resolver and DataSource?
If the API’s config is set to per-resolver metrics, I think the resolver’s config is also needed.

https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-appsync-datasource.html#cfn-appsync-datasource-metricsconfig

https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-appsync-resolver.html#cfn-appsync-resolver-metricsconfig

mazyu36 · 2025-08-26T13:09:26Z

There’s an existing issue, please associate it.

#29933

badmintoncryer

Thank you for you contribution! I've added some minor comments.

badmintoncryer · 2025-08-26T13:57:13Z

+});
+
+api.addNoneDataSource('NoneDS', {
+  name: cdk.Lazy.string({ produce(): string { return 'NoneDS'; } }),


Why is it necessary to use Lazy here?

@badmintoncryer
Thanks.
Thinking it over again, I found I didn't need to use Lazy.

badmintoncryer · 2025-08-26T13:59:57Z

+  new appsync.GraphqlApi(stack, 'minimal-enhanced-metrics', {
+    name: 'enhanced-metrics',
+    schema: appsync.SchemaFile.fromAsset(path.join(__dirname, 'appsync.test.graphql')),
+    enhancedMetricsConfig: {},


Do other constructs also have arguments where we can pass {} like this?
Personally, I feel that having settings activated as a result of passing {} is not very intuitive.

I found that the appsync.GraphqlApi.logConfig property was passing {}, but I think also passing {} is not very intuitive.

Suggest requiring the dataSourceLevelMetricsBehavior and resolverLevelMetricsBehavior property, because after setting those property the behavior changes.

ex)

EnhancedMetricsConfig { readonly dataSourceLevelMetricsBehavior: DataSourceLevelMetricsBehavior; readonly operationLevelMetricsEnabled?: boolean; readonly resolverLevelMetricsBehavior: ResolverLevelMetricsBehavior; }

Some of the existing arguments can also accept empty objects! In that case, I don’t think it’s a big issue, so please feel free to implement it in whichever way you prefer!

@badmintoncryer
Implemented dataSourceLevelMetricsBehavior and resolverLevelMetricsBehavior as required properties.

aki-kii · 2025-08-26T14:35:21Z

Thank you for the contribution. Before reviewing the details, let me confirm. Don’t we need to add the metricConfig property to Resolver and DataSource? If the API’s config is set to per-resolver metrics, I think the resolver’s config is also needed.

https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-appsync-datasource.html#cfn-appsync-datasource-metricsconfig

https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-appsync-resolver.html#cfn-appsync-resolver-metricsconfig

@mazyu36
Thinking it over again, I believe metricConfig property of DataSource and Resolver are necessary.
I’ll go implement those properties.

aki-kii · 2025-08-26T14:46:57Z

There’s an existing issue, please associate it.

#29933

@mazyu36
Sorry. I've associated the issue.

…s for data source and resolver

…lver

mergify · 2026-03-02T12:10:09Z

Merge Queue Status

Rule: default-squash

✅ Entered queue — 2026-03-02 12:09 UTC
🚫 Left the queue — 2026-03-02 14:49 UTC · at 41cdd9473e6472d0f8f48d0a3b2598f5a96d79b9

This pull request spent 2 hours 39 minutes 49 seconds in the queue, with no time running CI.

Reason

The pull request can't be updated

For security reasons, Mergify can't update this pull request. Try updating locally.
GitHub response: refusing to allow a GitHub App to create or update workflow .github/workflows/close-stale-prs.yml without workflows permission

Hint

You should update or rebase your pull request manually. If you do, this pull request will automatically be requeued once the queue conditions match again.
If you think this was a flaky issue, you can requeue the pull request, without updating it, by posting a @mergifyio queue comment.

Pull request has been modified.

mergify · 2026-03-02T17:36:11Z

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 · 2026-03-02T17:36:16Z

Merge Queue Status

Rule: default-squash

✅ Entered queue — 2026-03-02 17:36 UTC
🚫 Left the queue — 2026-03-02 17:36 UTC · at 609c7fa259d8ad1a82e24daeabc892ff716789d7

This pull request spent 5 seconds in the queue, with no time running CI.

Reason

The pull request can't be updated

For security reasons, Mergify can't update this pull request. Try updating locally.
GitHub response: refusing to allow a GitHub App to create or update workflow .github/workflows/pr-linter.yml without workflows permission

Hint

You should update or rebase your pull request manually. If you do, this pull request will automatically be requeued once the queue conditions match again.
If you think this was a flaky issue, you can requeue the pull request, without updating it, by posting a @mergifyio queue comment.

mergify · 2026-03-03T09:26:58Z

Merge Queue Status

Rule: default-squash

✅ Entered queue — 2026-03-02 17:36 UTC
🚫 Left the queue — 2026-03-02 17:36 UTC · at 609c7fa259d8ad1a82e24daeabc892ff716789d7

This pull request spent 5 seconds in the queue, with no time running CI.

Reason

The pull request can't be updated

For security reasons, Mergify can't update this pull request. Try updating locally.
GitHub response: refusing to allow a GitHub App to create or update workflow .github/workflows/pr-linter.yml without workflows permission

Hint

You should update or rebase your pull request manually. If you do, this pull request will automatically be requeued once the queue conditions match again.
If you think this was a flaky issue, you can requeue the pull request, without updating it, by posting a @mergifyio queue comment.

Pull request has been modified.

mergify · 2026-03-03T10:11: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 · 2026-03-03T10:11:45Z

mergify · 2026-03-03T10:42:12Z

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 · 2026-03-03T10:42:29Z

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.

feat(appsync): add EnhancedMetricsConfigProperty for graphql api

35a239d

github-actions Bot added the p2 label Aug 25, 2025

aws-cdk-automation requested a review from a team August 25, 2025 17:00

github-actions Bot added the beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK label Aug 25, 2025

fix: resolving Rosetta error

d62f669

aki-kii force-pushed the appsync-graphqlapi-enhanced-metrics branch from 6566b24 to d62f669 Compare August 26, 2025 00:31

mazyu36 reviewed Aug 26, 2025

View reviewed changes

badmintoncryer suggested changes Aug 26, 2025

View reviewed changes

github-actions Bot added effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. labels Aug 26, 2025

aki-kii changed the title ~~feat(appsync): add EnhancedMetricsConfigProperty for graphql api~~ feat(appsync): add EnhancedMetricsConfigProperty for graphql api #29933 Aug 26, 2025

aki-kii changed the title ~~feat(appsync): add EnhancedMetricsConfigProperty for graphql api #29933~~ feat(appsync): add EnhancedMetricsConfigProperty for graphql api Aug 26, 2025

aki-kii force-pushed the appsync-graphqlapi-enhanced-metrics branch from a2a41a7 to d8b65ca Compare August 30, 2025 12:44

github-actions Bot mentioned this pull request Sep 1, 2025

Monthly PR metrics report #35377

Closed

aki-kii force-pushed the appsync-graphqlapi-enhanced-metrics branch from d8b65ca to af5940a Compare September 2, 2025 01:35

feat(appsync): implements configuration that utilizes enhanced metric…

4b19182

…s for data source and resolver

aki-kii force-pushed the appsync-graphqlapi-enhanced-metrics branch from af5940a to 4b19182 Compare September 2, 2025 01:38

aki-kii and others added 6 commits September 2, 2025 10:47

feat: Requires enhanced metrics configuration for dataSource and reso…

d79f5b5

…lver

chore: rerun integ test

f6b2dc7

chore: rerun integ test

6f4073d

Merge branch 'main' into appsync-graphqlapi-enhanced-metrics

aba9d2f

fix: update integ test

0a95c10

fix: update README for appsync enhanced metrics

3f4abf1

aki-kii force-pushed the appsync-graphqlapi-enhanced-metrics branch from 02248fb to 3f4abf1 Compare September 4, 2025 17:07

aki-kii added 3 commits September 5, 2025 18:31

Merge branch 'main' into appsync-graphqlapi-enhanced-metrics

f776ac5

Merge branch 'main' into appsync-graphqlapi-enhanced-metrics

8ab2df9

Merge branch 'main' into appsync-graphqlapi-enhanced-metrics

3a50217

kumsmrit removed the pr/needs-integration-tests-deployment Requires the PR to deploy the integration test snapshots. label Mar 2, 2026

kumsmrit temporarily deployed to automation March 2, 2026 14:28 — with GitHub Actions Inactive

Merge branch 'main' into appsync-graphqlapi-enhanced-metrics

609c7fa

kumsmrit temporarily deployed to automation March 2, 2026 16:52 — with GitHub Actions Inactive

kumsmrit previously approved these changes Mar 2, 2026

View reviewed changes

Merge branch 'main' into appsync-graphqlapi-enhanced-metrics

87daa2c

kumsmrit temporarily deployed to automation March 3, 2026 09:26 — with GitHub Actions Inactive

aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Mar 3, 2026

aws-cdk-automation temporarily deployed to automation March 3, 2026 09:57 — with GitHub Actions Inactive

kumsmrit approved these changes Mar 3, 2026

View reviewed changes

Merge branch 'main' into appsync-graphqlapi-enhanced-metrics

06a14a8

mergify Bot temporarily deployed to automation March 3, 2026 10:11 Inactive

mergify Bot merged commit ebfaf89 into aws:main Mar 3, 2026
20 of 21 checks passed

github-actions Bot locked as resolved and limited conversation to collaborators Mar 3, 2026

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Mar 3, 2026

aws-cdk-automation temporarily deployed to automation March 3, 2026 10:43 — with GitHub Actions Inactive

Conversation

aki-kii commented Aug 25, 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!

mazyu36 left a comment

Choose a reason for hiding this comment

Uh oh!

mazyu36 commented Aug 26, 2025

Uh oh!

badmintoncryer left a comment

Choose a reason for hiding this comment

Uh oh!

badmintoncryer Aug 26, 2025

Choose a reason for hiding this comment

Uh oh!

aki-kii Sep 4, 2025 • 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!

badmintoncryer Aug 26, 2025

Choose a reason for hiding this comment

Uh oh!

aki-kii Aug 26, 2025

Choose a reason for hiding this comment

Uh oh!

badmintoncryer Aug 27, 2025

Choose a reason for hiding this comment

Uh oh!

aki-kii Sep 4, 2025 • 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!

aki-kii commented Aug 26, 2025

Uh oh!

aki-kii commented Aug 26, 2025

Uh oh!

mergify Bot commented Mar 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge Queue Status

Reason

Hint

Uh oh!

mergify Bot commented Mar 2, 2026

Uh oh!

mergify Bot commented Mar 2, 2026

Merge Queue Status

Reason

Hint

Uh oh!

mergify Bot commented Mar 3, 2026

Merge Queue Status

Reason

Hint

Uh oh!

mergify Bot commented Mar 3, 2026

Uh oh!

mergify Bot commented Mar 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge Queue Status

Uh oh!

mergify Bot commented Mar 3, 2026

Uh oh!

Uh oh!

github-actions Bot commented Mar 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

aki-kii commented Aug 25, 2025 •

edited

Loading

aki-kii Sep 4, 2025 •

edited

Loading

aki-kii Sep 4, 2025 •

edited

Loading

mergify Bot commented Mar 2, 2026 •

edited

Loading

mergify Bot commented Mar 3, 2026 •

edited

Loading