Improve logging

Signed-off-by: ccremer <[email protected]>

Author: ccremer

operator/archivecontroller/controller.go

@@ -20,7 +20,7 @@ type ArchiveReconciler struct {
 
 // Reconcile is the entrypoint to manage the given resource.
 func (r *ArchiveReconciler) Reconcile(ctx context.Context, req controllerruntime.Request) (controllerruntime.Result, error) {
-	log := controllerruntime.LoggerFrom(ctx).WithValues("archive", req.NamespacedName)
+	log := controllerruntime.LoggerFrom(ctx)
 
 	archive := &k8upv1.Archive{}
 	err := r.Kube.Get(ctx, req.NamespacedName, archive)

operator/backupcontroller/executor.go

@@ -73,7 +73,7 @@ func (b *BackupExecutor) listAndFilterPVCs(annotation string) ([]corev1.Volume,
 	volumes := make([]corev1.Volume, 0)
 	claimlist := &corev1.PersistentVolumeClaimList{}
 
-	b.Log.Info("Listing all PVCs", "annotation", annotation, "namespace", b.Obj.GetNamespace())
+	b.Log.Info("Listing all PVCs", "annotation", annotation)
 	if err := b.fetchPVCs(claimlist); err != nil {
 		return volumes, err
 	}
@@ -84,17 +84,17 @@ func (b *BackupExecutor) listAndFilterPVCs(annotation string) ([]corev1.Volume,
 		tmpAnnotation, ok := annotations[annotation]
 
 		if !containsAccessMode(item.Spec.AccessModes, "ReadWriteMany") && !ok {
-			b.Log.Info("PVC isn't RWX", "namespace", item.GetNamespace(), "name", item.GetName())
+			b.Log.Info("PVC isn't RWX", "pvc", item.GetName())
 			continue
 		}
 
 		if !ok {
-			b.Log.Info("PVC doesn't have annotation, adding to list", "namespace", item.GetNamespace(), "name", item.GetName())
+			b.Log.Info("PVC doesn't have annotation, adding to list", "pvc", item.GetName())
 		} else if anno, _ := strconv.ParseBool(tmpAnnotation); !anno {
-			b.Log.Info("PVC skipped due to annotation", "namespace", item.GetNamespace(), "name", item.GetName(), "annotation", tmpAnnotation)
+			b.Log.Info("PVC skipped due to annotation", "pvc", item.GetName(), "annotation", tmpAnnotation)
 			continue
 		} else {
-			b.Log.Info("Adding to list", "namespace", item.GetNamespace(), "name", item.Name)
+			b.Log.Info("Adding to list", "pvc", item.Name)
 		}
 
 		tmpVol := corev1.Volume{

operator/backupcontroller/setup.go

@@ -2,7 +2,7 @@ package backupcontroller
 
 import (
 	"github.com/go-logr/logr"
-	"github.com/k8up-io/k8up/v2/api/v1"
+	k8upv1 "github.com/k8up-io/k8up/v2/api/v1"
 	"sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/predicate"
 )
@@ -25,7 +25,7 @@ func (r *BackupReconciler) SetupWithManager(mgr controllerruntime.Manager, _ log
 	r.Kube = mgr.GetClient()
 	return controllerruntime.NewControllerManagedBy(mgr).
 		Named(name).
-		For(&v1.Backup{}).
+		For(&k8upv1.Backup{}).
 		WithEventFilter(predicate.GenerationChangedPredicate{}).
 		Complete(r)
 }

operator/jobcontroller/controller.go

@@ -151,20 +151,20 @@ func (r *JobReconciler) updateOwner(ctx context.Context, batchJob *batchv1.Job)
 		if !ownerStatus.HasSucceeded() {
 			// only increase success counter if new condition
 			monitoring.IncSuccessCounters(batchJob.Namespace, jobType)
+			log.Info("Job succeeded")
 		}
 		ownerStatus.SetSucceeded(message)
 		ownerStatus.SetFinished(fmt.Sprintf("job '%s' completed successfully", batchJob.Name))
-		log.Info("job succeeded", "jobName", batchJob.Name)
 	}
 	failedCond := FindStatusCondition(batchJob.Status.Conditions, batchv1.JobFailed)
 	if failedCond != nil && failedCond.Status == corev1.ConditionTrue {
 		if !ownerStatus.HasFailed() {
 			// only increase fail counter if new condition
 			monitoring.IncFailureCounters(batchJob.Namespace, jobType)
+			log.Info("Job failed")
 		}
 		ownerStatus.SetFailed(message)
 		ownerStatus.SetFinished(fmt.Sprintf("job '%s' has failed", batchJob.Name))
-		log.Info("job failed", "jobName", batchJob.Name)
 	}
 	if successCond == nil && failedCond == nil {
 		ownerStatus.SetStarted(message)