subscriber: Add note about potential misuse of stdout to documentation #3266
Conversation
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.
Motivation
As noted in #2492 logging to
stdoutinstead ofstderrby default is just plain wrong.It goes against established conventions and also increases the risk of bugs caused by mixing program output with diagnostics.
But since changing a default is (rightly) considered a breaking change this cannot be fixed until version
0.4.Solution
Simply add a note to the documentation to make it very clear to users that the defaults are probably not what the are expecting and to discourage applications depending on
tracing-subscriberfrom inheriting this default.