-
Notifications
You must be signed in to change notification settings - Fork 4.4k
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.
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
Documentation: create doc describing grpc-go's log levels and their usages #2033
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# Log Levels | ||
|
||
This document describes the different log levels supported by the grpc-go | ||
library, and under what conditions they should be used. | ||
|
||
### Info | ||
|
||
Info messages are for informational purposes and may aid in the debugging of | ||
applications or the gRPC library. | ||
|
||
Examples: | ||
- The name resolver received an update. | ||
- The balancer updated its picker. | ||
- Significant gRPC state is changing. | ||
|
||
At verbosity of 0 (the default), any single info message should not be output | ||
more than once every 5 minutes under normal operation. | ||
|
||
### Warning | ||
|
||
Warning messages indicate problems that are non-fatal for the application, but | ||
could lead to unexpected behavior or subsequent errors. | ||
|
||
Examples: | ||
- Resolver could not resolve target name. | ||
- Error received while connecting to a server. | ||
- Lost or corrupt connection with remote endpoint. | ||
|
||
### Error | ||
|
||
Error messages represent errors in the usage of gRPC that cannot be returned to | ||
the application as errors, or internal gRPC-Go errors that are recoverable. | ||
|
||
Internal errors are detected during gRPC tests and will result in test failures. | ||
|
||
Examples: | ||
- Invalid arguments passed to a function that cannot return an error. | ||
- An internal error that cannot be returned or would be inappropriate to return | ||
to the user. | ||
|
||
### Fatal | ||
|
||
Fatal errors are severe internal errors that are unrecoverable. These lead | ||
directly to panics, and are avoided as much as possible. | ||
|
||
Example: | ||
- Internal invariant was violated. | ||
- User attempted an action that cannot return an error gracefully, but would | ||
lead to an invalid state if performed. |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TLS makes things tricky again...
What if the connection failed because TLS misconfigure?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That sounds like a warning to me, what do you think?