@aws-lambda-powertools/metrics
Advanced tools
The metrics package for the Powertools for AWS Lambda (TypeScript) library
Package description
@aws-lambda-powertools/metrics is an npm package designed to simplify the creation and management of custom metrics in AWS Lambda functions. It provides utilities to easily capture and publish metrics to Amazon CloudWatch, enabling better observability and monitoring of serverless applications.
Creating Custom Metrics
This feature allows you to create custom metrics and publish them to CloudWatch. The code sample demonstrates how to add metrics for successful invocations and processing time, and then publish them.
const { Metrics, MetricUnits } = require('@aws-lambda-powertools/metrics');
const metrics = new Metrics();
exports.handler = async (event) => {
metrics.addMetric('SuccessfulInvocations', MetricUnits.Count, 1);
metrics.addMetric('ProcessingTime', MetricUnits.Milliseconds, 200);
await metrics.publishStoredMetrics();
return { statusCode: 200, body: 'Metrics published' };
};Namespace and Dimensions
This feature allows you to set a namespace and dimensions for your metrics, which helps in organizing and filtering them in CloudWatch. The code sample shows how to set a namespace and dimensions for a payment service.
const { Metrics, MetricUnits } = require('@aws-lambda-powertools/metrics');
const metrics = new Metrics({ namespace: 'MyApp', dimensions: { Service: 'Payment' } });
exports.handler = async (event) => {
metrics.addMetric('PaymentSuccess', MetricUnits.Count, 1);
await metrics.publishStoredMetrics();
return { statusCode: 200, body: 'Payment metrics published' };
};Automatic Cold Start Metric
This feature automatically captures a cold start metric, which is useful for understanding the performance impact of cold starts in your Lambda functions. The code sample demonstrates how to enable this feature.
const { Metrics, MetricUnits } = require('@aws-lambda-powertools/metrics');
const metrics = new Metrics({ captureColdStartMetric: true });
exports.handler = async (event) => {
metrics.addMetric('HandlerInvoked', MetricUnits.Count, 1);
await metrics.publishStoredMetrics();
return { statusCode: 200, body: 'Cold start metric captured' };
};The aws-sdk package is the official AWS SDK for JavaScript, which includes support for CloudWatch metrics. However, it requires more boilerplate code to achieve the same functionality as @aws-lambda-powertools/metrics. It is more general-purpose and not specifically tailored for Lambda functions.
The cloudwatch-metrics package is a lightweight library for publishing metrics to CloudWatch. It provides a simpler interface compared to the aws-sdk but lacks some of the advanced features and integrations offered by @aws-lambda-powertools/metrics, such as automatic cold start metrics.
The lambda-metrics package is designed specifically for AWS Lambda functions and provides utilities for capturing and publishing metrics to CloudWatch. It offers similar functionalities to @aws-lambda-powertools/metrics but may not be as feature-rich or actively maintained.
Readme
Powertools for AWS Lambda (TypeScript) is a developer toolkit to implement Serverless best practices and increase developer velocity.
You can use the library in both TypeScript and JavaScript code bases.
Documentation | npm | Roadmap | Examples | Serverless TypeScript Demo
Find the complete project's documentation here.
The Powertools for AWS Lambda (TypeScript) utilities follow a modular approach, similar to the official AWS SDK v3 for JavaScript.
Each TypeScript utility is installed as standalone NPM package.
Install all three core utilities at once with this single command:
npm install @aws-lambda-powertools/logger @aws-lambda-powertools/tracer @aws-lambda-powertools/metrics
Or refer to the installation guide of each utility:
👉 Installation guide for the Tracer utility
👉 Installation guide for the Logger utility
👉 Installation guide for the Metrics utility
👉 Installation guide for the Parameters utility
You can find examples of how to use Powertools for AWS Lambda (TypeScript) in the examples directory. The application is a simple REST API that can be deployed via either AWS CDK or AWS SAM.
The Serverless TypeScript Demo shows how to use Powertools for AWS Lambda (TypeScript).
You can find instructions on how to deploy and load test this application in the repository.
The AWS Lambda performance tuning repository also uses Powertools for AWS Lambda (TypeScript) as well as demonstrating other performance tuning techniques for Lambda functions written in TypeScript.
If you are interested in contributing to this project, please refer to our Contributing Guidelines.
The roadmap of Powertools for AWS Lambda (TypeScript) is driven by customers’ demand.
Help us prioritize upcoming functionalities or utilities by upvoting existing RFCs and feature requests, or creating new ones, in this GitHub repository.
#typescript - Invite linkKnowing 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:
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.
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.
Credits for the Powertools for AWS Lambda (TypeScript) idea go to DAZN and their DAZN Lambda Powertools.
This library is licensed under the MIT-0 License. See the LICENSE file.
FAQs
The metrics package for the Powertools for AWS Lambda (TypeScript) library
The npm package @aws-lambda-powertools/metrics receives a total of 188,494 weekly downloads. As such, @aws-lambda-powertools/metrics popularity was classified as popular.
We found that @aws-lambda-powertools/metrics demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Git dependencies in open source packages can introduce significant risks, including lack of version control, stability issues, dependency drift, and difficulty in auditing, making them potential targets for supply chain attacks.
Security News
Node.js has added experimental support for TypeScript, a move that highlights the growing importance of TypeScript in modern development.
Product
Check out what's new at Socket with our Product Changelog. It tracks all public-facing updates, improvements, and fixes so you can take full advantage of our features.