feat: Add CloudWatch dashboard

docs/guide/deploy.md

@@ -172,6 +172,11 @@ To run the tests (Replace the url with the one you used in the steps above)
 REACT_APP_URL=https://dxxxxxxxxxxxxx.cloudfront.net pytest integtests/
 ```
 
+## Monitoring
+
+Once the deployment is complete, a [CloudWatch Dashboard](https://console.aws.amazon.com/cloudwatch) will be available in the selected region to monitor the usage of the resources.
+
+
 ## Run user interface locally
 
 To experiment with changes to the the user interface, you can run the interface locally. See the instructions in the README file of the [`lib/user-interface/react-app`](https://github.com/aws-samples/aws-genai-llm-chatbot/blob/main/lib/user-interface/react-app/README.md) folder.

lib/aws-genai-llm-chatbot-stack.ts

@@ -2,6 +2,7 @@ import * as cdk from "aws-cdk-lib";
 import { Construct } from "constructs";
 import { SystemConfig, ModelInterface, Direction } from "./shared/types";
 import { Authentication } from "./authentication";
+import { Monitoring } from "./monitoring";
 import { UserInterface } from "./user-interface";
 import { Shared } from "./shared";
 import { ChatBotApi } from "./chatbot-api";
@@ -66,19 +67,16 @@ export class AwsGenAILLMChatbotStack extends cdk.Stack {
     );
 
     // check if any deployed model requires langchain interface or if bedrock is enabled from config
+    let langchainInterface: LangChainInterface | undefined;
     if (langchainModels.length > 0 || props.config.bedrock?.enabled) {
-      const langchainInterface = new LangChainInterface(
-        this,
-        "LangchainInterface",
-        {
-          shared,
-          config: props.config,
-          ragEngines,
-          messagesTopic: chatBotApi.messagesTopic,
-          sessionsTable: chatBotApi.sessionsTable,
-          byUserIdIndex: chatBotApi.byUserIdIndex,
-        }
-      );
+      langchainInterface = new LangChainInterface(this, "LangchainInterface", {
+        shared,
+        config: props.config,
+        ragEngines,
+        messagesTopic: chatBotApi.messagesTopic,
+        sessionsTable: chatBotApi.sessionsTable,
+        byUserIdIndex: chatBotApi.byUserIdIndex,
+      });
 
       // Route all incoming messages targeted to langchain to the langchain model interface queue
       chatBotApi.messagesTopic.addSubscription(
@@ -218,6 +216,43 @@ export class AwsGenAILLMChatbotStack extends cdk.Stack {
       }
     }
 
+    const monitoringStack = new cdk.NestedStack(this, "MonitoringStack");
+    new Monitoring(monitoringStack, "Monitoring", {
+      appsycnApi: chatBotApi.graphqlApi,
+      cognito: {
+        userPoolId: authentication.userPool.userPoolId,
+        clientId: authentication.userPoolClient.userPoolClientId,
+      },
+      tables: [
+        chatBotApi.sessionsTable,
+        ...(ragEngines
+          ? [ragEngines.workspacesTable, ragEngines.documentsTable]
+          : []),
+      ],
+      sqs: [
+        chatBotApi.outBoundQueue,
+        ideficsInterface.ingestionQueue,
+        ...(langchainInterface ? [langchainInterface.ingestionQueue] : []),
+      ],
+      aurora: ragEngines?.auroraPgVector?.database,
+      opensearch: ragEngines?.openSearchVector?.openSearchCollection,
+      kendra: ragEngines?.kendraRetrieval?.kendraIndex,
+      buckets: [chatBotApi.filesBucket],
+      ragFunctionProcessing: [
+        ...(ragEngines ? [ragEngines.dataImport.rssIngestorFunction] : []),
+      ],
+      ragStateMachineProcessing: [
+        ...(ragEngines
+          ? [
+              ragEngines.dataImport.fileImportWorkflow,
+              ragEngines.dataImport.websiteCrawlingWorkflow,
+              ragEngines.deleteDocumentWorkflow,
+              ragEngines.deleteWorkspaceWorkflow,
+            ]
+          : []),
+      ],
+    });
+
     /**
      * CDK NAG suppression
      */

lib/chatbot-api/index.ts

@@ -1,6 +1,7 @@
 import * as cognito from "aws-cdk-lib/aws-cognito";
 import * as dynamodb from "aws-cdk-lib/aws-dynamodb";
 import * as s3 from "aws-cdk-lib/aws-s3";
+import * as sqs from "aws-cdk-lib/aws-sqs";
 import * as sns from "aws-cdk-lib/aws-sns";
 import * as ssm from "aws-cdk-lib/aws-ssm";
 import * as iam from "aws-cdk-lib/aws-iam";
@@ -29,6 +30,7 @@ export interface ChatBotApiProps {
 
 export class ChatBotApi extends Construct {
   public readonly messagesTopic: sns.Topic;
+  public readonly outBoundQueue: sqs.Queue;
   public readonly sessionsTable: dynamodb.Table;
   public readonly byUserIdIndex: string;
   public readonly filesBucket: s3.Bucket;
@@ -116,6 +118,7 @@ export class ChatBotApi extends Construct {
     });
 
     this.messagesTopic = realtimeBackend.messagesTopic;
+    this.outBoundQueue = realtimeBackend.queue;
     this.sessionsTable = chatTables.sessionsTable;
     this.byUserIdIndex = chatTables.byUserIdIndex;
     this.userFeedbackBucket = chatBuckets.userFeedbackBucket;

lib/chatbot-api/websocket-api.ts

@@ -22,6 +22,7 @@ interface RealtimeGraphqlApiBackendProps {
 export class RealtimeGraphqlApiBackend extends Construct {
   public readonly messagesTopic: sns.Topic;
   public readonly resolvers: RealtimeResolvers;
+  public readonly queue: sqs.Queue;
 
   constructor(
     scope: Construct,
@@ -80,6 +81,7 @@ export class RealtimeGraphqlApiBackend extends Construct {
 
     this.messagesTopic = messagesTopic;
     this.resolvers = resolvers;
+    this.queue = queue;
 
     /**
      * CDK NAG suppression

lib/model-interfaces/idefics/index.ts

@@ -226,7 +226,7 @@ export class IdeficsInterface extends Construct {
     const deadLetterQueue = new sqs.Queue(this, "DLQ", {
       enforceSSL: true,
     });
-    const queue = new sqs.Queue(this, "Queue", {
+    const queue = new sqs.Queue(this, "IdeficsIngestionQueue", {
       removalPolicy: cdk.RemovalPolicy.DESTROY,
       // https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-queueconfig
       visibilityTimeout: cdk.Duration.minutes(lambdaDurationInMinutes * 6),

lib/model-interfaces/langchain/index.ts

@@ -234,7 +234,7 @@ export class LangChainInterface extends Construct {
       enforceSSL: true,
     });
 
-    const queue = new sqs.Queue(this, "Queue", {
+    const queue = new sqs.Queue(this, "LangChainIngestionQueue", {
       removalPolicy: cdk.RemovalPolicy.DESTROY,
       // https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-queueconfig
       visibilityTimeout: cdk.Duration.minutes(15 * 6),