Skip to content

docs: Add warning about ClpKeyValuePairStreamHandler's incompatibility with other handlers. #62

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 4 commits into from
Apr 17, 2025
Merged

docs: Add warning about ClpKeyValuePairStreamHandler's incompatibility with other handlers. #62

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f0015e3
docs: Add warning about ClpKeyValuePairStreamHandler's incompatibilit…
kirkrodrigues Apr 17, 2025
d30dc68
Minor rephrase.
kirkrodrigues Apr 17, 2025
a3caef4
Update README.md
kirkrodrigues Apr 17, 2025
18ad676
Further simplify comment.
kirkrodrigues Apr 17, 2025
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
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ dictionaries, where each dictionary entry must abide by the requirements detaile
[below](#key-value-pair-requirements). The handler will also automatically include certain
[metadata](#automatically-generated-kv-pairs) (e.g., the log event's level) with each log event.

> [!WARNING]
> This handler cannot be used with other logging handlers since it requires the `msg` argument
> passed to the logging method to be a dictionary. In contrast, standard handlers typically treat
> `msg` as a format string. In the future, this handler may be moved or reworked to avoid confusion.

> [!NOTE]
> Since this handler accepts structured log events, it doesn't support setting a
> [Formatter][py-logging-formatter] (because the log events don't need to be formatted into a
Expand Down
Loading