Homepage
Powertools for AWS Lambda (TypeScript) is a developer toolkit to implement Serverless best practices and increase developer velocity.
You can use Powertools for AWS Lambda (TypeScript) in both TypeScript and JavaScript code bases.
Support this project by becoming a reference customer, sharing your work, or using Layers
You can choose to support us in three ways:
1) Become a reference customer. This gives us permission to list your company in our documentation.
2) Share your work. Blog posts, video, sample projects you used Powertools!
3) Use Lambda Layers, if possible. This helps us understand who uses Powertools for AWS Lambda (TypeScript) in a non-intrusive way, and helps us gain future investments for other Powertools for AWS Lambda languages.
When using Layers, you can add Powertools for AWS Lambda (TypeScript) as a devDependency
to not impact the development process.
Install¶
You can install Powertools for AWS Lambda (TypeScript) using one of the following options:
- Lambda Layer: arn:aws:lambda:{region}:094274105915:layer:AWSLambdaPowertoolsTypeScript:18
- npm:
npm install @aws-lambda-powertools/tracer @aws-lambda-powertools/metrics @aws-lambda-powertools/logger
Lambda Layer¶
As of now, Container Image deployment (OCI) or inline Lambda functions do not support Lambda Layers
Lambda Layer is a .zip file archive that can contain additional code, pre-packaged dependencies, data, or configuration files. Layers promote code sharing and separation of responsibilities so that you can iterate faster on writing business logic.
You can include Powertools for AWS Lambda (TypeScript) Lambda Layer using AWS Lambda Console, or your preferred deployment framework.
Click to expand and copy any regional Lambda Layer ARN
Click to expand and copy code snippets for popular frameworks
1 2 3 4 5 |
|
If you use esbuild
to bundle your code, make sure to exclude
@aws-lambda-powertools
from being bundled since the packages will be already present
the Layer:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
|
Check the documentation for more details.
1 2 3 4 5 |
|
If you use esbuild
to bundle your code, make sure to exclude
@aws-lambda-powertools
from being bundled since the packages will be already present
the Layer:
1 2 3 4 5 6 7 |
|
Check the documentation for more details.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
|
If you use esbuild
to bundle your code, make sure to exclude
@aws-lambda-powertools
from being bundled since the packages will be already present
the Layer:
1 2 3 4 5 6 7 8 9 10 11 |
|
Check the documentation for more details.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
|
Using Powertools for AWS Lambda (TypeScript) via Lambda Layer? Simply add the Powertools for AWS Lambda (TypeScript) utilities you are using as a development dependency
Want to inspect the contents of the Layer?
Change {region} to your AWS region, e.g. eu-west-1
AWS CLI | |
---|---|
1
|
|
The pre-signed URL to download this Lambda Layer will be within Location
key.
Instrumentation¶
You can instrument your code with Powertools for AWS Lambda (TypeScript) in three different ways:
- Middy middleware. It is the best choice if your existing code base relies on the Middy 3.x middleware engine. Powertools for AWS Lambda (TypeScript) offers compatible Middy middleware to make this integration seamless.
- Method decorator. Use TypeScript method decorators if you prefer writing your business logic using TypeScript Classes. If you arenβt using Classes, this requires the most significant refactoring.
- Manually. It provides the most granular control. Itβs the most verbose approach, with the added benefit of no additional dependency and no refactoring to TypeScript Classes.
The examples in this documentation will feature all the approaches described above, when applicable.
Examples¶
The project's repository includes examples of how to instrument your functions both in AWS CDK and AWS SAM:
If instead you want to see Powertools for AWS Lambda (TypeScript) in a slightly more complex use case, check the Serverless TypeScript Demo. You can find instructions on how to deploy and load test this application in the repository.
Features¶
Core utilities such as Tracing, Logging, and Metrics will be available across all Powertools for AWS Lambda languages. Additional utilities are subjective to each language ecosystem and customer demand.
Utility | Description |
---|---|
Tracer | Decorators and utilities to trace Lambda function handlers, and both synchronous and asynchronous functions |
Logger | Structured logging made easier, and a middleware to enrich structured logging with key Lambda context details |
Metrics | Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF) |
Parameters (beta) | High-level functions to retrieve one or more parameters from AWS SSM Parameter Store, AWS Secrets Manager, AWS AppConfig, and Amazon DynamoDB |
Environment variables¶
Info
Explicit parameters take precedence over environment variables
Environment variable | Description | Utility | Default |
---|---|---|---|
POWERTOOLS_SERVICE_NAME | Sets service name used for tracing namespace, metrics dimension and structured logging | All | service_undefined |
POWERTOOLS_METRICS_NAMESPACE | Sets namespace used for metrics | Metrics | default_namespace |
POWERTOOLS_TRACE_ENABLED | Explicitly disables tracing | Tracer | true |
POWERTOOLS_TRACER_CAPTURE_RESPONSE | Captures Lambda or method return as metadata. | Tracer | true |
POWERTOOLS_TRACER_CAPTURE_ERROR | Captures Lambda or method exception as metadata. | Tracer | true |
POWERTOOLS_TRACER_CAPTURE_HTTPS_REQUESTS | Captures HTTP(s) requests as segments. | Tracer | true |
POWERTOOLS_LOGGER_LOG_EVENT | Logs incoming event | Logger | false |
POWERTOOLS_LOGGER_SAMPLE_RATE | Debug log sampling | Logger | 0 |
POWERTOOLS_DEV | Increase JSON indentation to ease debugging when running functions locally or in a non-production environment | Logger | false |
LOG_LEVEL | Sets logging level | Logger | INFO |
POWERTOOLS_PARAMETERS_MAX_AGE | Adjust how long values are kept in cache (in seconds) | Parameters | 5 |
POWERTOOLS_PARAMETERS_SSM_DECRYPT | Sets whether to decrypt or not values retrieved from AWS Systems Manager Parameters Store | Parameters | false |
Each Utility page provides information on example values and allowed values.
How to support Powertools for AWS Lambda (TypeScript)?¶
Becoming a reference customer¶
Knowing which companies are using this library is important to help prioritize the project internally. If your company is using Powertools for AWS Lambda (TypeScript), you can request to have your name and logo added to the README file by raising a Support Powertools for AWS Lambda (TypeScript) (become a reference) issue.
The following companies, among others, use Powertools:
- Hashnode
- Trek10
- Elva
- globaldatanet
- Bailey Nelson
- Perfect Post
- Sennder
- Certible
- tecRacer GmbH & Co. KG
Sharing your work¶
Share what you did with Powertools for AWS Lambda (TypeScript) ππ. Blog post, workshops, presentation, sample apps and others. Check out what the community has already shared about Powertools for AWS Lambda (TypeScript) here.
Using Lambda Layer¶
This helps us understand who uses Powertools for AWS Lambda (TypeScript) in a non-intrusive way, and helps us gain future investments for other Powertools for AWS Lambda languages. When using Layers, you can add Powertools for AWS Lambda (TypeScript) as a dev dependency (or as part of your virtual env) to not impact the development process.
Tenets¶
These are our core principles to guide our decision making.
- AWS Lambda only. We optimise for AWS Lambda function environments and supported runtimes only. Utilities might work with web frameworks and non-Lambda environments, though they are not officially supported.
- Eases the adoption of best practices. The main priority of the utilities is to facilitate best practices adoption, as defined in the AWS Well-Architected Serverless Lens; all other functionality is optional.
- Keep it lean. Additional dependencies are carefully considered for security and ease of maintenance, and prevent negatively impacting startup time.
- We strive for backwards compatibility. New features and changes should keep backwards compatibility. If a breaking change cannot be avoided, the deprecation and migration process should be clearly defined.
- We work backwards from the community. We aim to strike a balance of what would work best for 80% of customers. Emerging practices are considered and discussed via Requests for Comment (RFCs)
- Progressive. Utilities are designed to be incrementally adoptable for customers at any stage of their Serverless journey. They follow language idioms and their communityβs common practices.