feat(rds): add Read/Write IOPS metrics to DatabaseInstance and VolumeRead/Write IOPs metrics to DatabaseCluster by jasdeepbhalla · Pull Request #35773 · aws/aws-cdk

jasdeepbhalla · 2025-10-17T22:33:24Z

Issue #35327

Reason for this change

Users cannot easily track ReadIOPs/WriteIOPs at the instance-level and VolumeReadIOPs/VolumeWriteIOPs at the cluster level.

Description of changes

This change adds support for additional Amazon RDS IOPS CloudWatch metrics to improve observability for both database instances and clusters.

New metrics introduced:

DatabaseInstance
- metricReadIOPS()
- metricWriteIOPS()

Instance Level metrics are supported as per these docs

DatabaseCluster
- metricVolumeReadIOPs()
- metricVolumeWriteIOPs()

Cluster Level metrics are supported as per these docs

These metrics align with existing RDS CloudWatch metrics and follow the same conventions as other metric helpers in the CDK.

Changes included

Added new metric helper methods to RDS instance and cluster constructs
Updated RDS README with usage examples
Added unit tests validating metric resolution
Added integration tests to verify metrics can be used to create alarms

Describe any new or updated permissions being added

No new IAM permissions are required, as this change only exposes a CloudWatch metric for monitoring purposes.

Description of how you validated changes

Unit tests added for both instance- and cluster-level metrics
Integration tests added to ensure metrics synthesize correctly and support alarm creation

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.

jasdeepbhalla · 2025-10-31T01:44:09Z

@pahud This PR is ready for review!

…abaseClusterBase

badmintoncryer · 2025-12-15T15:56:30Z

Thank you for your contribution!

ozelalisen

You have merge conflicts too

ozelalisen · 2026-01-08T15:39:49Z

packages/aws-cdk-lib/aws-rds/lib/cluster.ts

