Skip to content

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

Merged
merged 14 commits into from
Dec 17, 2021
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/on-push.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
node-version: '14'
- name: Install packages
run: |
npm ci
npm install
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh nice catch

npm run lerna-ci
- name: Run lint
run: npm run lerna-lint
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/on-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
- name: Install packages
run: |
export NODE_ENV=dev
npm ci
npm install
npm run lerna-ci
- name: Run lint
run: npm run lerna-lint
Expand Down
44 changes: 31 additions & 13 deletions docs/core/logger.md
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we expose it at Top level, such as import { Middleware } 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");
}

}
const lambdaHandler = async () => {
logger.info("This is an INFO log with some context");
};

const handler = middy(lambdaHandler)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

middy not defined

.use(injectLambdaContext(logger));
```

Method 2, calling the `addContext` method:
Expand All @@ -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"
Expand All @@ -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",
Copy link
Contributor Author

Choose a reason for hiding this comment

The 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",
Expand All @@ -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

Expand Down Expand Up @@ -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"
},
Expand Down
Loading