refactor: refactor the logs of lvmcluster controller #137
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
leelavg
reviewed
Mar 31, 2022
There was a problem hiding this comment.
- general observation, do we need to log error/info in both call and execution site (ex:
getRunningPodImage)? - it seems PR increased number of info level logs, (ex:
openshiftsccs) - when we debug issues, we first jump into error site and go up the stack and logging similar errors may not be helpful always (this is only my opinion)
nbalacha
reviewed
Mar 31, 2022
controllers/lvmcluster_controller.go
Outdated
| @@ -183,7 +186,8 @@ func (r *LVMClusterReconciler) reconcile(ctx context.Context, instance *lvmv1alp | |||
| for _, unit := range resourceCreationList { | |||
| err := unit.ensureCreated(r, ctx, instance) | |||
| if err != nil { | |||
| return ctrl.Result{}, fmt.Errorf("failed reconciling: %s %w", unit.getName(), err) | |||
| r.Log.Error(err, "failed reconciling", "Resource", unit.getName()) | |||
There was a problem hiding this comment.
This is actually changing the error being returned, right?
There was a problem hiding this comment.
yes I know, We should return an original error IMO as that can be used to determine the error in the caller's place.
controllers/lvmcluster_controller.go
Outdated
| } | ||
|
|
||
| pod := &corev1.Pod{} | ||
| if err := r.Get(ctx, types.NamespacedName{Name: podName, Namespace: r.Namespace}, pod); err != nil { | ||
| return fmt.Errorf("failed to get pod %s in namespace %s", podName, r.Namespace) | ||
| r.Log.Error(err, "Failed to get pod.") |
There was a problem hiding this comment.
Will this include information about the pod that was requested?
There was a problem hiding this comment.
Yes error will have it, This is the error which gets generated pods "test" not found when I ran the below code.
pod := &corev1.Pod{}
err = fakeReconciler.Client.Get(context.TODO(), types.NamespacedName{Name: "test", Namespace: "test"}, pod)
fmt.Println(err)
|
|
Can the following be done?
|
iamniting
force-pushed
the
log
branch
4 times, most recently
from
f7db3db to
097c59a
Compare
made most of the changes, pls take a look. |
leelavg
reviewed
Apr 5, 2022
| @@ -324,10 +340,11 @@ func (r *LVMClusterReconciler) getRunningPodImage(ctx context.Context) error { | |||
| } | |||
| } | |||
|
|
|||
| return fmt.Errorf("failed to get container image for %s in pod %s", LVMOperatorContainerName, podName) | |||
| err := fmt.Errorf("failed to get container image for %s in pod %s", LVMOperatorContainerName, podName) | |||
| r.Log.Error(err, "container image not found") | |||
There was a problem hiding this comment.
- we need
LVMOperatorContainerNamein log as well to know we are looking for correct container or not
There was a problem hiding this comment.
We already have if you see above created err.
controllers/lvmcluster_controller.go
Outdated
| } | ||
|
|
||
| pod := &corev1.Pod{} | ||
| if err := r.Get(ctx, types.NamespacedName{Name: podName, Namespace: r.Namespace}, pod); err != nil { | ||
| return fmt.Errorf("failed to get pod %s in namespace %s", podName, r.Namespace) | ||
| r.Log.Error(err, "failed to get pod") |
There was a problem hiding this comment.
- better log at-least pod name
There was a problem hiding this comment.
err will have it, but still i added in the logs again.
nbalacha
suggested changes
Apr 6, 2022
controllers/lvmcluster_controller.go
Outdated
| @@ -183,7 +186,8 @@ func (r *LVMClusterReconciler) reconcile(ctx context.Context, instance *lvmv1alp | |||
| for _, unit := range resourceCreationList { | |||
| err := unit.ensureCreated(r, ctx, instance) | |||
| if err != nil { | |||
| return ctrl.Result{}, fmt.Errorf("failed reconciling: %s %w", unit.getName(), err) | |||
| r.Log.Error(err, "failed reconciling", "resource", unit.getName()) | |||
There was a problem hiding this comment.
Suggested change
| r.Log.Error(err, "failed reconciling", "resource", unit.getName()) | |
| r.Log.Error(err, "failed to reconcile", "resource", unit.getName()) |
controllers/lvmcluster_controller.go
Outdated
| } | ||
|
|
||
| pod := &corev1.Pod{} | ||
| if err := r.Get(ctx, types.NamespacedName{Name: podName, Namespace: r.Namespace}, pod); err != nil { | ||
| return fmt.Errorf("failed to get pod %s in namespace %s", podName, r.Namespace) | ||
| r.Log.Error(err, "failed to get pod") |
| @@ -52,14 +52,16 @@ func (c openshiftSccs) ensureCreated(r *LVMClusterReconciler, ctx context.Contex | |||
| r.Log.Info("creating SecurityContextConstraint", "SecurityContextConstraint", scc.Name) | |||
| _, err := r.SecurityClient.SecurityContextConstraints().Create(ctx, scc, metav1.CreateOptions{}) | |||
| if err != nil { | |||
| return fmt.Errorf("failed to create SCC %q: %v", scc.Name, err) | |||
There was a problem hiding this comment.
Please include the scc name in the error and the log
There was a problem hiding this comment.
err will already have it, But I have added it again in the logs.
Signed-off-by: Nitin Goyal <[email protected]>
nbalacha
approved these changes
Apr 7, 2022
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: iamniting, leelavg, nbalacha The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci
bot
added
the
approved
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.
Signed-off-by: Nitin Goyal [email protected]