Skip to content

docs: explain structured logging contract motivation #91

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
disafronov merged 1 commit into from
Oct 25, 2026
Merged

docs: explain structured logging contract motivation #91

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
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# python-logging-objects-with-schema

Arbitrary `extra` fields let log producers use different names, structures, and
types for the same information, making downstream searches, alerts, and
dashboards harder to maintain. A shared schema makes these structured fields a
contract between producers and consumers. `SchemaLogger` emits the valid fields
and reports data-validation violations separately, so a malformed field does
not discard the valid part of the record.

`SchemaLogger` extends Python's standard `logging.Logger` with schema-driven
validation and projection of `extra` fields. It preserves the standard logging
API while invalid structured data is dropped and reported separately.
Expand Down
Loading