Repository navigation
docs: explain structured logging contract motivation - #91
Merged
Merged
Conversation
Owner
Author
|
🎉 This PR is included in version 1.0.4-rc.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a short motivation before the technical introduction: arbitrary extra fields make downstream searches, alerts, and dashboards harder to maintain; a shared schema provides a producer/consumer contract; valid fields are emitted while data-validation violations are reported separately.
Validation: checked wording against the existing schema contract and strictness guarantees; one README-only commit (+7/-0). Existing logging API wording and technical guarantees are unchanged. No runtime tests run for this documentation-only change.