-
Notifications
You must be signed in to change notification settings - Fork 72
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(Aurora): Added support for Serverless Clusters
Added new AuroraCluster Monitoring with Aurora specific metrics/alarms.
- Loading branch information
Showing
14 changed files
with
15,141 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| import { | ||
| ComparisonOperator, | ||
| TreatMissingData, | ||
| } from "aws-cdk-lib/aws-cloudwatch"; | ||
|
|
||
| import { AlarmFactory, CustomAlarmThreshold } from "../../alarm"; | ||
| import { MetricWithAlarmSupport } from "../../metric"; | ||
|
|
||
| export interface HighServerlessDatabaseCapacityThreshold | ||
| extends CustomAlarmThreshold { | ||
| readonly maxServerlessDatabaseCapacity: number; | ||
| } | ||
|
|
||
| export class AuroraAlarmFactory { | ||
| protected readonly alarmFactory: AlarmFactory; | ||
|
|
||
| constructor(alarmFactory: AlarmFactory) { | ||
| this.alarmFactory = alarmFactory; | ||
| } | ||
|
|
||
| addMaxServerlessDatabaseCapacity( | ||
| metric: MetricWithAlarmSupport, | ||
| props: HighServerlessDatabaseCapacityThreshold, | ||
| disambiguator?: string | ||
| ) { | ||
| return this.alarmFactory.addAlarm(metric, { | ||
| treatMissingData: | ||
| props.treatMissingDataOverride ?? TreatMissingData.MISSING, | ||
| comparisonOperator: | ||
| props.comparisonOperatorOverride ?? | ||
| ComparisonOperator.LESS_THAN_THRESHOLD, | ||
| ...props, | ||
| disambiguator, | ||
| threshold: props.maxServerlessDatabaseCapacity, | ||
| alarmNameSuffix: "Serverless-Database-Capacity-High", | ||
| alarmDescription: "Serverless Database Capacity usage is too high.", | ||
| }); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,239 @@ | ||
| import { | ||
| GraphWidget, | ||
| HorizontalAnnotation, | ||
| IWidget, | ||
| } from "aws-cdk-lib/aws-cloudwatch"; | ||
|
|
||
| import { | ||
| RdsClusterMetricFactory, | ||
| RdsClusterMetricFactoryProps, | ||
| } from "./RdsClusterMetricFactory"; | ||
| import { | ||
| BaseMonitoringProps, | ||
| ConnectionAlarmFactory, | ||
| CountAxisFromZero, | ||
| DefaultGraphWidgetHeight, | ||
| HalfWidth, | ||
| HighConnectionCountThreshold, | ||
| LowConnectionCountThreshold, | ||
| MetricWithAlarmSupport, | ||
| Monitoring, | ||
| MonitoringScope, | ||
| PercentageAxisFromZeroToHundred, | ||
| QuarterWidth, | ||
| TimeAxisMillisFromZero, | ||
| UsageAlarmFactory, | ||
| UsageCountThreshold, | ||
| UsageThreshold, | ||
| } from "../../common"; | ||
| import { | ||
| MonitoringHeaderWidget, | ||
| MonitoringNamingStrategy, | ||
| } from "../../dashboard"; | ||
|
|
||
| export interface AuroraClusterMonitoringOptions extends BaseMonitoringProps { | ||
| readonly addMaxServerlessDatabaseCapacityAlarm?: Record< | ||
| string, | ||
| UsageCountThreshold | ||
| >; | ||
| readonly addCpuUsageAlarm?: Record<string, UsageThreshold>; | ||
| readonly addMinConnectionCountAlarm?: Record< | ||
| string, | ||
| LowConnectionCountThreshold | ||
| >; | ||
| readonly addMaxConnectionCountAlarm?: Record< | ||
| string, | ||
| HighConnectionCountThreshold | ||
| >; | ||
| } | ||
|
|
||
| export interface AuroraClusterMonitoringProps | ||
| extends RdsClusterMetricFactoryProps, | ||
| AuroraClusterMonitoringOptions {} | ||
|
|
||
| export class AuroraClusterMonitoring extends Monitoring { | ||
| readonly title: string; | ||
| readonly url?: string; | ||
|
|
||
| readonly usageAlarmFactory: UsageAlarmFactory; | ||
| readonly connectionAlarmFactory: ConnectionAlarmFactory; | ||
|
|
||
| readonly usageAnnotations: HorizontalAnnotation[]; | ||
| readonly connectionAnnotations: HorizontalAnnotation[]; | ||
|
|
||
| readonly connectionsMetric: MetricWithAlarmSupport; | ||
| readonly serverlessDatabaseCapacityMetric: MetricWithAlarmSupport; | ||
| readonly cpuUsageMetric: MetricWithAlarmSupport; | ||
| readonly selectLatencyMetric: MetricWithAlarmSupport; | ||
| readonly insertLatencyMetric: MetricWithAlarmSupport; | ||
| readonly updateLatencyMetric: MetricWithAlarmSupport; | ||
| readonly deleteLatencyMetric: MetricWithAlarmSupport; | ||
| readonly commitLatencyMetric: MetricWithAlarmSupport; | ||
|
|
||
| constructor(scope: MonitoringScope, props: AuroraClusterMonitoringProps) { | ||
| super(scope, props); | ||
|
|
||
| const metricFactory = new RdsClusterMetricFactory( | ||
| scope.createMetricFactory(), | ||
| props | ||
| ); | ||
| this.connectionsMetric = metricFactory.metricTotalConnectionCount(); | ||
| this.serverlessDatabaseCapacityMetric = | ||
| metricFactory.metricServerlessDatabaseCapacity(); | ||
| this.cpuUsageMetric = metricFactory.metricAverageCpuUsageInPercent(); | ||
| this.selectLatencyMetric = metricFactory.metricSelectLatencyP90InMillis(); | ||
| this.insertLatencyMetric = metricFactory.metricInsertLatencyP90InMillis(); | ||
| this.updateLatencyMetric = metricFactory.metricUpdateLatencyP90InMillis(); | ||
| this.deleteLatencyMetric = metricFactory.metricDeleteLatencyP90InMillis(); | ||
| this.commitLatencyMetric = metricFactory.metricCommitLatencyP90InMillis(); | ||
|
|
||
| const namingStrategy = new MonitoringNamingStrategy({ | ||
| ...props, | ||
| fallbackConstructName: metricFactory.clusterIdentifier, | ||
| namedConstruct: props.cluster, | ||
| }); | ||
| this.title = namingStrategy.resolveHumanReadableName(); | ||
| this.url = scope | ||
| .createAwsConsoleUrlFactory() | ||
| .getRdsClusterUrl(metricFactory.clusterIdentifier); | ||
| const alarmFactory = this.createAlarmFactory( | ||
| namingStrategy.resolveAlarmFriendlyName() | ||
| ); | ||
| this.usageAlarmFactory = new UsageAlarmFactory(alarmFactory); | ||
| this.connectionAlarmFactory = new ConnectionAlarmFactory(alarmFactory); | ||
|
|
||
| this.usageAnnotations = []; | ||
| this.connectionAnnotations = []; | ||
|
|
||
| for (const disambiguator in props.addCpuUsageAlarm) { | ||
| const alarmProps = props.addCpuUsageAlarm[disambiguator]; | ||
| const createdAlarm = this.usageAlarmFactory.addMaxCpuUsagePercentAlarm( | ||
| this.cpuUsageMetric, | ||
| alarmProps, | ||
| disambiguator | ||
| ); | ||
| this.usageAnnotations.push(createdAlarm.annotation); | ||
| this.addAlarm(createdAlarm); | ||
| } | ||
|
|
||
| for (const disambiguator in props.addMinConnectionCountAlarm) { | ||
| const alarmProps = props.addMinConnectionCountAlarm[disambiguator]; | ||
| const createdAlarm = | ||
| this.connectionAlarmFactory.addMinConnectionCountAlarm( | ||
| this.connectionsMetric, | ||
| alarmProps, | ||
| disambiguator | ||
| ); | ||
| this.connectionAnnotations.push(createdAlarm.annotation); | ||
| this.addAlarm(createdAlarm); | ||
| } | ||
|
|
||
| for (const disambiguator in props.addMaxConnectionCountAlarm) { | ||
| const alarmProps = props.addMaxConnectionCountAlarm[disambiguator]; | ||
| const createdAlarm = | ||
| this.connectionAlarmFactory.addMaxConnectionCountAlarm( | ||
| this.connectionsMetric, | ||
| alarmProps, | ||
| disambiguator | ||
| ); | ||
| this.connectionAnnotations.push(createdAlarm.annotation); | ||
| this.addAlarm(createdAlarm); | ||
| } | ||
|
|
||
| for (const disambiguator in props.addMaxServerlessDatabaseCapacityAlarm) { | ||
| const alarmProps = | ||
| props.addMaxServerlessDatabaseCapacityAlarm[disambiguator]; | ||
| const createdAlarm = this.usageAlarmFactory.addMaxUsageCountAlarm( | ||
| this.serverlessDatabaseCapacityMetric, | ||
| alarmProps, | ||
| disambiguator | ||
| ); | ||
| this.connectionAnnotations.push(createdAlarm.annotation); | ||
| this.addAlarm(createdAlarm); | ||
| } | ||
|
|
||
| props.useCreatedAlarms?.consume(this.createdAlarms()); | ||
| } | ||
|
|
||
| summaryWidgets(): IWidget[] { | ||
| return [ | ||
| this.createTitleWidget(), | ||
| this.createCpuUsageWidget(QuarterWidth, DefaultGraphWidgetHeight), | ||
| this.createConnectionsWidget(QuarterWidth, DefaultGraphWidgetHeight), | ||
| this.createLatencyWidget(QuarterWidth, DefaultGraphWidgetHeight), | ||
| this.createServerlessDatabaseCapacityWidget( | ||
| QuarterWidth, | ||
| DefaultGraphWidgetHeight | ||
| ), | ||
| ]; | ||
| } | ||
|
|
||
| widgets(): IWidget[] { | ||
| return [ | ||
| this.createTitleWidget(), | ||
| this.createCpuUsageWidget(QuarterWidth, DefaultGraphWidgetHeight), | ||
| this.createConnectionsWidget(QuarterWidth, DefaultGraphWidgetHeight), | ||
| this.createLatencyWidget(HalfWidth, DefaultGraphWidgetHeight), | ||
| this.createServerlessDatabaseCapacityWidget( | ||
| HalfWidth, | ||
| DefaultGraphWidgetHeight | ||
| ), | ||
| ]; | ||
| } | ||
|
|
||
| createTitleWidget() { | ||
| return new MonitoringHeaderWidget({ | ||
| family: "Aurora Cluster", | ||
| title: this.title, | ||
| goToLinkUrl: this.url, | ||
| }); | ||
| } | ||
|
|
||
| createCpuUsageWidget(width: number, height: number) { | ||
| return new GraphWidget({ | ||
| width, | ||
| height, | ||
| title: "CPU Usage", | ||
| left: [this.cpuUsageMetric], | ||
| leftYAxis: PercentageAxisFromZeroToHundred, | ||
| leftAnnotations: this.usageAnnotations, | ||
| }); | ||
| } | ||
|
|
||
| createConnectionsWidget(width: number, height: number) { | ||
| return new GraphWidget({ | ||
| width, | ||
| height, | ||
| title: "Connections", | ||
| left: [this.connectionsMetric], | ||
| leftYAxis: CountAxisFromZero, | ||
| leftAnnotations: this.connectionAnnotations, | ||
| }); | ||
| } | ||
|
|
||
| createLatencyWidget(width: number, height: number) { | ||
| return new GraphWidget({ | ||
| width, | ||
| height, | ||
| title: "Query Duration", | ||
| left: [ | ||
| this.selectLatencyMetric, | ||
| this.insertLatencyMetric, | ||
| this.updateLatencyMetric, | ||
| this.deleteLatencyMetric, | ||
| this.commitLatencyMetric, | ||
| ], | ||
| leftYAxis: TimeAxisMillisFromZero, | ||
| }); | ||
| } | ||
|
|
||
| createServerlessDatabaseCapacityWidget(width: number, height: number) { | ||
| return new GraphWidget({ | ||
| width, | ||
| height, | ||
| title: "Serverless Database Capacity", | ||
| left: [this.serverlessDatabaseCapacityMetric], | ||
| leftYAxis: CountAxisFromZero, | ||
| }); | ||
| } | ||
| } |
Oops, something went wrong.