@aws-lambda-powertools/logger
Advanced tools
The logging package for the Powertools for AWS Lambda (TypeScript) library
@aws-lambda-powertools/logger is a structured logging utility designed for AWS Lambda functions. It simplifies the process of creating consistent and meaningful logs, which can be crucial for debugging and monitoring serverless applications.
Basic Logging
This feature allows you to log basic information. The logger.info method is used to log informational messages.
const { Logger } = require('@aws-lambda-powertools/logger');
const logger = new Logger();
exports.handler = async (event) => {
logger.info('This is an info log');
return { statusCode: 200, body: 'Hello World' };
};Structured Logging
Structured logging allows you to add context to your logs, making them more useful for debugging and monitoring. You can add persistent attributes that will be included in every log entry.
const { Logger } = require('@aws-lambda-powertools/logger');
const logger = new Logger({
persistentLogAttributes: {
service: 'my-service',
environment: 'production'
}
});
exports.handler = async (event) => {
logger.info('This is a structured log', { userId: '12345' });
return { statusCode: 200, body: 'Hello World' };
};Error Logging
This feature allows you to log errors with additional context. The logger.error method is used to log error messages.
const { Logger } = require('@aws-lambda-powertools/logger');
const logger = new Logger();
exports.handler = async (event) => {
try {
throw new Error('Something went wrong');
} catch (error) {
logger.error('An error occurred', { error });
}
return { statusCode: 500, body: 'Internal Server Error' };
};Winston is a versatile logging library for Node.js that supports multiple transports (e.g., console, file, HTTP). It offers more flexibility and customization options compared to @aws-lambda-powertools/logger but requires more setup.
Bunyan is another structured logging library for Node.js. It provides a JSON-based logging format and includes features like log levels and serializers. It is similar to @aws-lambda-powertools/logger in terms of structured logging but is more general-purpose.
Pino is a fast JSON logger for Node.js applications. It is designed for high performance and low overhead. While it offers similar structured logging capabilities, it is more focused on performance compared to @aws-lambda-powertools/logger.
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 Lambda 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 logging package for the Powertools for AWS Lambda (TypeScript) library
The npm package @aws-lambda-powertools/logger receives a total of 274,960 weekly downloads. As such, @aws-lambda-powertools/logger popularity was classified as popular.
We found that @aws-lambda-powertools/logger 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
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.