Skip to content

Commit 3be6364

Browse files
committed
docs: update key features
1 parent a63f431 commit 3be6364

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

docs/core/logger.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ Logger provides an opinionated logger with output structured as JSON.
99

1010
* Capturing key fields from the Lambda context, cold starts, and structure logging output as JSON.
1111
* Logging Lambda invocation events when instructed (disabled by default).
12-
* Printing all the logs only for a percentage of invocations via log sampling (disabled by default).
12+
* Switch log level to `DEBUG` for a percentage of invocations (sampling).
13+
* Buffering logs for a specific request or invocation, and flushing them automatically on error or manually as needed.
1314
* Appending additional keys to structured logs at any point in time.
1415
* Providing a custom log formatter (Bring Your Own Formatter) to output logs in a structure compatible with your organization’s Logging RFC.
1516

packages/logger/src/Logger.ts

+6-4
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,12 @@ import type {
4141
* The Logger utility provides an opinionated logger with output structured as JSON for AWS Lambda.
4242
*
4343
* **Key features**
44-
* * Capture key fields from AWS Lambda context, cold start, and structure log output as JSON
45-
* * Append additional keys to one or all log items
46-
* * Switch log level to `DEBUG` based on a sample rate value for a percentage of invocations
47-
* * Ability to buffer logs in memory and flush them when there's an error
44+
* Capturing key fields from the Lambda context, cold starts, and structure logging output as JSON.
45+
* Logging Lambda invocation events when instructed (disabled by default).
46+
* Switch log level to `DEBUG` for a percentage of invocations (sampling).
47+
* Buffering logs for a specific request or invocation, and flushing them automatically on error or manually as needed.
48+
* Appending additional keys to structured logs at any point in time.
49+
* Providing a custom log formatter (Bring Your Own Formatter) to output logs in a structure compatible with your organization’s Logging RFC.
4850
*
4951
* After initializing the Logger class, you can use the methods to log messages at different levels.
5052
*

0 commit comments

Comments
 (0)