Refactor failed heartbeats log #1273
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
jakobht
force-pushed
the
failedHeartbeatsLogLevel
branch
from
fa754b4
to
42117b5
Compare
3vilhamster
reviewed
Sep 20, 2023
internal/internal_task_handlers.go
Outdated
| } | ||
| // If the error is a canceled error do not log, as this is expected. | ||
| var canceledErr *CanceledError | ||
| if errors.As(err, &canceledErr) { |
There was a problem hiding this comment.
You need to reverse the check.
3vilhamster
approved these changes
Sep 20, 2023
Groxx
approved these changes
Sep 20, 2023
There was a problem hiding this comment.
yeah - all this code is stranger than I originally thought too :|
logging on workflow-complete and other "stop the activity" cases should be relatively rare in comparison, and we can filter those out later too if we want. or rewrite this code, it seems unlikely to be doing what it should in those situations.
3vilhamster
reviewed
Sep 21, 2023
internal/internal_task_handlers.go
Outdated
| } | ||
| // If the error is a canceled error do not log, as this is expected. | ||
| var canceledErr *CanceledError | ||
| if canceledErr != nil && !errors.As(err, &canceledErr) { |
There was a problem hiding this comment.
canceledErr is always nil and err is checked for nil inside errors.As.
There was a problem hiding this comment.
also, maybe put this into a method and add a test so you are 100% sure about the behaviour.
Something like
i.processHearbeatError(err)
and then add unit test with zaptest.Logger.
3vilhamster
requested changes
Sep 21, 2023
timl3136
pushed a commit
that referenced
this pull request
Nov 4, 2023
* Refactored the log type check * Wrong check - reversed * Added nil check * Added tests, and fixed nil error
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.
What changed?
Refactored the type check to use modern Go
What changed?
In modern go typecasting errors is sometimes not correct as they might be wrapped, the errors.As method is aware of this and checks all wrapped errors
How did you test it?
Tested locally
Potential risks
Worst case we log too much/too little