-
Notifications
You must be signed in to change notification settings - Fork 154
feat(logger): middy middleware #313
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 7 commits
1e1fcbc
63eb569
8b6e2bb
7a75988
b3154be
0fbbccc
abfcf43
497cc3d
5cfdc42
fcb4a90
db6ad64
d91f6aa
212b0d1
9f7fdcd
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -70,23 +70,22 @@ Key | Example | Note | |
|
||
You can enrich your structured logs with key Lambda context information in multiple ways. | ||
|
||
Method 1, using a class decorator: | ||
Method 1, using a [Middy](https://github.com/middyjs/middy) middleware: | ||
|
||
=== "handler.ts" | ||
|
||
```typescript hl_lines="7" | ||
```typescript hl_lines="2 10-11" | ||
import { Logger } from "@aws-lambda-powertools/logger"; | ||
import { injectLambdaContext } from '@aws-lambda-powertools/logger/middleware/middy'; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should we expose it at Top level, such as |
||
|
||
const logger = new Logger(); | ||
|
||
class Lambda { | ||
|
||
@logger.injectLambdaContext() | ||
public handler() { | ||
logger.info("This is an INFO log with some context"); | ||
} | ||
|
||
} | ||
const lambdaHandler = async () => { | ||
logger.info("This is an INFO log with some context"); | ||
}; | ||
|
||
const handler = middy(lambdaHandler) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. middy not defined |
||
.use(injectLambdaContext(logger)); | ||
``` | ||
|
||
Method 2, calling the `addContext` method: | ||
|
@@ -107,6 +106,25 @@ Method 2, calling the `addContext` method: | |
}; | ||
``` | ||
|
||
Method 3, using a class decorator: | ||
|
||
=== "handler.ts" | ||
|
||
```typescript hl_lines="7" | ||
import { Logger } from "@aws-lambda-powertools/logger"; | ||
|
||
const logger = new Logger(); | ||
|
||
class Lambda { | ||
|
||
@logger.injectLambdaContext() | ||
public handler() { | ||
logger.info("This is an INFO log with some context"); | ||
} | ||
|
||
} | ||
``` | ||
|
||
In both case, the printed log will look like this: | ||
|
||
=== "Example CloudWatch Logs excerpt" | ||
|
@@ -116,7 +134,7 @@ In both case, the printed log will look like this: | |
"cold_start": true, | ||
"function_arn": "arn:aws:lambda:eu-central-1:123456789012:function:shopping-cart-api-lambda-prod-eu-central-1", | ||
"function_memory_size": 128, | ||
"function_request_id": "c6af9ac6-7b61-11e6-9a41-93e8deadbeef", | ||
"function_request_id": "c6af9ac6-7b61-11e6-9a41-93e812345678", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Small change I did in this PR: removed all these weird "deadbeef" references |
||
"function_name": "shopping-cart-api-lambda-prod-eu-central-1", | ||
"level": "INFO", | ||
"message": "This is an INFO log with some context", | ||
|
@@ -134,7 +152,7 @@ Key | Example | |
**function_name** `string` | `shopping-cart-api-lambda-prod-eu-central-1` | ||
**function_memory_size**: `int` | `128` | ||
**function_arn**: `string` | `arn:aws:lambda:eu-central-1:123456789012:function:shopping-cart-api-lambda-prod-eu-central-1` | ||
**function_request_id**: `string` | `c6af9ac6-7b61-11e6-9a41-93e8deadbeef` | ||
**function_request_id**: `string` | `c6af9ac6-7b61-11e6-9a41-93e812345678` | ||
|
||
### Appending persistent additional log keys and values | ||
|
||
|
@@ -558,7 +576,7 @@ This is how the printed log would look: | |
"service": "shopping-cart-api", | ||
"awsRegion": "eu-central-1", | ||
"correlationIds": { | ||
"awsRequestId": "c6af9ac6-7b61-11e6-9a41-93e8deadbeef", | ||
"awsRequestId": "c6af9ac6-7b61-11e6-9a41-93e812345678", | ||
"xRayTraceId": "abcdef123456abcdef123456abcdef123456", | ||
"myCustomCorrelationId": "foo-bar-baz" | ||
}, | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed this: https://github.com/awslabs/aws-lambda-powertools-typescript/runs/4542223081?check_suite_focus=true
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh nice catch