Use logger from context in Reconcile() #550
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
- with controller-runtime 0.7, Reconcile() takes a context with a logger. The logger is pre populated with controller name, gvk, object name and namespace.
MirahImage
approved these changes
Jan 8, 2021
Zerpet
reviewed
Jan 8, 2021
There was a problem hiding this comment.
We are passing the logger to the helper functions that need to log, in addition to the context. I'm wondering if we could do log.FromContext(ctx) inside the helper functions and get the same logger, given that we are already passing the context to this functions?
Also, remove logger from method signatures since it's already part of context.
|
@ChunyiLyu I took the liberty to push 2 more commits. Feel free to amend or revert if you think they don't make sense :) |
ansd
approved these changes
Jan 8, 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.
Relates to previous PR: #542
Summary Of Changes
With controller-runtime 0.7, Reconcile() takes a context.Context object with a logger. The logger is pre populated with controller name, gvk, object name and namespace. Operator using this logger reduces redundancy because operator no longer needs to create its own logger and it doesn't need to include rmq name and namespace manually in every single log.
Before this change, a sample log could look like:
After this change, the same log will look like:
Additional Context
Related controller runtime PR: kubernetes-sigs/controller-runtime#1054
Local Testing
Unit, integration, and system tests all passed.