Skip to content

aws-samples/aws-cdk-lambda-cloudwatch-dashboard

CloudWatch Lambda Dashboards using CDK

This project is an example of building a CloudWatch Dashboard for Lambdas to visualize the Invocations, Concurrent Executions, Duration, and Errors. The CDK Stack provided uses the CloudWatch Metric and GraphWidget classes to visualize the graphs. The project also includes a sample Lambda functions with API Gateway integrations to showcase the dashboards. The stack adds one row for each Lambda to the Dashboard to get a single view for selected metrics and alarms to help you assess the health of your Lambda resources. Invocations, Duration, Errors, and Concurrent Execution Metrics are the selected metrics.

Getting started

To get started, clone this cdk-lambda-dashboard. The repository contains a CDK App in TypeScript that deploys a CDK Stack.

To see or the edit the CloudWatch dashboard, please refer CDK App.

CDK Concepts

This topic describes some of the concepts (the why and how) behind the AWS CDK.

AWS CDK apps are composed of building blocks known as Constructs, which are composed together to form stacks and apps.

Please visit here for further referene.

Prerequisites

To run the sample, you will need:

  1. An AWS Account into which you will deploy services. Be sure that you have permissions to deploy resources in the AWS Account
  2. CDK Setup is completed by following this guide
  3. Node setup is completed by following this guide
  4. Configure your AWS profile using the quickstart guide

Deployment

To deploy the sample, perform the following:

  1. Clone the cdk-lambda-dashboard to your local
  2. Run npm install to install the necessary node modules needed for the project
  3. Run npm run build to compile the project
  4. Run cdk synth to see the CloudFormation template
  5. Run cdk deploy to deploy the Stack
  6. Upon successful deployment, you can go into CloudWatch to see the Dashboard (see/edit the cdk-lambda-dashboard.ts for Dashboard name). A sample snapshot is listed here.

LambdaDashboard

Clean up your Stack

You can delete the stack by running cdk destroy.

Useful commands

  • npm run build compile typescript to js
  • npm run watch watch for changes and compile
  • npm run test perform the jest unit tests
  • cdk deploy deploy this stack to your default AWS account/region
  • cdk diff compare deployed stack with current state
  • cdk synth emits the synthesized CloudFormation template
  • cdk destroy delete this stack from your default AWS Account/region

Reference Documentation

Security

See CONTRIBUTING for more information.

License

This library is licensed under the MIT-0 License. See the LICENSE file.

About

Building a CloudWatch Dashboard for Lambdas to visualize the Invocations, Concurrent Executions, Duration, and Errors using CDK

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published