feat: add observability #5

feat: add observability #5

Author: rehanvdm

docs/API.md

@@ -310,6 +310,92 @@ The tree node.
 
 ## Structs <a name="Structs" id="Structs"></a>
 
+### AlarmProps <a name="AlarmProps" id="serverless-website-analytics.AlarmProps"></a>
+
+#### Initializer <a name="Initializer" id="serverless-website-analytics.AlarmProps.Initializer"></a>
+
+```typescript
+import { AlarmProps } from 'serverless-website-analytics'
+
+const alarmProps: AlarmProps = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#serverless-website-analytics.AlarmProps.property.alarmTopic">alarmTopic</a></code> | <code>aws-cdk-lib.aws_sns.Topic</code> | The SNS topic to send alarms to. |
+| <code><a href="#serverless-website-analytics.AlarmProps.property.alarmTypes">alarmTypes</a></code> | <code><a href="#serverless-website-analytics.AlarmTypes">AlarmTypes</a></code> | Specify which alarms you want. |
+
+---
+
+##### `alarmTopic`<sup>Required</sup> <a name="alarmTopic" id="serverless-website-analytics.AlarmProps.property.alarmTopic"></a>
+
+```typescript
+public readonly alarmTopic: Topic;
+```
+
+- *Type:* aws-cdk-lib.aws_sns.Topic
+
+The SNS topic to send alarms to.
+
+---
+
+##### `alarmTypes`<sup>Required</sup> <a name="alarmTypes" id="serverless-website-analytics.AlarmProps.property.alarmTypes"></a>
+
+```typescript
+public readonly alarmTypes: AlarmTypes;
+```
+
+- *Type:* <a href="#serverless-website-analytics.AlarmTypes">AlarmTypes</a>
+
+Specify which alarms you want.
+
+---
+
+### AlarmTypes <a name="AlarmTypes" id="serverless-website-analytics.AlarmTypes"></a>
+
+#### Initializer <a name="Initializer" id="serverless-website-analytics.AlarmTypes.Initializer"></a>
+
+```typescript
+import { AlarmTypes } from 'serverless-website-analytics'
+
+const alarmTypes: AlarmTypes = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#serverless-website-analytics.AlarmTypes.property.firehose">firehose</a></code> | <code>boolean</code> | Adds a throttle and s3 delivery failure alarms for both Firehoses. |
+| <code><a href="#serverless-website-analytics.AlarmTypes.property.lambda">lambda</a></code> | <code>boolean</code> | Adds a hard and soft alarm to both Lambda functions; |
+
+---
+
+##### `firehose`<sup>Required</sup> <a name="firehose" id="serverless-website-analytics.AlarmTypes.property.firehose"></a>
+
+```typescript
+public readonly firehose: boolean;
+```
+
+- *Type:* boolean
+
+Adds a throttle and s3 delivery failure alarms for both Firehoses.
+
+---
+
+##### `lambda`<sup>Required</sup> <a name="lambda" id="serverless-website-analytics.AlarmTypes.property.lambda"></a>
+
+```typescript
+public readonly lambda: boolean;
+```
+
+- *Type:* boolean
+
+Adds a hard and soft alarm to both Lambda functions;
+
+---
+
 ### AwsEnv <a name="AwsEnv" id="serverless-website-analytics.AwsEnv"></a>
 
 The AWS environment (account and region) to deploy to.
@@ -436,6 +522,49 @@ the serverless-website-analytics dashboard page.
 
 ---
 
