terror: print the stack in terror.Log() #803
Merged
Conversation
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
In TiDB, terror.Log(err) is called when we expect the error to be nil and get rid of the annoying golint check. Sometimes the error is not nil as expected, so it"s better to print the stack to find why
lysu
reviewed
Apr 9, 2020
That"s enough for us to modify the code (identify the incorrect |
Codecov Report
@@ Coverage Diff @@
## master #803 +/- ##
==========================================
+ Coverage 78.22% 78.23% +0.01%
==========================================
Files 40 40
Lines 14700 14700
==========================================
+ Hits 11499 11501 +2
+ Misses 2520 2519 -1
+ Partials 681 680 -1 |
kennytm
reviewed
Apr 10, 2020
terror/terror.go
Outdated
Comment on lines
364
to
366
| var buf [4096]byte | ||
| sz := runtime.Stack(buf[:], false) | ||
| log.Error("encountered error", zap.Error(err), zap.String("stack", string(buf[:sz]))) |
There was a problem hiding this comment.
Perhaps easier to just do
Suggested change
| var buf [4096]byte | |
| sz := runtime.Stack(buf[:], false) | |
| log.Error("encountered error", zap.Error(err), zap.String("stack", string(buf[:sz]))) | |
| log.Error("encountered error", zap.Error(errors.Trace(err))) |
or do we really need the exact stack where Log is called 🤔
There was a problem hiding this comment.
Yes, we need it!
We need the call stack to identify the misuse of terror.Log(). @kennytm
There was a problem hiding this comment.
@tiancaiamao Ah ok. In that case errors.Trace isn"t suitable since it won"t replace the error"s stack if it already exists. We should use errors.WithStack
tiancaiamao
added a commit
to tiancaiamao/parser
that referenced
this pull request
Apr 27, 2021
* terror: print the stack in terror.Log() In TiDB, terror.Log(err) is called when we expect the error to be nil and get rid of the annoying golint check. Sometimes the error is not nil as expected, so it"s better to print the stack to find why * go fmt * address comment * address comment
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.
In TiDB,
terror.Log(err)is called when we expect the error to be nil and get rid of the annoying golint check.Sometimes the error is not nil as expected, so it"s better to print the stack to find why.
PTAL @lysu @kennytm