feat(rds): support Database Insights for Aurora databases #32851

sakurai-ryo · 2025-01-11T11:10:50Z

Issue # (if applicable)

Reason for this change

AWS announces Amazon CloudWatch Database Insights.
https://aws.amazon.com/about-aws/whats-new/2024/12/amazon-cloudwatch-database-insights

Description of changes

Database Insights has two modes: Standard and Advanced.
For Aurora databases, standard mode is enabled by default.
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#aws-resource-rds-dbcluster-return-values

When using advanced mode, you must enable Performance Insights and set its data retention period to 465 days.
https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Database-Insights.html

Describe any new or updated permissions being added

Nothing.

Description of how you validated changes

Unit tests and integ-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

…s-database-insights

codecov · 2025-01-11T11:28:47Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.38%. Comparing base (9317203) to head (9ed3e5e).

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #32851   +/-   ##
=======================================
  Coverage   81.38%   81.38%           
=======================================
  Files         222      222           
  Lines       13695    13695           
  Branches     2412     2412           
=======================================
  Hits        11145    11145           
  Misses       2271     2271           
  Partials      279      279

Flag	Coverage Δ
suite.unit	`81.38% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
packages/aws-cdk	`80.69% <ø> (ø)`
packages/aws-cdk-lib/core	`82.09% <ø> (ø)`

sakurai-ryo · 2025-01-11T11:33:29Z

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

+    }
+
+    // Database Insights is not supported for non-Aurora engines
+    if (props.databaseInsightsMode && !props.engine.engineType.startsWith('aurora')) {


Currently, DatabaseClusterEngine only supports Aurora engines, but AWS::RDS::DBCluster supports standard MySQL and PostgreSQL engines.
Database Insights only supports Aurora engines, so I added validation here, just in case.

#25547

aws-cdk-automation · 2025-01-11T12:37:16Z

AWS CodeBuild CI Report

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

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

lpizzinidev

Thanks 👍 Left comments for minor adjustments

lpizzinidev · 2025-01-11T16:28:07Z

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

    if (enablePerformanceInsights && props.enablePerformanceInsights === false) {
-      throw new Error('`enablePerformanceInsights` disabled, but `performanceInsightRetention` or `performanceInsightEncryptionKey` was set');
+      throw new Error('`enablePerformanceInsights` disabled, but `performanceInsightRetention` or `performanceInsightEncryptionKey` was set, or `databaseInsightsMode` was set to `DatabaseInsightsMode.ADVANCED`');


Suggested change

throw new Error('`enablePerformanceInsights` disabled, but `performanceInsightRetention` or `performanceInsightEncryptionKey` was set, or `databaseInsightsMode` was set to `DatabaseInsightsMode.ADVANCED`');

throw new Error('`enablePerformanceInsights` disabled, but `performanceInsightRetention` or `performanceInsightEncryptionKey` was set, or `databaseInsightsMode` was set to \'${DatabaseInsightsMode.ADVANCED}\'`');

Let's use the variable value for clarity.

lpizzinidev · 2025-01-11T16:28:54Z

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

