[improvement] : fix logging for controllers #1844
Open
Conversation
This file contains hidden or 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
rahulait
requested review from
ArangoGutierrez,
cdesiniotis,
elezar,
shivamerla and
tariq1890
as code owners
Signed-off-by: Rahul Sharma <[email protected]>
|
/ok to test 0e2492a |
rahulait
changed the title
cdesiniotis
reviewed
Nov 5, 2025
cdesiniotis
reviewed
Nov 5, 2025
Comment on lines
+103
to
+104
| err = fmt.Errorf("error getting ClusterPolicy list: %w", err) | ||
| logger.Error(err, "error getting ClusterPolicy list") |
There was a problem hiding this comment.
Did you mean
Suggested change
| err = fmt.Errorf("error getting ClusterPolicy list: %w", err) | |
| logger.Error(err, "error getting ClusterPolicy list") | |
| wrappedError := fmt.Errorf("error getting ClusterPolicy list: %w", err) | |
| logger.Error(err, "error getting ClusterPolicy list") |
to align with the similar code block from above?
| err = fmt.Errorf("no ClusterPolicy object found in the cluster") | ||
| logger.V(consts.LogLevelError).Error(nil, err.Error()) | ||
| err := fmt.Errorf("no ClusterPolicy object found in the cluster") | ||
| logger.Error(err, "no ClusterPolicy object found in the cluster") |
There was a problem hiding this comment.
Question: What will get printed here? I assume our message will be printed twice?
| err = r.Update(ctx, node) | ||
| if err != nil { | ||
| r.Log.V(consts.LogLevelError).Error( | ||
| r.Log.Error( |
There was a problem hiding this comment.
nit: can we update this to just be one line?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR improves the error logging for various controllers. Changes include:
r.Log.V(consts.LogLevelDebug).Errortor.log.Erroras logr doesn't have verbosity levels for Error messages. Error messages are always logged. https://pkg.go.dev/github.com/go-logr/logr#hdr-Verbosity%winstead of%vwhen doing error wrapping so that entire error object gets wrapped and any helper functions likeapierrors.IsNotFound(err)can look into wrapped error as well to identify the error correctly. Previously, since%vwas used, these helper functions would have failed to correctly identify the wrapped error.return ctrl.Result{RequeueAfter: time.Second * 5}, statusErrortoreturn ctrl.Result{}, statusErroras the fixed retry interval gets ignored if returned error is not nil. https://pkg.go.dev/sigs.k8s.io/[email protected]/pkg/reconcile#TypedReconciler