+   * Represents the average of the ReadIOPS values across all instances in the cluster.
+   */
+  public metricReadIOPS(props?: cloudwatch.MetricOptions) {
+    return this.metric('ReadIOPS', { statistic: 'Average', ...props });


This metric is not available on cluster level, checking docs here: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.AuroraMonitoring.Metrics.html, could you please move this metric implementation to instance, because this would give an empty metric. For cluster level, we should use VolumeReadIOPs, but I do not see this metric is also available within CDK, so feel free to update this metric as VolumeReadIOPs and add ReadIOPS in instance level metrics.

Thats a good catch @ozelalisen. I have updated the code to add Read/Write IOPS for DB Instance, and Volume Read/Write IOPS for DB Cluster.

…eReadIOPs to DatabaseCluster

Pull request has been modified.

…Read/Write IOPs metrics to DatabaseCluster

ozelalisen

PR Build is failing, you need to update snapshots

ozelalisen · 2026-01-13T14:37:38Z

packages/@aws-cdk-testing/framework-integ/test/aws-rds/test/integ.cluster-volume-iops-metric.ts

+  cdkCommandOptions: {
+    deploy: {
+      args: {
+        rollback: true,
+      },


No need to specify these arguments

ozelalisen · 2026-01-13T14:38:13Z

packages/@aws-cdk-testing/framework-integ/test/aws-rds/test/integ.instance-iops-metric.ts

+  cdkCommandOptions: {
+    deploy: {
+      args: {
+        rollback: true,
+      },
+    },


No need to provide these arguments

ozelalisen · 2026-01-13T14:38:22Z

packages/@aws-cdk-testing/framework-integ/test/aws-rds/test/integ.instance-iops-metric.ts

+
+const app = new cdk.App();
+const stack = new cdk.Stack(app, 'aws-cdk-rds-instance-iops-metric', {
+  terminationProtection: false,


ozelalisen · 2026-01-13T14:38:32Z

packages/@aws-cdk-testing/framework-integ/test/aws-rds/test/integ.cluster-volume-iops-metric.ts

+
+const app = new cdk.App();
+const stack = new cdk.Stack(app, 'aws-cdk-rds-cluster-volume-iops-metric', {
+  terminationProtection: false,


ozelalisen · 2026-01-13T14:43:16Z

packages/@aws-cdk-testing/framework-integ/test/aws-rds/test/integ.instance-iops-metric.ts

+const vpc = new ec2.Vpc(stack, 'VPC', { maxAzs: 2, restrictDefaultSecurityGroup: false });
+
+const instance = new rds.DatabaseInstance(stack, 'Instance', {
+  engine: rds.DatabaseInstanceEngine.postgres({ version: rds.PostgresEngineVersion.VER_16 }),


please upgrade the version

ozelalisen · 2026-01-13T14:43:29Z

packages/@aws-cdk-testing/framework-integ/test/aws-rds/test/integ.instance-iops-metric.ts

+  engine: rds.DatabaseInstanceEngine.postgres({ version: rds.PostgresEngineVersion.VER_16 }),
+  vpc,
+  multiAz: false,
+  publiclyAccessible: true,


…abaseClusterBase

Pull request has been modified.

…Read/Write IOPs metrics to DatabaseCluster

aws-cdk-automation

(This review is outdated)

ozelalisen

You should add snapshots for integ tests, build is failing due to that

…Read/Write IOPs metrics to DatabaseCluster

jasdeepbhalla · 2026-01-14T10:48:40Z

@ozelalisen Added the integration tests, this PR is ready for review.

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

ozelalisen

Have some final comments regarding instance level metric configuration, see reference: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/appinsights-metrics-rds.html

ozelalisen · 2026-01-14T16:24:08Z

packages/aws-cdk-lib/aws-rds/lib/instance.ts

+   * @default - average over 5 minutes
+   */
+  public metricReadIOPs(props?: cloudwatch.MetricOptions) {
+    return this.metric('ReadIOPs', { statistic: 'Average', ...props });


This should be ReadIOPS, all capital, this will return empty CW metric

Suggested change

return this.metric('ReadIOPs', { statistic: 'Average', ...props });

return this.metric('ReadIOPS', { statistic: 'Average', ...props });

Sorry for my other comment regarding Aurora restriction, for instance level this is supported for all, let's remove incorrect doc above regarding restriction

aah ok, updated 👍

ozelalisen · 2026-01-14T16:24:58Z

packages/aws-cdk-lib/aws-rds/lib/instance.ts

+   * @default - average over 5 minutes
+   */
+  public metricWriteIOPs(props?: cloudwatch.MetricOptions) {
+    return this.metric('WriteIOPs', { statistic: 'Average', ...props });


Should be capital

Suggested change

return this.metric('WriteIOPs', { statistic: 'Average', ...props });

return this.metric('WriteIOPS', { statistic: 'Average', ...props });

Sorry for my other comment regarding Aurora restriction, for instance level this is supported for all, let's remove incorrect doc above regarding restriction

aah ok, updated 👍

…Read/Write IOPs metrics to DatabaseCluster

Pull request has been modified.

…abaseClusterBase

ozelalisen

LGTM, thanks for addressing all comments!

mergify · 2026-01-15T09:53:16Z

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).

…abaseClusterBase

mergify · 2026-01-15T09:53:25Z

mergify · 2026-01-15T10:35:10Z

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-01-15T10:35:26Z

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.

github-actions bot added the effort/medium Medium work item – several days of effort label Oct 17, 2025

aws-cdk-automation requested a review from a team October 17, 2025 22:33

github-actions bot added feature-request A feature should be added or improved. p2 beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK labels Oct 17, 2025

aws-cdk-automation previously requested changes Oct 17, 2025

View reviewed changes

jasdeepbhalla changed the title ~~feat(aws-rds): add metricReadIOPs method to DatabaseClusterBase~~ feat(rds): add metricReadIOPs method to DatabaseClusterBase Oct 17, 2025

jasdeepbhalla mentioned this pull request Oct 18, 2025

aws-rds: add metricReadIOPs method to DatabaseClusterFromSnapshot #35327

Closed

2 tasks

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

Monthly PR metrics report #35917

Open

This was referenced Nov 13, 2025

docs(contributing): add section explaining PR review process #36044

Open

Failed CodeBuild CI - 26 PR(s) need attention pahud/aws-cdk#14

Merged

Failed CodeBuild CI - 33 PR(s) pahud/aws-cdk#17

Open

jbhalla-godaddy and others added 5 commits November 17, 2025 12:30

feat(aws-rds): add metricReadIOPs method to DatabaseClusterBase

aee9f56

feat(rds): add metricReadIOPs method to DatabaseClusterBase

e854511

feat(rds): add metricReadIOPs method to DatabaseClusterBase

7fd06b9

feat(rds): add metricReadIOPs method to DatabaseClusterBase

c737570

feat(rds): add metricReadIOPs method to DatabaseClusterBase

31788ad

jasdeepbhalla force-pushed the issue_35327_add_metricReadIOPs_method_to_DatabaseClusterBase branch from 38157e0 to 31788ad Compare November 17, 2025 20:31

Merge branch 'main' into issue_35327_add_metricReadIOPs_method_to_Dat…

340df89

…abaseClusterBase

pahud mentioned this pull request Nov 17, 2025

CI Pending Approval - 43 PR(s) pahud/aws-cdk#11

Open

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

pahud mentioned this pull request Dec 3, 2025

PRs with Conflicts - 12 PR(s) pahud/aws-cdk#13

Open

badmintoncryer approved these changes Dec 15, 2025

View reviewed changes

ozelalisen previously requested changes Jan 8, 2026

View reviewed changes

ozelalisen self-assigned this Jan 8, 2026

jasdeepbhalla changed the title ~~feat(rds): add metricReadIOPs method to DatabaseClusterBase~~ feat(rds): add metric: ReadIOPS to DatabaseInstance and metric: VolumeReadIOPs to DatabaseCluster Jan 9, 2026

feat(rds): add metric: ReadIOPS to DatabaseInstance and metric: Volum…

f90c0be

…eReadIOPs to DatabaseCluster

feat(rds): add Read/Write IOPS metrics to DatabaseInstance and Volume…

556a7a2

…Read/Write IOPs metrics to DatabaseCluster

ozelalisen previously requested changes Jan 13, 2026

View reviewed changes

Merge branch 'main' into issue_35327_add_metricReadIOPs_method_to_Dat…

ece8375

…abaseClusterBase

feat(rds): add Read/Write IOPS metrics to DatabaseInstance and Volume…

c610a76

…Read/Write IOPs metrics to DatabaseCluster

aws-cdk-automation previously requested changes Jan 13, 2026

View reviewed changes

ozelalisen requested changes Jan 14, 2026

View reviewed changes

feat(rds): add Read/Write IOPS metrics to DatabaseInstance and Volume…

16f6a08

…Read/Write IOPs metrics to DatabaseCluster

ozelalisen added the pr/needs-integration-tests-deployment Requires the PR to deploy the integration test snapshots. label Jan 14, 2026

ozelalisen temporarily deployed to deployment-integ-test January 14, 2026 10:52 — with GitHub Actions Inactive

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

ozelalisen previously requested changes Jan 14, 2026

View reviewed changes

jasdeepbhalla force-pushed the issue_35327_add_metricReadIOPs_method_to_DatabaseClusterBase branch from 0655cb5 to 6fb924e Compare January 14, 2026 20:06

jasdeepbhalla had a problem deploying to deployment-integ-test January 14, 2026 20:06 — with GitHub Actions Error

feat(rds): add Read/Write IOPS metrics to DatabaseInstance and Volume…

6fb924e

…Read/Write IOPs metrics to DatabaseCluster

jasdeepbhalla had a problem deploying to deployment-integ-test January 14, 2026 20:07 — with GitHub Actions Error

Merge branch 'main' into issue_35327_add_metricReadIOPs_method_to_Dat…

796ce62

…abaseClusterBase

ozelalisen removed the pr/needs-integration-tests-deployment Requires the PR to deploy the integration test snapshots. label Jan 15, 2026

ozelalisen approved these changes Jan 15, 2026

View reviewed changes

Merge branch 'main' into issue_35327_add_metricReadIOPs_method_to_Dat…

a95ed2e

…abaseClusterBase

mergify bot merged commit d8e023d into aws:main Jan 15, 2026
22 of 23 checks passed

github-actions bot locked as resolved and limited conversation to collaborators Jan 15, 2026

	return this.metric('ReadIOPs', { statistic: 'Average', ...props });
	return this.metric('ReadIOPS', { statistic: 'Average', ...props });

	return this.metric('WriteIOPs', { statistic: 'Average', ...props });
	return this.metric('WriteIOPS', { statistic: 'Average', ...props });

Conversation

jasdeepbhalla commented Oct 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue #35327

Reason for this change

Description of changes

Changes included

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!

jasdeepbhalla commented Oct 31, 2025

Uh oh!

badmintoncryer commented Dec 15, 2025

Uh oh!

ozelalisen left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ozelalisen left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

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!

ozelalisen left a comment

Choose a reason for hiding this comment

Uh oh!

jasdeepbhalla commented Jan 14, 2026

Uh oh!

ozelalisen left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ozelalisen left a comment

Choose a reason for hiding this comment

Uh oh!

mergify bot commented Jan 15, 2026

Uh oh!

mergify bot commented Jan 15, 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 Jan 15, 2026

Uh oh!

Uh oh!

github-actions bot commented Jan 15, 2026

Uh oh!

Reviewers

jasdeepbhalla commented Oct 17, 2025 •

edited

Loading

aws-cdk-automation left a comment •

edited

Loading

aws-cdk-automation left a comment •

edited

Loading

mergify bot commented Jan 15, 2026 •

edited

Loading