Add required conditions for Logger's metadata to be print #13777
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
whatyouhide
approved these changes
Aug 12, 2024
lib/logger/lib/logger/formatter.ex
Outdated
| @@ -74,6 +74,18 @@ defmodule Logger.Formatter do | |||
| to the current process. The user can configure the backend to choose | |||
| which metadata it wants to print and it will replace the `$metadata` | |||
| value. | |||
|
|
|||
| > #### Disclaimer {: .warning} | |||
There was a problem hiding this comment.
Suggested change
| > #### Disclaimer {: .warning} | |
| > #### When is user metadata printed? {: .warning} |
lib/logger/lib/logger/formatter.ex
Outdated
Comment on lines
81
to
82
| > * Be a string (match with the `is_binary/1` guard) | ||
| > * Be a number (either match with the `is_integer/1` or `is_float/1` guard) |
There was a problem hiding this comment.
Suggested change
| > * Be a string (match with the `is_binary/1` guard) | |
| > * Be a number (either match with the `is_integer/1` or `is_float/1` guard) | |
| > * Be a string (`is_binary/1`) | |
| > * Be a number (either `is_integer/1` or `is_float/1`) |
lib/logger/lib/logger/formatter.ex
Outdated
| > User's metadata must meet one of the following conditions to be printed: | ||
| > * Be a string (match with the `is_binary/1` guard) | ||
| > * Be a number (either match with the `is_integer/1` or `is_float/1` guard) | ||
| > * Be a pid |
There was a problem hiding this comment.
Suggested change
| > * Be a pid | |
| > * Be a PID |
lib/logger/lib/logger/formatter.ex
Outdated
| > * Be a reference | ||
| > * Be a port | ||
| > * Implement the `String.Chars` protocol | ||
| > otherwise the given metadata will be discarded. |
There was a problem hiding this comment.
Suggested change
| > otherwise the given metadata will be discarded. | |
| > | |
| > If none of the conditions above are true, the given metadata gets discarded. |
whatyouhide
changed the title
josevalim
reviewed
Aug 12, 2024
|
💚 💙 💜 💛 ❤️ |
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.
Addresses #13772