From ac1fa3a4c3d1d163bc2c0cd7afd88186757ae3b0 Mon Sep 17 00:00:00 2001 From: Travis Nielsen Date: Fri, 21 Nov 2025 13:12:56 -0700 Subject: [PATCH] core: shorten the logger names The logger names are seen on each line of logging. As long as they are unique, they really don't need to be long and descriptive, so let's make them a bit more concise, and independent from controller names. Signed-off-by: Travis Nielsen --- pkg/operator/ceph/client/controller.go | 2 +- pkg/operator/ceph/cluster/controller.go | 2 +- pkg/operator/ceph/cluster/nodedaemon/reconcile.go | 2 +- pkg/operator/ceph/cluster/rbd/controller.go | 2 +- pkg/operator/ceph/cluster/watcher.go | 4 ++-- pkg/operator/ceph/disruption/clusterdisruption/reconcile.go | 2 +- pkg/operator/ceph/file/controller.go | 2 +- pkg/operator/ceph/file/mirror/controller.go | 2 +- pkg/operator/ceph/nfs/controller.go | 2 +- pkg/operator/ceph/object/controller.go | 2 +- pkg/operator/ceph/object/user/controller.go | 2 +- pkg/operator/ceph/object/zone/controller.go | 2 +- pkg/operator/ceph/object/zonegroup/controller.go | 2 +- 13 files changed, 14 insertions(+), 14 deletions(-) diff --git a/pkg/operator/ceph/client/controller.go b/pkg/operator/ceph/client/controller.go index de6b48359..a64baa834 100644 --- a/pkg/operator/ceph/client/controller.go +++ b/pkg/operator/ceph/client/controller.go @@ -55,7 +55,7 @@ const ( controllerName = "ceph-client-controller" ) -var logger = capnslog.NewPackageLogger("github.com/rook/rook", controllerName) +var logger = capnslog.NewPackageLogger("github.com/rook/rook", "client-controller") // Sets the type meta for the controller main object var controllerTypeMeta = metav1.TypeMeta{ diff --git a/pkg/operator/ceph/cluster/controller.go b/pkg/operator/ceph/cluster/controller.go index bdc9e5da1..960bc8f4d 100644 --- a/pkg/operator/ceph/cluster/controller.go +++ b/pkg/operator/ceph/cluster/controller.go @@ -67,7 +67,7 @@ const ( ) var ( - logger = capnslog.NewPackageLogger("github.com/rook/rook", controllerName) + logger = capnslog.NewPackageLogger("github.com/rook/rook", "cluster-controller") // disallowedHostDirectories directories which are not allowed to be used disallowedHostDirectories = []string{"/etc/ceph", "/rook", "/var/log/ceph"} ) diff --git a/pkg/operator/ceph/cluster/nodedaemon/reconcile.go b/pkg/operator/ceph/cluster/nodedaemon/reconcile.go index 30ae6e38f..12ce022c2 100644 --- a/pkg/operator/ceph/cluster/nodedaemon/reconcile.go +++ b/pkg/operator/ceph/cluster/nodedaemon/reconcile.go @@ -52,7 +52,7 @@ import ( ) var ( - logger = capnslog.NewPackageLogger("github.com/rook/rook", controllerName) + logger = capnslog.NewPackageLogger("github.com/rook/rook", "nodedaemon") // Implement reconcile.Reconciler so the controller can reconcile objects _ reconcile.Reconciler = &ReconcileNode{} diff --git a/pkg/operator/ceph/cluster/rbd/controller.go b/pkg/operator/ceph/cluster/rbd/controller.go index 824cd18fd..423b0e249 100644 --- a/pkg/operator/ceph/cluster/rbd/controller.go +++ b/pkg/operator/ceph/cluster/rbd/controller.go @@ -52,7 +52,7 @@ const ( controllerName = "ceph-rbd-mirror-controller" ) -var logger = capnslog.NewPackageLogger("github.com/rook/rook", controllerName) +var logger = capnslog.NewPackageLogger("github.com/rook/rook", "rbd-mirror-controller") // List of object resources to watch by the controller var objectsToWatch = []client.Object{ diff --git a/pkg/operator/ceph/cluster/watcher.go b/pkg/operator/ceph/cluster/watcher.go index fb1440eae..e55d69d02 100644 --- a/pkg/operator/ceph/cluster/watcher.go +++ b/pkg/operator/ceph/cluster/watcher.go @@ -687,11 +687,11 @@ func (c *clientCluster) getCephCluster() *cephv1.CephCluster { err := c.client.List(context.TODO(), clusterList, client.InNamespace(c.namespace)) if err != nil { - logger.Debugf("%q: failed to fetch CephCluster %v", controllerName, err) + logger.Debugf("failed to fetch CephCluster %v", err) return &cephv1.CephCluster{} } if len(clusterList.Items) == 0 { - logger.Debugf("%q: no CephCluster resource found in namespace %q", controllerName, c.namespace) + logger.Debugf("no CephCluster resource found in namespace %q", c.namespace) return &cephv1.CephCluster{} } diff --git a/pkg/operator/ceph/disruption/clusterdisruption/reconcile.go b/pkg/operator/ceph/disruption/clusterdisruption/reconcile.go index 0751b03e5..3027e90f1 100644 --- a/pkg/operator/ceph/disruption/clusterdisruption/reconcile.go +++ b/pkg/operator/ceph/disruption/clusterdisruption/reconcile.go @@ -45,7 +45,7 @@ const ( ) var ( - logger = capnslog.NewPackageLogger("github.com/rook/rook", controllerName) + logger = capnslog.NewPackageLogger("github.com/rook/rook", "disruption") // Implement reconcile.Reconciler so the controller can reconcile objects _ reconcile.Reconciler = &ReconcileClusterDisruption{} diff --git a/pkg/operator/ceph/file/controller.go b/pkg/operator/ceph/file/controller.go index 29b5b2376..3db1d3d76 100644 --- a/pkg/operator/ceph/file/controller.go +++ b/pkg/operator/ceph/file/controller.go @@ -53,7 +53,7 @@ const ( controllerName = "ceph-file-controller" ) -var logger = capnslog.NewPackageLogger("github.com/rook/rook", controllerName) +var logger = capnslog.NewPackageLogger("github.com/rook/rook", "file-controller") // List of object resources to watch by the controller var objectsToWatch = []client.Object{ diff --git a/pkg/operator/ceph/file/mirror/controller.go b/pkg/operator/ceph/file/mirror/controller.go index eafa1862e..004aa49bf 100644 --- a/pkg/operator/ceph/file/mirror/controller.go +++ b/pkg/operator/ceph/file/mirror/controller.go @@ -51,7 +51,7 @@ const ( controllerName = "ceph-filesystem-mirror-controller" ) -var logger = capnslog.NewPackageLogger("github.com/rook/rook", controllerName) +var logger = capnslog.NewPackageLogger("github.com/rook/rook", "cephfs-mirror-controller") // List of object resources to watch by the controller var objectsToWatch = []client.Object{ diff --git a/pkg/operator/ceph/nfs/controller.go b/pkg/operator/ceph/nfs/controller.go index 26fecb18a..b6ee4fff1 100644 --- a/pkg/operator/ceph/nfs/controller.go +++ b/pkg/operator/ceph/nfs/controller.go @@ -53,7 +53,7 @@ const ( controllerName = "ceph-nfs-controller" ) -var logger = capnslog.NewPackageLogger("github.com/rook/rook", controllerName) +var logger = capnslog.NewPackageLogger("github.com/rook/rook", "nfs-controller") // List of object resources to watch by the controller var objectsToWatch = []client.Object{ diff --git a/pkg/operator/ceph/object/controller.go b/pkg/operator/ceph/object/controller.go index 8fbf73213..89f72423f 100644 --- a/pkg/operator/ceph/object/controller.go +++ b/pkg/operator/ceph/object/controller.go @@ -62,7 +62,7 @@ const ( var waitForRequeueIfObjectStoreNotReady = reconcile.Result{Requeue: true, RequeueAfter: 10 * time.Second} -var logger = capnslog.NewPackageLogger("github.com/rook/rook", controllerName) +var logger = capnslog.NewPackageLogger("github.com/rook/rook", "object-controller") // List of object resources to watch by the controller var objectsToWatch = []client.Object{ diff --git a/pkg/operator/ceph/object/user/controller.go b/pkg/operator/ceph/object/user/controller.go index f3a3438bc..1f761f810 100644 --- a/pkg/operator/ceph/object/user/controller.go +++ b/pkg/operator/ceph/object/user/controller.go @@ -61,7 +61,7 @@ const ( // newMultisiteAdminOpsCtxFunc help us mocking the admin ops API client in unit test var newMultisiteAdminOpsCtxFunc = object.NewMultisiteAdminOpsContext -var logger = capnslog.NewPackageLogger("github.com/rook/rook", controllerName) +var logger = capnslog.NewPackageLogger("github.com/rook/rook", "object-user-controller") // Sets the type meta for the controller main object var controllerTypeMeta = metav1.TypeMeta{ diff --git a/pkg/operator/ceph/object/zone/controller.go b/pkg/operator/ceph/object/zone/controller.go index 91b84ab79..0481d9810 100644 --- a/pkg/operator/ceph/object/zone/controller.go +++ b/pkg/operator/ceph/object/zone/controller.go @@ -67,7 +67,7 @@ var createObjectStorePoolsFunc = object.CreateObjectStorePools // allow this to be overridden for unit tests var commitConfigChangesFunc = object.CommitConfigChanges -var logger = capnslog.NewPackageLogger("github.com/rook/rook", controllerName) +var logger = capnslog.NewPackageLogger("github.com/rook/rook", "zone-controller") // Sets the type meta for the controller main object var controllerTypeMeta = metav1.TypeMeta{ diff --git a/pkg/operator/ceph/object/zonegroup/controller.go b/pkg/operator/ceph/object/zonegroup/controller.go index 91004cd18..fe76165d5 100644 --- a/pkg/operator/ceph/object/zonegroup/controller.go +++ b/pkg/operator/ceph/object/zonegroup/controller.go @@ -53,7 +53,7 @@ const ( var waitForRequeueIfObjectRealmNotReady = reconcile.Result{Requeue: true, RequeueAfter: 10 * time.Second} -var logger = capnslog.NewPackageLogger("github.com/rook/rook", controllerName) +var logger = capnslog.NewPackageLogger("github.com/rook/rook", "zonegroup-controller") // Sets the type meta for the controller main object var controllerTypeMeta = metav1.TypeMeta{