Skip to content

docs(logger): document enriching logs with logrecord attributes #1271

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 6 commits into from
Jul 1, 2022
Merged

docs(logger): document enriching logs with logrecord attributes #1271

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7505fcb
docs(logger): document enriching logs with logrecord attributes
kbakk Jul 1, 2022
f2a24d2
docs(logger): write Powertools with Capitalization
kbakk Jul 1, 2022
3175731
docs(logger): shorten sentences for readability
kbakk Jul 1, 2022
3e5ba84
docs(logger): fix incorrect function name
kbakk Jul 1, 2022
fe34e7a
docs(logger): Use headers for FAQ section
kbakk Jul 1, 2022
abecfb5
docs(logger): be consistent in use of "Powertools Logger"
kbakk Jul 1, 2022
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
Prev Previous commit
Next Next commit
docs(logger): Use headers for FAQ section
  • Loading branch information
@kbakk
kbakk committed Jul 1, 2022
commit fe34e7a0ed32b51e68161b040d92eae34099d314
10 changes: 5 additions & 5 deletions docs/core/logger.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -585,7 +585,7 @@ POWERTOOLS_LOG_DEDUPLICATION_DISABLED="1" pytest -o log_cli=1

## FAQ

**How can I enable boto3 and botocore library logging?**
### How can I enable boto3 and botocore library logging?

You can enable the `botocore` and `boto3` logs by using the `set_stream_logger` method, this method will add a stream handler
for the given name and level to the logging module. By default, this logs all boto3 messages to stdout.
Expand All @@ -594,7 +594,7 @@ for the given name and level to the logging module. By default, this logs all bo
---8<-- "examples/logger/src/enabling_boto_logging.py"
```

**How can I enable Powertools logging for imported libraries?**
### How can I enable Powertools logging for imported libraries?

You can copy the Logger setup to all or sub-sets of registered external loggers. Use the `copy_config_to_registered_logger` method to do this.

Expand All @@ -604,7 +604,7 @@ By default all registered loggers will be modified. You can change this behavior
---8<-- "examples/logger/src/cloning_logger_config.py"
```

**How can I add standard library logging attributes to a log record?**
### How can I add standard library logging attributes to a log record?

The Python standard library log records contains a [large set of atttributes](https://docs.python.org/3/library/logging.html#logrecord-attributes){target="_blank"}, however only a few are included in Powertools Logger log record by default.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Nit, but.... "Powertools Logger" instead of `Powertools Logger"?

Suggested change
The Python standard library log records contains a [large set of atttributes](https://docs.python.org/3/library/logging.html#logrecord-attributes){target="_blank"}, however only a few are included in Powertools Logger log record by default.
The Python standard library log records contains a [large set of atttributes](https://docs.python.org/3/library/logging.html#logrecord-attributes){target="_blank"}, however only a few are included in Powertools `Logger` log record by default.

Copy link
Contributor

Choose a reason for hiding this comment

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

I see why it'd make sense, but it'd be difficult to stay consistent over time - let's keep Powertools Logger. At least until we explore tools like Vale.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sounds good. I think this is ready to merge then.


Expand All @@ -625,7 +625,7 @@ You can also add them later anywhere in your code with `append_keys`, or remove

For log records originating from Powertools `Logger`, the `name` attribute will be the same as `service`, for log records coming from standard library logger, it will be the name of the logger (i.e. what was used as name argument to `logging.getLogger`).

**What's the difference between `append_keys` and `extra`?**
### What's the difference between `append_keys` and `extra`?

Keys added with `append_keys` will persist across multiple log messages while keys added via `extra` will only be available in a given log message operation.

Expand All @@ -643,6 +643,6 @@ Here's an example where we persist `payment_id` not `request_id`. Note that `pay
---8<-- "examples/logger/src/append_keys_vs_extra_output.json"
```

**How do I aggregate and search Powertools logs across accounts?**
### How do I aggregate and search Powertools logs across accounts?

As of now, ElasticSearch (ELK) or 3rd party solutions are best suited to this task. Please refer to this [discussion for more details](https://github.com/awslabs/aws-lambda-powertools-python/issues/460)