Operators: better logger handling

netgroup-polito · Jan 10, 2023 · c62c9b1 · c62c9b1
1 parent 020cb12
commit c62c9b1
Show file tree

Hide file tree

Showing 9 changed files with 14 additions and 54 deletions.
diff --git a/operators/cmd/instance-operator/main.go b/operators/cmd/instance-operator/main.go
@@ -39,7 +39,6 @@ import (
 	instancesnapshot_controller "github.com/netgroup-polito/CrownLabs/operators/pkg/instancesnapshot-controller"
 	"github.com/netgroup-polito/CrownLabs/operators/pkg/instautoctrl"
 	"github.com/netgroup-polito/CrownLabs/operators/pkg/instctrl"
-	"github.com/netgroup-polito/CrownLabs/operators/pkg/utils"
 	"github.com/netgroup-polito/CrownLabs/operators/pkg/utils/restcfg"
 )
 
@@ -99,9 +98,6 @@ func main() {
 	klog.InitFlags(nil)
 	flag.Parse()
 
-	if !klog.V(5).Enabled() {
-		klog.SetLogFilter(utils.LogShortenerFilter{})
-	}
 	ctrl.SetLogger(klogr.NewWithOptions())
 
 	log := ctrl.Log.WithName("setup")

diff --git a/operators/cmd/tenant-operator/main.go b/operators/cmd/tenant-operator/main.go
@@ -36,7 +36,6 @@ import (
 	clv1alpha2 "github.com/netgroup-polito/CrownLabs/operators/api/v1alpha2"
 	controllers "github.com/netgroup-polito/CrownLabs/operators/pkg/tenant-controller"
 	"github.com/netgroup-polito/CrownLabs/operators/pkg/tenantwh"
-	"github.com/netgroup-polito/CrownLabs/operators/pkg/utils"
 )
 
 var (
@@ -96,9 +95,6 @@ func main() {
 	klog.InitFlags(nil)
 	flag.Parse()
 
-	if !klog.V(5).Enabled() {
-		klog.SetLogFilter(utils.LogShortenerFilter{})
-	}
 	ctrl.SetLogger(klogr.NewWithOptions())
 
 	ctx := ctrl.SetupSignalHandler()

diff --git a/operators/pkg/instancesnapshot-controller/instancesnapshot_controller.go b/operators/pkg/instancesnapshot-controller/instancesnapshot_controller.go
@@ -146,5 +146,6 @@ func (r *InstanceSnapshotReconciler) SetupWithManager(mgr ctrl.Manager) error {
 		// The generation changed predicate allow to avoid updates on the status changes of the InstanceSnapshot
 		For(&crownlabsv1alpha2.InstanceSnapshot{}, builder.WithPredicates(predicate.GenerationChangedPredicate{})).
 		Owns(&batch.Job{}).
+		WithLogConstructor(utils.LogConstructor(mgr.GetLogger(), "InstanceSnapshot")).
 		Complete(r)
 }
diff --git a/operators/pkg/instautoctrl/submission.go b/operators/pkg/instautoctrl/submission.go
@@ -57,6 +57,7 @@ func (r *InstanceSubmissionReconciler) SetupWithManager(mgr ctrl.Manager, concur
 		WithOptions(controller.Options{
 			MaxConcurrentReconciles: concurrency,
 		}).
+		WithLogConstructor(utils.LogConstructor(mgr.GetLogger(), "InstanceSubmission")).
 		Complete(r)
 }
 

diff --git a/operators/pkg/instautoctrl/termination.go b/operators/pkg/instautoctrl/termination.go
@@ -59,6 +59,7 @@ func (r *InstanceTerminationReconciler) SetupWithManager(mgr ctrl.Manager, concu
 		WithOptions(controller.Options{
 			MaxConcurrentReconciles: concurrency,
 		}).
+		WithLogConstructor(utils.LogConstructor(mgr.GetLogger(), "InstanceTermination")).
 		Complete(r)
 }
 

diff --git a/operators/pkg/instctrl/controller.go b/operators/pkg/instctrl/controller.go
@@ -255,6 +255,7 @@ func (r *InstanceReconciler) SetupWithManager(mgr ctrl.Manager, concurrency int)
 		WithOptions(controller.Options{
 			MaxConcurrentReconciles: concurrency,
 		}).
+		WithLogConstructor(utils.LogConstructor(mgr.GetLogger(), "Instance")).
 		Complete(r)
 }
 

diff --git a/operators/pkg/tenant-controller/tenant_controller.go b/operators/pkg/tenant-controller/tenant_controller.go
@@ -41,6 +41,7 @@ import (
 	crownlabsv1alpha1 "github.com/netgroup-polito/CrownLabs/operators/api/v1alpha1"
 	crownlabsv1alpha2 "github.com/netgroup-polito/CrownLabs/operators/api/v1alpha2"
 	"github.com/netgroup-polito/CrownLabs/operators/pkg/forge"
+	"github.com/netgroup-polito/CrownLabs/operators/pkg/utils"
 )
 
 const (
@@ -257,6 +258,7 @@ func (r *TenantReconciler) SetupWithManager(mgr ctrl.Manager) error {
 		WithOptions(controller.Options{
 			MaxConcurrentReconciles: r.Concurrency,
 		}).
+		WithLogConstructor(utils.LogConstructor(mgr.GetLogger(), "Tenant")).
 		Complete(r)
 }
 

diff --git a/operators/pkg/tenant-controller/workspace_controller.go b/operators/pkg/tenant-controller/workspace_controller.go
@@ -30,6 +30,7 @@ import (
 
 	crownlabsv1alpha1 "github.com/netgroup-polito/CrownLabs/operators/api/v1alpha1"
 	crownlabsv1alpha2 "github.com/netgroup-polito/CrownLabs/operators/api/v1alpha2"
+	"github.com/netgroup-polito/CrownLabs/operators/pkg/utils"
 )
 
 // WorkspaceReconciler reconciles a Workspace object.
@@ -181,6 +182,7 @@ func (r *WorkspaceReconciler) SetupWithManager(mgr ctrl.Manager) error {
 		Owns(&v1.Namespace{}).
 		Owns(&rbacv1.ClusterRoleBinding{}).
 		Owns(&rbacv1.RoleBinding{}).
+		WithLogConstructor(utils.LogConstructor(mgr.GetLogger(), "Workspace")).
 		Complete(r)
 }
 

diff --git a/operators/pkg/utils/logs.go b/operators/pkg/utils/logs.go
@@ -15,65 +15,25 @@
 package utils
 
 import (
-	"strings"
 	"time"
 
+	"github.com/go-logr/logr"
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
+	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 )
 
 const (
-	logPrefixMgr           = "controller-runtime/manager/"
-	logShortenedPrefixMgr  = "mgr/"
-	logPrefixCtrl          = "controller/"
-	logShortenedPrefixCtrl = "ctrl/"
-	logPrefixFull          = logPrefixMgr + logPrefixCtrl
-
 	// LogInfoLevel -> level associated with informational messages.
 	LogInfoLevel = 0
 	// LogDebugLevel -> level associated with debug messages.
 	LogDebugLevel = 2
 )
 
-var logKeysToRemove = map[string]struct{}{
-	"reconciler group": {},
-	"reconciler kind":  {},
-	"name":             {},
-	"namespace":        {},
-}
-
-// LogShortenerFilter implements the klog LogFilter interface, to shorten the log messages
-// generated by controller-runtime (through the logr/klogr interfaces).
-type LogShortenerFilter struct{}
-
-// Filter does nothing (i.e, only passes through the arguments), as not used in this context.
-func (l LogShortenerFilter) Filter(args []interface{}) []interface{} {
-	return args
-}
-
-// FilterF does nothing (i.e, only passes through the arguments), as not used in this context.
-func (l LogShortenerFilter) FilterF(format string, args []interface{}) (f string, a []interface{}) {
-	return format, args
-}
-
-// FilterS shortens the argument list, removing a set of common key/value pairs configured by controller-manager.
-func (l LogShortenerFilter) FilterS(msg string, keysAndValues []interface{}) (m string, a []interface{}) {
-	// Remove the key/value pairs only in case of controller-related logs
-	if strings.HasPrefix(msg, logPrefixFull) {
-		for i := 0; i < len(keysAndValues); {
-			if key, ok := keysAndValues[i].(string); ok {
-				if _, found := logKeysToRemove[key]; found {
-					keysAndValues = append(keysAndValues[:i], keysAndValues[i+2:]...)
-					continue
-				}
-			}
-			// Move to the next key
-			i += 2
-		}
+// LogConstructor returns a constructor for a logger to be used by the given controller.
+func LogConstructor(logger logr.Logger, ctrlname string) func(*reconcile.Request) logr.Logger {
+	return func(r *reconcile.Request) logr.Logger {
+		return logger.WithName(ctrlname)
 	}
-
-	msg = strings.ReplaceAll(msg, logPrefixMgr, logShortenedPrefixMgr)
-	msg = strings.ReplaceAll(msg, logPrefixCtrl, logShortenedPrefixCtrl)
-	return msg, keysAndValues
 }
 
 // FromResult returns a logger level, given the result of a CreateOrUpdate operation.