Improve log k/v pairs, consistent event recorder names

kubernetes-sigs · Dec 6, 2023 · bd2a6e1 · bd2a6e1
1 parent f330c6e
commit bd2a6e1
Show file tree

Hide file tree

Showing 14 changed files with 22 additions and 20 deletions.
diff --git a/bootstrap/kubeadm/internal/controllers/kubeadmconfig_controller.go b/bootstrap/kubeadm/internal/controllers/kubeadmconfig_controller.go
@@ -151,13 +151,6 @@ func (r *KubeadmConfigReconciler) Reconcile(ctx context.Context, req ctrl.Reques
 		return ctrl.Result{}, err
 	}
 
-	// AddOwners adds the owners of KubeadmConfig as k/v pairs to the logger.
-	// Specifically, it will add KubeadmControlPlane, MachineSet and MachineDeployment.
-	ctx, log, err := clog.AddOwners(ctx, r.Client, config)
-	if err != nil {
-		return ctrl.Result{}, err
-	}
-
 	// Look up the owner of this kubeadm config if there is one
 	configOwner, err := bsutil.GetTypedConfigOwner(ctx, r.Client, config)
 	if apierrors.IsNotFound(err) {
@@ -173,6 +166,15 @@ func (r *KubeadmConfigReconciler) Reconcile(ctx context.Context, req ctrl.Reques
 	}
 	log = log.WithValues(configOwner.GetKind(), klog.KRef(configOwner.GetNamespace(), configOwner.GetName()), "resourceVersion", configOwner.GetResourceVersion())
 
+	if configOwner.GetKind() == "Machine" {
+		// AddOwners adds the owners of Machine as k/v pairs to the logger.
+		// Specifically, it will add KubeadmControlPlane, MachineSet and MachineDeployment.
+		ctx, log, err = clog.AddOwners(ctx, r.Client, configOwner)
+		if err != nil {
+			return ctrl.Result{}, err
+		}
+	}
+
 	log = log.WithValues("Cluster", klog.KRef(configOwner.GetNamespace(), configOwner.ClusterName()))
 	ctx = ctrl.LoggerInto(ctx, log)
 

diff --git a/bootstrap/kubeadm/main.go b/bootstrap/kubeadm/main.go
@@ -294,7 +294,7 @@ func setupReconcilers(ctx context.Context, mgr ctrl.Manager) {
 
 	// Set up a ClusterCacheTracker and ClusterCacheReconciler to provide to controllers
 	// requiring a connection to a remote cluster
-	log := ctrl.Log.WithName("remote").WithName("ClusterCacheTracker")
+	log := ctrl.Log.WithValues("component", "remote/clustercachetracker")
 	tracker, err := remote.NewClusterCacheTracker(
 		mgr,
 		remote.ClusterCacheTrackerOptions{

diff --git a/controlplane/kubeadm/internal/controllers/controller.go b/controlplane/kubeadm/internal/controllers/controller.go
@@ -109,7 +109,7 @@ func (r *KubeadmControlPlaneReconciler) SetupWithManager(ctx context.Context, mg
 	}
 
 	r.controller = c
-	r.recorder = mgr.GetEventRecorderFor("kubeadm-control-plane-controller")
+	r.recorder = mgr.GetEventRecorderFor("kubeadmcontrolplane-controller")
 	r.ssaCache = ssa.NewCache()
 
 	if r.managementCluster == nil {

diff --git a/controlplane/kubeadm/main.go b/controlplane/kubeadm/main.go
@@ -302,7 +302,7 @@ func setupReconcilers(ctx context.Context, mgr ctrl.Manager) {
 
 	// Set up a ClusterCacheTracker to provide to controllers
 	// requiring a connection to a remote cluster
-	log := ctrl.Log.WithName("remote").WithName("ClusterCacheTracker")
+	log := ctrl.Log.WithValues("component", "remote/clustercachetracker")
 	tracker, err := remote.NewClusterCacheTracker(mgr, remote.ClusterCacheTrackerOptions{
 		SecretCachingClient: secretCachingClient,
 		ControllerName:      controllerName,

diff --git a/docs/book/src/tasks/experimental-features/runtime-sdk/implement-extensions.md b/docs/book/src/tasks/experimental-features/runtime-sdk/implement-extensions.md
@@ -89,7 +89,7 @@ func InitFlags(fs *pflag.FlagSet) {
 
 func main() {
 	// Creates a logger to be used during the main func.
-	setupLog := ctrl.Log.WithName("main")
+	setupLog := ctrl.Log.WithName("setup")
 
 	// Initialize and parse command line flags.
 	InitFlags(pflag.CommandLine)

diff --git a/internal/controllers/cluster/suite_test.go b/internal/controllers/cluster/suite_test.go
@@ -64,7 +64,7 @@ func TestMain(m *testing.M) {
 	setupReconcilers := func(ctx context.Context, mgr ctrl.Manager) {
 		// Set up a ClusterCacheTracker and ClusterCacheReconciler to provide to controllers
 		// requiring a connection to a remote cluster
-		log := ctrl.Log.WithName("remote").WithName("ClusterCacheTracker")
+		log := ctrl.Log.WithValues("component", "remote/clustercachetracker")
 		tracker, err := remote.NewClusterCacheTracker(
 			mgr,
 			remote.ClusterCacheTrackerOptions{

diff --git a/internal/controllers/machine/suite_test.go b/internal/controllers/machine/suite_test.go
@@ -69,7 +69,7 @@ func TestMain(m *testing.M) {
 	setupReconcilers := func(ctx context.Context, mgr ctrl.Manager) {
 		// Set up a ClusterCacheTracker and ClusterCacheReconciler to provide to controllers
 		// requiring a connection to a remote cluster
-		log := ctrl.Log.WithName("remote").WithName("ClusterCacheTracker")
+		log := ctrl.Log.WithValues("component", "remote/clustercachetracker")
 		tracker, err := remote.NewClusterCacheTracker(
 			mgr,
 			remote.ClusterCacheTrackerOptions{

diff --git a/internal/controllers/machinedeployment/suite_test.go b/internal/controllers/machinedeployment/suite_test.go
@@ -71,7 +71,7 @@ func TestMain(m *testing.M) {
 	setupReconcilers := func(ctx context.Context, mgr ctrl.Manager) {
 		// Set up a ClusterCacheTracker and ClusterCacheReconciler to provide to controllers
 		// requiring a connection to a remote cluster
-		log := ctrl.Log.WithName("remote").WithName("ClusterCacheTracker")
+		log := ctrl.Log.WithValues("component", "remote/clustercachetracker")
 		tracker, err := remote.NewClusterCacheTracker(
 			mgr,
 			remote.ClusterCacheTrackerOptions{

diff --git a/internal/controllers/machinehealthcheck/suite_test.go b/internal/controllers/machinehealthcheck/suite_test.go
@@ -67,7 +67,7 @@ func TestMain(m *testing.M) {
 	setupReconcilers := func(ctx context.Context, mgr ctrl.Manager) {
 		// Set up a ClusterCacheTracker and ClusterCacheReconciler to provide to controllers
 		// requiring a connection to a remote cluster
-		log := ctrl.Log.WithName("remote").WithName("ClusterCacheTracker")
+		log := ctrl.Log.WithValues("component", "remote/clustercachetracker")
 		tracker, err := remote.NewClusterCacheTracker(
 			mgr,
 			remote.ClusterCacheTrackerOptions{

diff --git a/internal/controllers/machineset/suite_test.go b/internal/controllers/machineset/suite_test.go
@@ -70,7 +70,7 @@ func TestMain(m *testing.M) {
 	setupReconcilers := func(ctx context.Context, mgr ctrl.Manager) {
 		// Set up a ClusterCacheTracker and ClusterCacheReconciler to provide to controllers
 		// requiring a connection to a remote cluster
-		log := ctrl.Log.WithName("remote").WithName("ClusterCacheTracker")
+		log := ctrl.Log.WithValues("component", "remote/clustercachetracker")
 		tracker, err := remote.NewClusterCacheTracker(
 			mgr,
 			remote.ClusterCacheTrackerOptions{

diff --git a/internal/controllers/topology/cluster/cluster_controller.go b/internal/controllers/topology/cluster/cluster_controller.go
@@ -126,7 +126,7 @@ func (r *Reconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manager, opt
 		Cache:      mgr.GetCache(),
 	}
 	r.patchEngine = patches.NewEngine(r.RuntimeClient)
-	r.recorder = mgr.GetEventRecorderFor("topology/cluster")
+	r.recorder = mgr.GetEventRecorderFor("topology/cluster-controller")
 	if r.patchHelperFactory == nil {
 		r.patchHelperFactory = serverSideApplyPatchHelperFactory(r.Client, ssa.NewCache())
 	}

diff --git a/internal/controllers/topology/cluster/suite_test.go b/internal/controllers/topology/cluster/suite_test.go
@@ -76,7 +76,7 @@ func TestMain(m *testing.M) {
 		}
 		// Set up a ClusterCacheTracker and ClusterCacheReconciler to provide to controllers
 		// requiring a connection to a remote cluster
-		log := ctrl.Log.WithName("remote").WithName("ClusterCacheTracker")
+		log := ctrl.Log.WithValues("component", "remote/clustercachetracker")
 		secretCachingClient, err := client.New(mgr.GetConfig(), client.Options{
 			HTTPClient: mgr.GetHTTPClient(),
 			Cache: &client.CacheOptions{

diff --git a/main.go b/main.go
@@ -380,7 +380,7 @@ func setupReconcilers(ctx context.Context, mgr ctrl.Manager) {
 
 	// Set up a ClusterCacheTracker and ClusterCacheReconciler to provide to controllers
 	// requiring a connection to a remote cluster
-	log := ctrl.Log.WithName("remote").WithName("ClusterCacheTracker")
+	log := ctrl.Log.WithValues("component", "remote/clustercachetracker")
 	tracker, err := remote.NewClusterCacheTracker(
 		mgr,
 		remote.ClusterCacheTrackerOptions{

diff --git a/test/infrastructure/docker/main.go b/test/infrastructure/docker/main.go
@@ -303,7 +303,7 @@ func setupReconcilers(ctx context.Context, mgr ctrl.Manager) {
 		os.Exit(1)
 	}
 
-	log := ctrl.Log.WithName("remote").WithName("ClusterCacheTracker")
+	log := ctrl.Log.WithValues("component", "remote/clustercachetracker")
 	tracker, err := remote.NewClusterCacheTracker(
 		mgr,
 		remote.ClusterCacheTrackerOptions{