Skip to content

Commit 1c07d46

Browse files
k4r1ggkhrmv
k4r1
and
ggkhrmv
authored
fix(logging): Wire up logging for each Reconciler (#50)
Signed-off-by: Karl Taylor <[email protected]> Co-authored-by: Gosha <[email protected]>
1 parent c485f00 commit 1c07d46

File tree

3 files changed

+33
-29
lines changed

3 files changed

+33
-29
lines changed

‎cmd/main.go‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,7 @@ func main() {
135135
Scheme: mgr.GetScheme(),
136136
ArgoCDRBACConfigMapName: argoCDRBACConfigMapName,
137137
ArgoCDRBACConfigMapNamespace: argoCDRBACConfigMapNamespace,
138+
Log: ctrl.Log.WithName("controllers").WithName("ArgoCDRole"),
138139
}).SetupWithManager(mgr); err != nil {
139140
setupLog.Error(err, "unable to create controller", "controller", "Role")
140141
os.Exit(1)
@@ -144,12 +145,14 @@ func main() {
144145
Scheme: mgr.GetScheme(),
145146
ArgoCDRBACConfigMapName: argoCDRBACConfigMapName,
146147
ArgoCDRBACConfigMapNamespace: argoCDRBACConfigMapNamespace,
148+
Log: ctrl.Log.WithName("controllers").WithName("ArgoCDRoleBinding"),
147149
}).SetupWithManager(mgr); err != nil {
148150
setupLog.Error(err, "unable to create controller", "controller", "ArgoCDRoleBinding")
149151
os.Exit(1)
150152
}
151153
if err := (&controller.ArgoCDProjectRoleReconciler{
152154
Client: mgr.GetClient(),
155+
Log: ctrl.Log.WithName("controllers").WithName("ArgoCDProjectRole"),
153156
Scheme: mgr.GetScheme(),
154157
}).SetupWithManager(mgr); err != nil {
155158
setupLog.Error(err, "unable to create controller", "controller", "ArgoCDProjectRole")
@@ -158,6 +161,7 @@ func main() {
158161
if err := (&controller.ArgoCDProjectRoleBindingReconciler{
159162
Client: mgr.GetClient(),
160163
Scheme: mgr.GetScheme(),
164+
Log: ctrl.Log.WithName("controllers").WithName("ArgoCDProjectRoleBinding"),
161165
}).SetupWithManager(mgr); err != nil {
162166
setupLog.Error(err, "unable to create controller", "controller", "ArgoCDProjectRoleBinding")
163167
os.Exit(1)

‎internal/controller/argocdrole_controller.go‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -55,30 +55,30 @@ type ArgoCDRoleReconciler struct {
5555
func (r *ArgoCDRoleReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
5656
_ = r.Log.WithValues("argocdrole", req.NamespacedName)
5757

58-
r.Log.Info("Reconciling ArgoCDRole %s", req.Name)
58+
r.Log.Info("Reconciling ArgoCDRole", "name", req.Name)
5959

6060
var role rbacoperatorv1alpha1.ArgoCDRole
6161
if err := r.Get(ctx, req.NamespacedName, &role); err != nil {
6262
if errors.IsNotFound(err) {
63-
r.Log.Info("ArgoCDRole %s not found.", req.Name)
63+
r.Log.Info("ArgoCDRole not found.", "name", req.Name)
6464
return ctrl.Result{}, nil
6565
}
6666
role.SetConditions(rbacoperatorv1alpha1.ReconcileError(err))
6767
if err := r.Client.Status().Update(ctx, &role); err != nil {
68-
r.Log.Error(err, "Failed to update ArgoCDRole %s status", req.Name)
68+
r.Log.Error(err, "Failed to update ArgoCDRole status", "name", req.Name)
6969
}
7070
return ctrl.Result{}, err
7171
}
7272

7373
if role.IsBeingDeleted() {
7474
if err := r.handleFinalizer(ctx, &role); err != nil {
7575
if errors.IsConflict(err) {
76-
r.Log.Info("Conflict while handling finalizer for ArgoCDRole %s, requeuing", req.Name)
76+
r.Log.Info("Conflict while handling finalizer for ArgoCDRole", "name", req.Name)
7777
return ctrl.Result{Requeue: true, RequeueAfter: time.Second}, nil
7878
}
7979
role.SetConditions(rbacoperatorv1alpha1.Deleting().WithMessage(err.Error()))
8080
if err := r.Client.Status().Update(ctx, &role); err != nil {
81-
r.Log.Error(err, "Failed to update ArgoCDRole %s status", req.Name)
81+
r.Log.Error(err, "Failed to update ArgoCDRole status", "name", req.Name)
8282
}
8383
return ctrl.Result{}, fmt.Errorf("error when handling finalizer: %v", err)
8484
}
@@ -89,7 +89,7 @@ func (r *ArgoCDRoleReconciler) Reconcile(ctx context.Context, req ctrl.Request)
8989
if err := r.addFinalizer(ctx, &role); err != nil {
9090
role.SetConditions(rbacoperatorv1alpha1.Deleting().WithMessage(err.Error()))
9191
if err := r.Client.Status().Update(ctx, &role); err != nil {
92-
r.Log.Error(err, "Failed to update ArgoCDRole %s status", req.Name)
92+
r.Log.Error(err, "Failed to update ArgoCDRole status", "name", req.Name)
9393
}
9494
return ctrl.Result{}, fmt.Errorf("error when adding finalizer: %v", err)
9595
}
@@ -102,7 +102,7 @@ func (r *ArgoCDRoleReconciler) Reconcile(ctx context.Context, req ctrl.Request)
102102
if !IsObjectFound(r.Client, cm.Namespace, cm.Name, cm) {
103103
role.SetConditions(rbacoperatorv1alpha1.Pending(fmt.Errorf("ConfigMap %s not found", cm.Name)))
104104
if err := r.Client.Status().Update(ctx, &role); err != nil {
105-
r.Log.Error(err, "Failed to update ArgoCDRole %s status", req.Name)
105+
r.Log.Error(err, "Failed to update ArgoCDRole status", "name", req.Name)
106106
}
107107
return ctrl.Result{Requeue: true, RequeueAfter: time.Second}, fmt.Errorf("ConfigMap not found")
108108
}
@@ -116,10 +116,10 @@ func (r *ArgoCDRoleReconciler) Reconcile(ctx context.Context, req ctrl.Request)
116116
}
117117
if err := r.Get(ctx, typeNamespacedNameRoleBinding, &rb); err != nil {
118118
if errors.IsNotFound(err) {
119-
r.Log.Info("ArgoCDRoleBinding %s not found.", role.Status.ArgoCDRoleBindingRef)
119+
r.Log.Info("ArgoCDRoleBinding not found.", "name", role.Status.ArgoCDRoleBindingRef)
120120
role.SetConditions(rbacoperatorv1alpha1.ReconcileError(err))
121121
if err := r.Client.Status().Update(ctx, &role); err != nil {
122-
r.Log.Error(err, "Failed to update ArgoCDRole %s status", req.Name)
122+
r.Log.Error(err, "Failed to update ArgoCDRole status", "name", req.Name)
123123
}
124124
return ctrl.Result{}, err
125125
}
@@ -129,34 +129,34 @@ func (r *ArgoCDRoleReconciler) Reconcile(ctx context.Context, req ctrl.Request)
129129
if err := r.reconcileRBACConfigMapWithRoleBinding(cm, &role, &rb); err != nil {
130130
role.SetConditions(rbacoperatorv1alpha1.ReconcileError(err))
131131
if err := r.Client.Status().Update(ctx, &role); err != nil {
132-
r.Log.Error(err, "Failed to update ArgoCDRole %s status", req.Name)
132+
r.Log.Error(err, "Failed to update ArgoCDRole status", "name", req.Name)
133133
}
134134
return ctrl.Result{Requeue: true, RequeueAfter: time.Second}, err
135135
}
136136

137137
role.SetConditions(rbacoperatorv1alpha1.ReconcileSuccess().WithObservedGeneration(role.GetGeneration()))
138138
if err := r.Client.Status().Update(ctx, &role); err != nil {
139-
r.Log.Error(err, "Failed to update ArgoCDRole %s status", req.Name)
139+
r.Log.Error(err, "Failed to update ArgoCDRole status", "name", req.Name)
140140
}
141141
return ctrl.Result{RequeueAfter: time.Minute * 10}, nil
142142
}
143143

144144
r.Log.Info("Reconciling RBAC ConfigMap")
145145
if err := r.reconcileRBACConfigMap(cm, &role); err != nil {
146146
if errors.IsConflict(err) {
147-
r.Log.Info("Conflict while reconciling RBAC ConfigMap, requeuing ArgoCDRole %s", req.Name)
147+
r.Log.Info("Conflict while reconciling RBAC ConfigMap, requeuing ArgoCDRole", "name", req.Name)
148148
return ctrl.Result{RequeueAfter: time.Second}, nil
149149
}
150150
role.SetConditions(rbacoperatorv1alpha1.ReconcileError(err))
151151
if err := r.Client.Status().Update(ctx, &role); err != nil {
152-
r.Log.Error(err, "Failed to update ArgoCDRole %s status", req.Name)
152+
r.Log.Error(err, "Failed to update ArgoCDRole status", "name", req.Name)
153153
}
154154
return ctrl.Result{Requeue: true, RequeueAfter: time.Second}, err
155155
}
156156

157157
role.SetConditions(rbacoperatorv1alpha1.ReconcileSuccess().WithObservedGeneration(role.GetGeneration()))
158158
if err := r.Client.Status().Update(ctx, &role); err != nil {
159-
r.Log.Error(err, "Failed to update ArgoCDRole %s status", req.Name)
159+
r.Log.Error(err, "Failed to update ArgoCDRole status", "name", req.Name)
160160
}
161161
return ctrl.Result{RequeueAfter: time.Minute * 10}, nil
162162
}

‎internal/controller/argocdrolebinding_controller.go‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -53,30 +53,30 @@ type ArgoCDRoleBindingReconciler struct {
5353
func (r *ArgoCDRoleBindingReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
5454
_ = r.Log.WithValues("argocdrole", req.NamespacedName)
5555

56-
r.Log.Info("Reconciling ArgoCDRoleBinding %s", req.Name)
56+
r.Log.Info("Reconciling ArgoCDRoleBinding", "name", req.Name)
5757

5858
var rb rbacoperatorv1alpha1.ArgoCDRoleBinding
5959
if err := r.Get(ctx, req.NamespacedName, &rb); err != nil {
6060
if errors.IsNotFound(err) {
61-
r.Log.Info("ArgoCDRoleBinding %s not found.", req.Name)
61+
r.Log.Info("ArgoCDRoleBinding not found.", "name", req.Name)
6262
return ctrl.Result{}, nil
6363
}
6464
rb.SetConditions(rbacoperatorv1alpha1.ReconcileError(err))
6565
if err := r.Client.Status().Update(ctx, &rb); err != nil {
66-
r.Log.Error(err, "Failed to update ArgoCDRoleBinding %s status", req.Name)
66+
r.Log.Error(err, "Failed to update ArgoCDRoleBinding status", "name", req.Name)
6767
}
6868
return ctrl.Result{}, err
6969
}
7070

7171
if rb.IsBeingDeleted() {
7272
if err := r.handleFinalizer(ctx, &rb); err != nil {
7373
if errors.IsConflict(err) {
74-
r.Log.Info("Conflict while handling finalizer, requeuing ArgoCDRoleBinding %s", req.Name)
74+
r.Log.Info("Conflict while handling finalizer, requeuing ArgoCDRoleBinding", "name", req.Name)
7575
return ctrl.Result{RequeueAfter: time.Second}, nil
7676
}
7777
rb.SetConditions(rbacoperatorv1alpha1.Deleting().WithMessage(err.Error()))
7878
if err := r.Client.Status().Update(ctx, &rb); err != nil {
79-
r.Log.Error(err, "Failed to update ArgoCDRoleBinding %s status", req.Name)
79+
r.Log.Error(err, "Failed to update ArgoCDRoleBinding status", "name", req.Name)
8080
}
8181
return ctrl.Result{}, fmt.Errorf("error when handling finalizer: %v", err)
8282
}
@@ -87,7 +87,7 @@ func (r *ArgoCDRoleBindingReconciler) Reconcile(ctx context.Context, req ctrl.Re
8787
if err := r.addFinalizer(ctx, &rb); err != nil {
8888
rb.SetConditions(rbacoperatorv1alpha1.Deleting().WithMessage(err.Error()))
8989
if err := r.Client.Status().Update(ctx, &rb); err != nil {
90-
r.Log.Error(err, "Failed to update ArgoCDRoleBinding %s status", req.Name)
90+
r.Log.Error(err, "Failed to update ArgoCDRoleBinding status", "name", req.Name)
9191
}
9292
return ctrl.Result{}, fmt.Errorf("error when adding finalizer: %v", err)
9393
}
@@ -100,7 +100,7 @@ func (r *ArgoCDRoleBindingReconciler) Reconcile(ctx context.Context, req ctrl.Re
100100
if !IsObjectFound(r.Client, cm.Namespace, cm.Name, cm) {
101101
rb.SetConditions(rbacoperatorv1alpha1.Pending(fmt.Errorf("ConfigMap %s not found", cm.Name)))
102102
if err := r.Client.Status().Update(ctx, &rb); err != nil {
103-
r.Log.Error(err, "Failed to update ArgoCDRoleBinding %s status", req.Name)
103+
r.Log.Error(err, "Failed to update ArgoCDRoleBinding status", "name", req.Name)
104104
}
105105
return ctrl.Result{Requeue: true, RequeueAfter: time.Second}, fmt.Errorf("ConfigMap not found")
106106
}
@@ -116,12 +116,12 @@ func (r *ArgoCDRoleBindingReconciler) Reconcile(ctx context.Context, req ctrl.Re
116116

117117
if err := r.Get(ctx, typeNamespacedNameRole, &role); err != nil {
118118
if errors.IsNotFound(err) {
119-
r.Log.Info("ArgoCDRole %s not found.", roleName)
119+
r.Log.Info("ArgoCDRole not found.", "name", roleName)
120120
return ctrl.Result{RequeueAfter: time.Second}, nil
121121
}
122122
rb.SetConditions(rbacoperatorv1alpha1.ReconcileError(err))
123123
if err := r.Client.Status().Update(ctx, &rb); err != nil {
124-
r.Log.Error(err, "Failed to update ArgoCDRoleBinding %s status", req.Name)
124+
r.Log.Error(err, "Failed to update ArgoCDRoleBinding status", "name", req.Name)
125125
}
126126
return ctrl.Result{}, err
127127
}
@@ -130,21 +130,21 @@ func (r *ArgoCDRoleBindingReconciler) Reconcile(ctx context.Context, req ctrl.Re
130130
if err := r.reconcileRBACConfigMap(cm, &rb, &role); err != nil {
131131
rb.SetConditions(rbacoperatorv1alpha1.ReconcileError(err))
132132
if err := r.Client.Status().Update(ctx, &rb); err != nil {
133-
r.Log.Error(err, "Failed to update ArgoCDRoleBinding %s status", req.Name)
133+
r.Log.Error(err, "Failed to update ArgoCDRoleBinding status", "name", req.Name)
134134
}
135135
return ctrl.Result{Requeue: true, RequeueAfter: time.Second}, err
136136
}
137137

138138
if !role.HasArgoCDRoleBindingRef() {
139139
role.SetArgoCDRoleBindingRef(rb.Name)
140140
if err := r.Client.Status().Update(ctx, &role); err != nil {
141-
r.Log.Error(err, "Failed to update ArgoCDRole %s status", role.Name)
141+
r.Log.Error(err, "Failed to update ArgoCDRole status", "name", role.Name)
142142
}
143143
}
144144

145145
rb.SetConditions(rbacoperatorv1alpha1.ReconcileSuccess().WithObservedGeneration(rb.GetGeneration()))
146146
if err := r.Client.Status().Update(ctx, &rb); err != nil {
147-
r.Log.Error(err, "Failed to update ArgoCDRoleBinding %s status", req.Name)
147+
r.Log.Error(err, "Failed to update ArgoCDRoleBinding status", "name", req.Name)
148148
}
149149
return ctrl.Result{RequeueAfter: time.Minute * 10}, nil
150150

@@ -162,19 +162,19 @@ func (r *ArgoCDRoleBindingReconciler) Reconcile(ctx context.Context, req ctrl.Re
162162
r.Log.Info("Reconciling RBAC ConfigMap")
163163
if err := r.reconcileRBACConfigMapForBuiltInRole(cm, &rb, role); err != nil {
164164
if errors.IsConflict(err) {
165-
r.Log.Info("Conflict while reconciling RBAC ConfigMap, requeuing ArgoCDRoleBinding %s", req.Name)
165+
r.Log.Info("Conflict while reconciling RBAC ConfigMap, requeuing ArgoCDRoleBinding", "name", req.Name)
166166
return ctrl.Result{RequeueAfter: time.Second}, nil
167167
}
168168
rb.SetConditions(rbacoperatorv1alpha1.ReconcileError(err))
169169
if err := r.Client.Status().Update(ctx, &rb); err != nil {
170-
r.Log.Error(err, "Failed to update ArgoCDRoleBinding %s status", req.Name)
170+
r.Log.Error(err, "Failed to update ArgoCDRoleBinding status", "name", req.Name)
171171
}
172172
return ctrl.Result{Requeue: true, RequeueAfter: time.Second}, err
173173
}
174174

175175
rb.SetConditions(rbacoperatorv1alpha1.ReconcileSuccess().WithObservedGeneration(rb.GetGeneration()))
176176
if err := r.Client.Status().Update(ctx, &rb); err != nil {
177-
r.Log.Error(err, "Failed to update ArgoCDRoleBinding %s status", req.Name)
177+
r.Log.Error(err, "Failed to update ArgoCDRoleBinding status", "name", req.Name)
178178
}
179179
return ctrl.Result{RequeueAfter: time.Minute * 10}, nil
180180
}

0 commit comments

Comments
 (0)