Skip to content

docs(logger): new get_correlation_id method #545

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.

Sign up for GitHub

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 1 commit into from
Jul 20, 2021
Merged

docs(logger): new get_correlation_id method #545

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions docs/core/logger.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,8 @@ When debugging in non-production environments, you can instruct Logger to log th

You can set a Correlation ID using `correlation_id_path` param by passing a [JMESPath expression](https://jmespath.org/tutorial.html){target="_blank"}.

!!! tip "You can retrieve correlation IDs via `get_correlation_id` method"

=== "collect.py"

```python hl_lines="5"
Expand All @@ -155,6 +157,7 @@ You can set a Correlation ID using `correlation_id_path` param by passing a [JME

@logger.inject_lambda_context(correlation_id_path="headers.my_request_id_header")
def handler(event, context):
logger.debug(f"Correlation ID => {logger.get_correlation_id()}")
logger.info("Collecting payment")
```

Expand Down Expand Up @@ -198,6 +201,7 @@ We provide [built-in JMESPath expressions](#built-in-correlation-id-expressions)

@logger.inject_lambda_context(correlation_id_path=correlation_paths.API_GATEWAY_REST)
def handler(event, context):
logger.debug(f"Correlation ID => {logger.get_correlation_id()}")
logger.info("Collecting payment")
```

Expand Down