+      && props.performanceInsightRetention
+      && props.performanceInsightRetention !== PerformanceInsightRetention.MONTHS_15
+    ) {
+      throw new Error('`performanceInsightRetention` must be set to PerformanceInsightRetention.MONTHS_15 when `databaseInsightsMode` is set to DatabaseInsightsMode.ADVANCED');


Suggested change

throw new Error('`performanceInsightRetention` must be set to PerformanceInsightRetention.MONTHS_15 when `databaseInsightsMode` is set to DatabaseInsightsMode.ADVANCED');

throw new Error('`performanceInsightRetention` must be set to \'${PerformanceInsightRetention.MONTHS_15}\' when `databaseInsightsMode` is set to \'${DatabaseInsightsMode.ADVANCED}\'');

Same as above.

lpizzinidev · 2025-01-11T16:42:08Z

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

+   *
+   * In advanced mode, Performance Insights must be enabled.


Suggested change

*

* In advanced mode, Performance Insights must be enabled.

The current implementation is enabling insights automatically when DatabaseInsightsMode.ADVANCED

lpizzinidev · 2025-01-11T16:43:53Z

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

+   * @default - 7(PerformanceInsightRetention.DEFAULT) if `enablePerformanceInsights` is set,
+   * 465(PerformanceInsightRetention.MONTHS_15) if DatabaseInsightsMode.ADVANCED is set for `databaseInsightsMode`.


Suggested change

* @default - 7(PerformanceInsightRetention.DEFAULT) if `enablePerformanceInsights` is set,

* 465(PerformanceInsightRetention.MONTHS_15) if DatabaseInsightsMode.ADVANCED is set for `databaseInsightsMode`.

* @default - 7 days if `enablePerformanceInsights` is set. 465 days (15 months) if `databaseInsightsMode` is set to DatabaseInsightsMode.ADVANCED.

lpizzinidev · 2025-01-11T16:46:11Z

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

+      throw new Error('`enablePerformanceInsights` disabled, but `performanceInsightRetention` or `performanceInsightEncryptionKey` was set, or `databaseInsightsMode` was set to `DatabaseInsightsMode.ADVANCED`');
+    }
+    if (props.databaseInsightsMode === DatabaseInsightsMode.ADVANCED
+      && props.performanceInsightRetention


Not sure about this. Could automatically setting retention to 15 months cause unexpected billing to customers unaware of the longer period? If so, it may be better to enforce performanceInsightRetention being set manually to PerformanceInsightRetention.MONTHS_15.

lpizzinidev · 2025-01-11T16:48:28Z

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

+  /**
+   * The database insights mode.
+   *
+   * @default - DatabaseInsightsMode.STANDARD if Amazon Aurora engine is used, otherwise not set.


Suggested change

* @default - DatabaseInsightsMode.STANDARD if Amazon Aurora engine is used, otherwise not set.

* @default - DatabaseInsightsMode.STANDARD when performance insights are enabled and Amazon Aurora engine is used, otherwise not set.

lpizzinidev · 2025-01-11T16:52:41Z

packages/aws-cdk-lib/aws-rds/README.md

+The standard mode of Database Insights is enabled by default for Aurora databases.
+
+You can enhance the monitoring of your Aurora databases by enabling the advanced mode of Database Insights.
+
+See [AWS docs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Database-Insights.html) for more information about Database Insights.
+
+The following example shows enabling the advanced mode of Database Insights for a clustered database.
+
+```ts
+declare const vpc: ec2.Vpc;
+new rds.DatabaseCluster(this, 'Database', {
+  engine: rds.DatabaseClusterEngine.AURORA,
+  vpc: vpc,
+  // If you enable the advanced mode of Database Insights,
+  // Performance Insights is enabled and the retention period of Performance Insights data is set to 465(15 months).
+  databaseInsightsMode: rds.DatabaseInsightsMode.ADVANCED,
+  writer: rds.ClusterInstance.provisioned('Writer', {
+    instanceType: ec2.InstanceType.of(ec2.InstanceClass.R7G, ec2.InstanceSize.LARGE),
+  }),
+});
+```
+
+Note that settings regarding Database Insights are only possible at the cluster level.
+
+### Supported Engines
+
+Database Insights supports Amazon Aurora MySQL and Amazon Aurora PostgreSQL.


Suggested change

The standard mode of Database Insights is enabled by default for Aurora databases.

You can enhance the monitoring of your Aurora databases by enabling the advanced mode of Database Insights.

See [AWS docs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Database-Insights.html) for more information about Database Insights.

The following example shows enabling the advanced mode of Database Insights for a clustered database.

```ts

declare const vpc: ec2.Vpc;

new rds.DatabaseCluster(this, 'Database', {

engine: rds.DatabaseClusterEngine.AURORA,

vpc: vpc,

// If you enable the advanced mode of Database Insights,

// Performance Insights is enabled and the retention period of Performance Insights data is set to 465(15 months).

databaseInsightsMode: rds.DatabaseInsightsMode.ADVANCED,

writer: rds.ClusterInstance.provisioned('Writer', {

instanceType: ec2.InstanceType.of(ec2.InstanceClass.R7G, ec2.InstanceSize.LARGE),

}),

});

```

Note that settings regarding Database Insights are only possible at the cluster level.

### Supported Engines

Database Insights supports Amazon Aurora MySQL and Amazon Aurora PostgreSQL.

The standard mode of Database Insights is enabled by default for Aurora databases.

You can enhance the monitoring of your Aurora databases by enabling the advanced mode of Database Insights.

To control Database Insights mode, use the `databaseInsightsMode` property:

```ts

declare const vpc: ec2.Vpc;

new rds.DatabaseCluster(this, 'Database', {

engine: rds.DatabaseClusterEngine.AURORA,

vpc: vpc,

// If you enable the advanced mode of Database Insights,

// Performance Insights is enabled and the retention period of Performance Insights data is set to 465(15 months).

databaseInsightsMode: rds.DatabaseInsightsMode.ADVANCED,

writer: rds.ClusterInstance.provisioned('Writer', {

instanceType: ec2.InstanceType.of(ec2.InstanceClass.R7G, ec2.InstanceSize.LARGE),

}),

});

Note: Database Insights are only supported for Amazon Aurora MySQL and Amazon Aurora PostgreSQL clusters.

Visit CloudWatch Database Insights for more details.

Feel free to improve further 👍

sakurai-ryo added 3 commits January 11, 2025 20:07

feat(rds): support Database Insights for Aurora databases

5de141b

Merge branch 'main' of https://github.com/sakurai-ryo/aws-cdk into rd…

629a8b1

…s-database-insights

rm unused import

95dea11

github-actions bot added the star-contributor [Pilot] contributed between 25-49 PRs to the CDK label Jan 11, 2025

aws-cdk-automation requested a review from a team January 11, 2025 11:11

github-actions bot added effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2 labels Jan 11, 2025

sakurai-ryo commented Jan 11, 2025

View reviewed changes

update readme

9ed3e5e

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

lpizzinidev suggested changes Jan 11, 2025

View reviewed changes

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 11, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(rds): support Database Insights for Aurora databases #32851

feat(rds): support Database Insights for Aurora databases #32851

sakurai-ryo commented Jan 11, 2025 •

edited

Loading

codecov bot commented Jan 11, 2025 •

edited

Loading

sakurai-ryo Jan 11, 2025

aws-cdk-automation commented Jan 11, 2025

lpizzinidev left a comment

lpizzinidev Jan 11, 2025

lpizzinidev Jan 11, 2025

lpizzinidev Jan 11, 2025

lpizzinidev Jan 11, 2025

lpizzinidev Jan 11, 2025

lpizzinidev Jan 11, 2025

lpizzinidev Jan 11, 2025

	throw new Error('`enablePerformanceInsights` disabled, but `performanceInsightRetention` or `performanceInsightEncryptionKey` was set, or `databaseInsightsMode` was set to `DatabaseInsightsMode.ADVANCED`');
	throw new Error('`enablePerformanceInsights` disabled, but `performanceInsightRetention` or `performanceInsightEncryptionKey` was set, or `databaseInsightsMode` was set to \'${DatabaseInsightsMode.ADVANCED}\'`');

	throw new Error('`performanceInsightRetention` must be set to PerformanceInsightRetention.MONTHS_15 when `databaseInsightsMode` is set to DatabaseInsightsMode.ADVANCED');
	throw new Error('`performanceInsightRetention` must be set to \'${PerformanceInsightRetention.MONTHS_15}\' when `databaseInsightsMode` is set to \'${DatabaseInsightsMode.ADVANCED}\'');

		* @default - 7(PerformanceInsightRetention.DEFAULT) if `enablePerformanceInsights` is set,
		* 465(PerformanceInsightRetention.MONTHS_15) if DatabaseInsightsMode.ADVANCED is set for `databaseInsightsMode`.

	* @default - 7(PerformanceInsightRetention.DEFAULT) if `enablePerformanceInsights` is set,
	* 465(PerformanceInsightRetention.MONTHS_15) if DatabaseInsightsMode.ADVANCED is set for `databaseInsightsMode`.
	* @default - 7 days if `enablePerformanceInsights` is set. 465 days (15 months) if `databaseInsightsMode` is set to DatabaseInsightsMode.ADVANCED.

	* @default - DatabaseInsightsMode.STANDARD if Amazon Aurora engine is used, otherwise not set.
	* @default - DatabaseInsightsMode.STANDARD when performance insights are enabled and Amazon Aurora engine is used, otherwise not set.

feat(rds): support Database Insights for Aurora databases #32851

Are you sure you want to change the base?

feat(rds): support Database Insights for Aurora databases #32851

Conversation

sakurai-ryo commented Jan 11, 2025 • edited Loading

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

codecov bot commented Jan 11, 2025 • edited Loading

Codecov Report

Choose a reason for hiding this comment

aws-cdk-automation commented Jan 11, 2025

AWS CodeBuild CI Report

lpizzinidev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sakurai-ryo commented Jan 11, 2025 •

edited

Loading

codecov bot commented Jan 11, 2025 •

edited

Loading