+### Observability <a name="Observability" id="serverless-website-analytics.Observability"></a>
+
+#### Initializer <a name="Initializer" id="serverless-website-analytics.Observability.Initializer"></a>
+
+```typescript
+import { Observability } from 'serverless-website-analytics'
+
+const observability: Observability = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#serverless-website-analytics.Observability.property.alarms">alarms</a></code> | <code><a href="#serverless-website-analytics.AlarmProps">AlarmProps</a></code> | Adds CloudWatch Alarms to the resources created by this construct. |
+| <code><a href="#serverless-website-analytics.Observability.property.dashboard">dashboard</a></code> | <code>boolean</code> | Adds a CloudWatch dashboard with metrics for the resources created by this construct. |
+
+---
+
+##### `alarms`<sup>Optional</sup> <a name="alarms" id="serverless-website-analytics.Observability.property.alarms"></a>
+
+```typescript
+public readonly alarms: AlarmProps;
+```
+
+- *Type:* <a href="#serverless-website-analytics.AlarmProps">AlarmProps</a>
+
+Adds CloudWatch Alarms to the resources created by this construct.
+
+---
+
+##### `dashboard`<sup>Optional</sup> <a name="dashboard" id="serverless-website-analytics.Observability.property.dashboard"></a>
+
+```typescript
+public readonly dashboard: boolean;
+```
+
+- *Type:* boolean
+
+Adds a CloudWatch dashboard with metrics for the resources created by this construct.
+
+---
+
 ### SwaAuth <a name="SwaAuth" id="serverless-website-analytics.SwaAuth"></a>
 
 The auth configuration which defaults to none.
@@ -648,6 +777,7 @@ const swaProps: SwaProps = { ... }
 | <code><a href="#serverless-website-analytics.SwaProps.property.auth">auth</a></code> | <code><a href="#serverless-website-analytics.SwaAuth">SwaAuth</a></code> | The auth configuration which defaults to none. |
 | <code><a href="#serverless-website-analytics.SwaProps.property.domain">domain</a></code> | <code><a href="#serverless-website-analytics.Domain">Domain</a></code> | If specified, it will create the CloudFront and Cognito resources at the specified domain and optionally create the DNS records in the specified Route53 hosted zone. |
 | <code><a href="#serverless-website-analytics.SwaProps.property.isDemoPage">isDemoPage</a></code> | <code>boolean</code> | If specified, adds the banner at the top of the page linking back to the open source project. |
+| <code><a href="#serverless-website-analytics.SwaProps.property.observability">observability</a></code> | <code><a href="#serverless-website-analytics.Observability">Observability</a></code> | Adds a CloudWatch Dashboard and Alarms if specified. |
 
 ---
 
@@ -752,5 +882,17 @@ If specified, adds the banner at the top of the page linking back to the open so
 
 ---
 
+##### `observability`<sup>Optional</sup> <a name="observability" id="serverless-website-analytics.SwaProps.property.observability"></a>
+
+```typescript
+public readonly observability: Observability;
+```
+
+- *Type:* <a href="#serverless-website-analytics.Observability">Observability</a>
+
+Adds a CloudWatch Dashboard and Alarms if specified.
+
+---
+
 
 

src/auth.ts

@@ -94,8 +94,8 @@ export function auth(scope: Construct, name: (name: string) => string, props: Sw
         },
       });
       userPoolDomain = domain.baseUrl();
-      new cdk.CfnOutput(scope, name('COGNITO_HOSTED_UI_URL'), {
-        description: 'COGNITO_HOSTED_UI_URL',
+      new cdk.CfnOutput(scope, name('CognitoHostedUrl'), {
+        description: 'Cognito Hosted Url',
         value: userPoolDomain,
       });
     } else {
@@ -118,9 +118,12 @@ export function auth(scope: Construct, name: (name: string) => string, props: Sw
       });
     }
 
-    new cdk.CfnOutput(scope, name('USER_POOL_ID'), { description: 'USER_POOL_ID', value: userPool.userPoolId });
-    new cdk.CfnOutput(scope, name('USER_POOL_CLIENT_ID'), {
-      description: 'USER_POOL_CLIENT_ID',
+    new cdk.CfnOutput(scope, name('CognitoUserPoolId'), {
+      description: 'Cognito UserPoolId',
+      value: userPool.userPoolId,
+    });
+    new cdk.CfnOutput(scope, name('CognitoUserPoolClientId'), {
+      description: 'Cognito UserPool ClientId',
       value: userPoolClient.userPoolClientId,
     });
   } else {

src/backend.ts

@@ -5,10 +5,12 @@ import * as cdk from 'aws-cdk-lib';
 import * as iam from 'aws-cdk-lib/aws-iam';
 import { Effect } from 'aws-cdk-lib/aws-iam';
 import * as lambda from 'aws-cdk-lib/aws-lambda';
+import * as logs from 'aws-cdk-lib/aws-logs';
 import { Construct } from 'constructs';
 import { auth } from './auth';
 import { backendAnalytics } from './backendAnalytics';
 import { SwaProps } from './index';
+import { CwLambda } from './lib/cloudwatch-helper';
 
 export function backend(
   scope: Construct,
@@ -194,8 +196,33 @@ export function backend(
     authType: lambda.FunctionUrlAuthType.NONE,
   });
 
+  const cwLambdas: CwLambda[] = [
+    {
+      func: apiIngestLambda,
+      alarm: {
+        hardError: true,
+        softErrorFilter: logs.FilterPattern.all(
+          logs.FilterPattern.stringValue('$.level', '=', 'audit'),
+          logs.FilterPattern.stringValue('$.success', '=', 'false')
+        ),
+      },
+    },
+    {
+      func: apiFrontLambda,
+      alarm: {
+        hardError: true,
+        softErrorFilter: logs.FilterPattern.all(
+          logs.FilterPattern.stringValue('$.level', '=', 'audit'),
+          logs.FilterPattern.stringValue('$.success', '=', 'false')
+        ),
+      },
+    },
+  ];
   return {
     apiIngestOrigin: cdk.Fn.select(2, cdk.Fn.split('/', apiIngestLambdaUrl.url)),
     apiFrontOrigin: cdk.Fn.select(2, cdk.Fn.split('/', apiFrontLambdaUrl.url)),
+    observability: {
+      cwLambdas,
+    },
   };
 }

src/backendAnalytics.ts

@@ -9,6 +9,7 @@ import { CfnLogGroup } from 'aws-cdk-lib/aws-logs';
 import * as s3 from 'aws-cdk-lib/aws-s3';
 import { Construct } from 'constructs';
 import { SwaProps } from './index';
+import { CwBucket, CwFirehose } from './lib/cloudwatch-helper';
 
 export function backendAnalytics(scope: Construct, name: (name: string) => string, props: SwaProps) {
   /* ======================================================================= */
@@ -464,29 +465,36 @@ export function backendAnalytics(scope: Construct, name: (name: string) => strin
   firehoseEvents.addDependency(firehoseDeliveryRole.node.defaultChild as CfnRole);
   firehoseEvents.addDependency(logGroup.node.defaultChild as CfnLogGroup);
 
-  new cdk.CfnOutput(scope, name('ANALYTICS_BUCKET'), {
-    description: 'ANALYTICS_BUCKET',
+  new cdk.CfnOutput(scope, name('AnalyticsBucket'), {
+    description: 'Analytics Bucket',
     value: analyticsBucket.bucketName,
   });
-  new cdk.CfnOutput(scope, name('FIREHOSE_PAGE_VIEWS_NAME'), {
-    description: 'FIREHOSE_PAGE_VIEWS_NAME',
+  new cdk.CfnOutput(scope, name('FirehosePageViewsName'), {
+    description: 'Firehose Page Views Name',
     value: firehosePageViews.deliveryStreamName!,
   });
-  new cdk.CfnOutput(scope, name('FIREHOSE_EVENTS_NAME'), {
-    description: 'FIREHOSE_EVENTS_NAME',
+  new cdk.CfnOutput(scope, name('FirehoseEventsName'), {
+    description: 'Firehose Events Name',
     value: firehoseEvents.deliveryStreamName!,
   });
-  new cdk.CfnOutput(scope, name('ANALYTICS_GLUE_DB_NAME'), {
-    description: 'ANALYTICS_GLUE_DB_NAME',
+  new cdk.CfnOutput(scope, name('AnalyticsGlueDbName'), {
+    description: 'Analytics Glue DB Name',
     value: glueDbName,
   });
 
+  const cwBuckets: CwBucket[] = [{ bucket: analyticsBucket }];
+  const cwFirehoses: CwFirehose[] = [{ firehose: firehosePageViews }, { firehose: firehoseEvents }];
+
   return {
     glueDbName,
     glueTablePageViewsName,
     glueTableEventsName,
     analyticsBucket,
     firehosePageViews,
     firehoseEvents,
+    observability: {
+      cwBuckets,
+      cwFirehoses,
+    },
   };
 }

src/frontend.ts

@@ -19,9 +19,8 @@ import { Construct } from 'constructs';
 import { auth } from './auth';
 import { backend } from './backend';
 import { SwaProps } from './index';
+import { CwCloudFront } from './lib/cloudwatch-helper';
 
-//eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore
 export function frontend(
   scope: Construct,
   name: (name: string) => string,
@@ -201,8 +200,8 @@ export function frontend(
           certificate: props.domain.certificate,
         },
       });
-      new cdk.CfnOutput(scope, name('COGNITO_HOSTED_UI_URL'), {
-        description: 'COGNITO_HOSTED_UI_URL',
+      new cdk.CfnOutput(scope, name('CognitoHostedUrl'), {
+        description: 'Cognito Hosted URL',
         value: cognitoDomain.baseUrl(),
       });
       if (cloudFrontRecord) cognitoDomain.node.addDependency(cloudFrontRecord);
@@ -232,29 +231,34 @@ export function frontend(
     if (manualRecords.length) {
       cdk.Annotations.of(scope).addInfo('DNS records need to be created manually, see all CloudFormation Outputs');
       for (const record of manualRecords) {
-        new cdk.CfnOutput(scope, name(`DNS_${record.description}`), {
-          description: `DNS_${record.description}`,
+        new cdk.CfnOutput(scope, name(`Dns_${record.description}`), {
+          description: `DNS ${record.description}`,
           value: `Manually Create DNS Record: ${record.name} ${record.type} ${record.value}`,
         });
       }
     }
   }
 
-  new cdk.CfnOutput(scope, name('CFD_ID'), { description: 'CFD_ID', value: frontendDist.distributionId });
-  new cdk.CfnOutput(scope, name('FRONTEND_URL'), {
-    description: 'FRONTEND_URL',
+  new cdk.CfnOutput(scope, name('CloudFrontId'), { description: 'CloudFront Id', value: frontendDist.distributionId });
+  new cdk.CfnOutput(scope, name('FrontendUrl'), {
+    description: 'Frontend Url',
     value: cdk.Fn.join('', ['https://', props.domain?.name || frontendDist.distributionDomainName]),
   });
-  new cdk.CfnOutput(scope, name('apiIngestUrl'), {
-    description: 'apiIngestUrl',
+  new cdk.CfnOutput(scope, name('ApiIngestUrl'), {
+    description: 'Api Ingest Url',
     value: cdk.Fn.join('', ['https://', props.domain?.name || frontendDist.distributionDomainName, '/api-ingest']),
   });
-  new cdk.CfnOutput(scope, name('apiFrontLambdaUrl'), {
-    description: 'apiFrontLambdaUrl',
+  new cdk.CfnOutput(scope, name('ApiFrontLambdaUrl'), {
+    description: 'Api Front Lambda Url',
     value: cdk.Fn.join('', ['https://', props.domain?.name || frontendDist.distributionDomainName, '/api']),
   });
 
+  const cwCloudFronts: CwCloudFront[] = [{ distribution: frontendDist }];
+
   return {
     frontendDist,
+    observability: {
+      cwCloudFronts,
+    },
   };
 }