chore: normalize logger names

Signed-off-by: Peter Wilcsinszky <[email protected]>

Author: pepov

controllers/logging/logging_controller.go

@@ -83,7 +83,7 @@ type LoggingReconciler struct {
 
 // Reconcile logging resources
 func (r *LoggingReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
-	log := r.Log.WithValues("logging", req.NamespacedName)
+	log := r.Log.WithValues("logging", req.Name)
 
 	var logging loggingv1beta1.Logging
 	if err := r.Client.Get(ctx, req.NamespacedName, &logging); err != nil {
@@ -193,7 +193,7 @@ func (r *LoggingReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ct
 			nameProvider := loggingv1beta1.NewLegacyFluentbitNameProvider(&logging)
 			reconcilers = append(reconcilers, fluentbit.New(
 				r.Client,
-				r.Log.WithName(nameProvider.ComponentName("logging-legacy")),
+				log.WithName("fluentbit-legacy"),
 				&logging,
 				reconcilerOpts,
 				logging.Spec.FluentbitSpec,
@@ -205,17 +205,17 @@ func (r *LoggingReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ct
 		if logging.Spec.FluentbitSpec != nil {
 			return ctrl.Result{}, errors.New("fluentbit has to be removed from the logging resource before the new FluentbitAgent can be reconciled")
 		}
+		l := log.WithName("fluentbit")
 		for _, f := range loggingResources.Fluentbits {
 			f := f
-			nameProvider := loggingv1beta1.NewStandaloneFluentbitNameProvider(&f)
 			reconcilers = append(reconcilers, fluentbit.New(
 				r.Client,
-				r.Log.WithName(nameProvider.ComponentName("fluentbit-agent")),
+				l.WithValues("fluentbitagent", f.Name),
 				&logging,
 				reconcilerOpts,
 				&f.Spec,
 				loggingDataProvider,
-				nameProvider,
+				loggingv1beta1.NewStandaloneFluentbitNameProvider(&f),
 			).Reconcile)
 		}
 	}

main.go

@@ -24,14 +24,6 @@ import (
 	"strings"
 
 	"emperror.dev/errors"
-	extensionsControllers "github.com/kube-logging/logging-operator/controllers/extensions"
-	loggingControllers "github.com/kube-logging/logging-operator/controllers/logging"
-	extensionsv1alpha1 "github.com/kube-logging/logging-operator/pkg/sdk/extensions/api/v1alpha1"
-	config "github.com/kube-logging/logging-operator/pkg/sdk/extensions/extensionsconfig"
-	loggingv1alpha1 "github.com/kube-logging/logging-operator/pkg/sdk/logging/api/v1alpha1"
-	loggingv1beta1 "github.com/kube-logging/logging-operator/pkg/sdk/logging/api/v1beta1"
-	"github.com/kube-logging/logging-operator/pkg/sdk/logging/model/types"
-	"github.com/kube-logging/logging-operator/pkg/webhook/podhandler"
 	prometheusOperator "github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1"
 	"github.com/spf13/cast"
 	appsv1 "k8s.io/api/apps/v1"
@@ -51,6 +43,15 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client/apiutil"
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
 	"sigs.k8s.io/controller-runtime/pkg/webhook"
+
+	extensionsControllers "github.com/kube-logging/logging-operator/controllers/extensions"
+	loggingControllers "github.com/kube-logging/logging-operator/controllers/logging"
+	extensionsv1alpha1 "github.com/kube-logging/logging-operator/pkg/sdk/extensions/api/v1alpha1"
+	config "github.com/kube-logging/logging-operator/pkg/sdk/extensions/extensionsconfig"
+	loggingv1alpha1 "github.com/kube-logging/logging-operator/pkg/sdk/logging/api/v1alpha1"
+	loggingv1beta1 "github.com/kube-logging/logging-operator/pkg/sdk/logging/api/v1beta1"
+	"github.com/kube-logging/logging-operator/pkg/sdk/logging/model/types"
+	"github.com/kube-logging/logging-operator/pkg/webhook/podhandler"
 	// +kubebuilder:scaffold:imports
 )
 
@@ -158,19 +159,19 @@ func main() {
 		os.Exit(1)
 	}
 
-	loggingReconciler := loggingControllers.NewLoggingReconciler(mgr.GetClient(), ctrl.Log.WithName("controllers").WithName("Logging"))
+	loggingReconciler := loggingControllers.NewLoggingReconciler(mgr.GetClient(), ctrl.Log.WithName("logging"))
 
 	if err := (&extensionsControllers.EventTailerReconciler{
 		Client: mgr.GetClient(),
-		Log:    ctrl.Log.WithName("controllers").WithName("EventTailer"),
+		Log:    ctrl.Log.WithName("event-tailer"),
 		Scheme: mgr.GetScheme(),
 	}).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "EventTailer")
 		os.Exit(1)
 	}
 	if err := (&extensionsControllers.HostTailerReconciler{
 		Client: mgr.GetClient(),
-		Log:    ctrl.Log.WithName("controllers").WithName("HostTailer"),
+		Log:    ctrl.Log.WithName("host-tailer"),
 		Scheme: mgr.GetScheme(),
 	}).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "HostTailer")

pkg/resources/fluentbit/configsecret.go

@@ -25,7 +25,6 @@ import (
 	"github.com/cisco-open/operator-tools/pkg/utils"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/runtime"
-	"sigs.k8s.io/controller-runtime/pkg/log"
 
 	"github.com/kube-logging/logging-operator/pkg/resources/fluentd"
 	"github.com/kube-logging/logging-operator/pkg/resources/syslogng"
@@ -175,10 +174,10 @@ func (r *Reconciler) configSecret() (runtime.Object, reconciler.DesiredState, er
 
 	if !disableKubernetesFilter {
 		if r.fluentbitSpec.FilterKubernetes.BufferSize == "" {
-			log.Log.Info("Notice: If the Buffer_Size value is empty we will set it 0. For more information: https://github.com/fluent/fluent-bit/issues/2111")
+			r.logger.Info("Notice: If the Buffer_Size value is empty we will set it 0. For more information: https://github.com/fluent/fluent-bit/issues/2111")
 			r.fluentbitSpec.FilterKubernetes.BufferSize = "0"
 		} else if r.fluentbitSpec.FilterKubernetes.BufferSize != "0" {
-			log.Log.Info("Notice: If the kubernetes filter buffer_size parameter is underestimated it can cause log loss. For more information: https://github.com/fluent/fluent-bit/issues/2111")
+			r.logger.Info("Notice: If the kubernetes filter buffer_size parameter is underestimated it can cause log loss. For more information: https://github.com/fluent/fluent-bit/issues/2111")
 		}
 	}
 
@@ -316,7 +315,7 @@ func (r *Reconciler) configSecret() (runtime.Object, reconciler.DesiredState, er
 			input.FluentForwardOutput.Network.KeepaliveIdleTimeout = 30
 			input.FluentForwardOutput.Network.KeepaliveMaxRecycleSet = true
 			input.FluentForwardOutput.Network.KeepaliveMaxRecycle = 100
-			log.Log.Info("Notice: fluentbit `network` settings have been configured automatically to adapt to multiple aggregator replicas. Configure it manually to avoid this notice.")
+			r.logger.Info("Notice: fluentbit `network` settings have been configured automatically to adapt to multiple aggregator replicas. Configure it manually to avoid this notice.")
 		}
 
 		if r.fluentbitSpec.EnableUpstream {