contextual logging #597
Merged
contextual logging #597
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
kuritka
requested review from
donovanmuller,
jkremser,
k0da,
somaritane and
ytsarev
as code owners
closes #469 - removing duplicit error message: `log.Err(err).Msgf("...(%s)",err)` I'm replacing with `log.Err(err).Msg("...")` - replacing with contextual message: `log.Info().Msgf("started provider (%s)",reconciler.DNSProvider.String)` I'm replacing with `log.Info().Str("provider", reconciler.DNSProvider.String()).Msg("started")` - I had to extend DNSProvider with Stringer interface. added String() string function Signed-off-by: kuritka <[email protected]>
kuritka
force-pushed
the
contextual-logging
branch
from
5ef03ec to
ea30cd1
Compare
ytsarev
reviewed
Sep 6, 2021
| } | ||
| } | ||
| return | ||
| return targets |
There was a problem hiding this comment.
nothing against(I actually like this style more) but why are we returning explicitly now?
There was a problem hiding this comment.
Hey, good point, mee too, BUT:
golangci-lint run
controllers/providers/assistant/gslb.go:330:2: naked return in func `GetExternalTargets` with 38 lines of code (nakedret)
return
^
make: *** [lint] Error 1The linter basically says, the function is too large to have naked return (nakedret static analysis).
The function was prolonged by splitting the log messages into more lines
log.Warn().
Str("fqdn", fqdn).
Str("nameserver", nameserver).
Err(err).
Msg("Can't resolve FQDN using nameserver")I had three options at the end: satisfy nakedret, refactor the function into two funcs, or leave the logs on one line?
Finally I decided to satisfy nakedret.
ytsarev
approved these changes
Sep 7, 2021
jkremser
approved these changes
Sep 9, 2021
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.
closes #469
log.Err(err).Msgf("...(%s)",err)I'm replacing withlog.Err(err).Msg("...")log.Info().Msgf("started provider (%s)",reconciler.DNSProvider.String)I'm replacing withlog.Info().Str("provider", reconciler.DNSProvider.String()).Msg("started")Signed-off-by: kuritka [email protected]