spaceblocks/aws-lambda-powertools-typescript

A suite of utilities for AWS Lambda Functions that makes structured logging, creating custom metrics asynchronously and tracing with AWS X-Ray easier

AWS Lambda Powertools for TypeScript

⚠️ WARNING: Do not use this library in production (yet) ⚠️
AWS Lambda Powertools for TypeScript is currently released as a release candidate (RC) and is intended for feedback and testing purposes only. While this version is fairly stable in terms of API surface, we still expect some changes to happen as part of the upcoming production-ready release.

A suite of TypeScript utilities for AWS Lambda functions to ease adopting best practices such as tracing, structured logging, custom metrics, and more. (AWS Lambda Powertools for Python and AWS Lambda Powertools for Java are also available).

📜 Documentation | NPM | Roadmap | Examples

An AWS Developer Acceleration (DevAx) initiative by Specialist Solution Architects | [email protected]

Table of contents

• Features
• Getting started
  • Installation
  • Examples
• Credits
• Connect
• License

Features

• Tracer - Utilities to trace Lambda function handlers, and both synchronous and asynchronous functions
• Logger - Structured logging made easier, and a middleware to enrich log items with key details of the Lambda context
• Metrics - Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF)

Getting started

Find the complete project's documentation here.

Installation

The AWS Lambda Powertools for TypeScript utilities follow a modular approach, similar to the official AWS SDK v3 for JavaScript.
Each TypeScript utility is installed as standalone NPM package.

👉 Installation guide for the Tracer utility

👉 Installation guide for the Logger utility

👉 Installation guide for the Metrics utility

Examples

• CDK
• SAM

Credits

• Credits for the Lambda Powertools idea go to DAZN and their DAZN Lambda Powertools.

Connect

• AWS Developers Slack: #lambda-powertools - Invite, if you don't have an account
• Email: [email protected]

License

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