chore: replace zap.New with bootstrap.New

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

Author: STRRL

examples/builtins/main.go

@@ -26,15 +26,15 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/controller"
 	"sigs.k8s.io/controller-runtime/pkg/handler"
 	"sigs.k8s.io/controller-runtime/pkg/log"
-	"sigs.k8s.io/controller-runtime/pkg/log/zap"
+	"sigs.k8s.io/controller-runtime/pkg/log/bootstrap"
 	"sigs.k8s.io/controller-runtime/pkg/manager"
 	"sigs.k8s.io/controller-runtime/pkg/manager/signals"
 	"sigs.k8s.io/controller-runtime/pkg/source"
 	"sigs.k8s.io/controller-runtime/pkg/webhook"
 )
 
 func init() {
-	log.SetLogger(zap.New())
+	log.SetLogger(bootstrap.New())
 }
 
 func main() {

examples/configfile/builtin/main.go

@@ -28,14 +28,14 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client/config"
 	cfg "sigs.k8s.io/controller-runtime/pkg/config"
 	"sigs.k8s.io/controller-runtime/pkg/log"
-	"sigs.k8s.io/controller-runtime/pkg/log/zap"
+	"sigs.k8s.io/controller-runtime/pkg/log/bootstrap"
 	"sigs.k8s.io/controller-runtime/pkg/manager/signals"
 )
 
 var scheme = runtime.NewScheme()
 
 func init() {
-	log.SetLogger(zap.New())
+	log.SetLogger(bootstrap.New())
 	clientgoscheme.AddToScheme(scheme)
 }
 

examples/configfile/custom/main.go

@@ -29,14 +29,14 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client/config"
 	cfg "sigs.k8s.io/controller-runtime/pkg/config"
 	"sigs.k8s.io/controller-runtime/pkg/log"
-	"sigs.k8s.io/controller-runtime/pkg/log/zap"
+	"sigs.k8s.io/controller-runtime/pkg/log/bootstrap"
 	"sigs.k8s.io/controller-runtime/pkg/manager/signals"
 )
 
 var scheme = runtime.NewScheme()
 
 func init() {
-	log.SetLogger(zap.New())
+	log.SetLogger(bootstrap.New())
 	clientgoscheme.AddToScheme(scheme)
 	v1alpha1.AddToScheme(scheme)
 }

examples/crd/main.go

@@ -30,7 +30,7 @@ import (
 	api "sigs.k8s.io/controller-runtime/examples/crd/pkg"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/log"
-	"sigs.k8s.io/controller-runtime/pkg/log/zap"
+	"sigs.k8s.io/controller-runtime/pkg/log/bootstrap"
 )
 
 var (
@@ -102,7 +102,7 @@ func (r *reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Resu
 }
 
 func main() {
-	ctrl.SetLogger(zap.New())
+	ctrl.SetLogger(bootstrap.New())
 
 	mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), ctrl.Options{})
 	if err != nil {

examples/scratch-env/main.go

@@ -25,6 +25,7 @@ import (
 
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/envtest"
+	"sigs.k8s.io/controller-runtime/pkg/log/bootstrap"
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
 )
 
@@ -45,7 +46,7 @@ func runMain() int {
 		flag.CommandLine.AddGoFlagSet(&goFlagSet)
 	}
 	flag.Parse()
-	ctrl.SetLogger(zap.New(zap.UseFlagOptions(loggerOpts)))
+	ctrl.SetLogger(bootstrap.New(zap.UseFlagOptions(loggerOpts)))
 
 	log := ctrl.Log.WithName("main")
 

examples/tokenreview/main.go

@@ -22,14 +22,14 @@ import (
 	_ "k8s.io/client-go/plugin/pkg/client/auth/gcp"
 	"sigs.k8s.io/controller-runtime/pkg/client/config"
 	"sigs.k8s.io/controller-runtime/pkg/log"
-	"sigs.k8s.io/controller-runtime/pkg/log/zap"
+	"sigs.k8s.io/controller-runtime/pkg/log/bootstrap"
 	"sigs.k8s.io/controller-runtime/pkg/manager"
 	"sigs.k8s.io/controller-runtime/pkg/manager/signals"
 	"sigs.k8s.io/controller-runtime/pkg/webhook/authentication"
 )
 
 func init() {
-	log.SetLogger(zap.New())
+	log.SetLogger(bootstrap.New())
 }
 
 func main() {

pkg/log/bootstrap/doc.go

@@ -0,0 +1,18 @@
+/*
+Copyright 2022 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// Package bootstrap is used to bootstrap the logger with both customized zap and logr.
+package bootstrap

pkg/log/bootstrap/log.go

@@ -0,0 +1,37 @@
+/*
+Copyright 2022 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package bootstrap
+
+import (
+	gologr "github.com/go-logr/logr"
+	gozapr "github.com/go-logr/zapr"
+	"sigs.k8s.io/controller-runtime/pkg/log/logr"
+	"sigs.k8s.io/controller-runtime/pkg/log/zap"
+)
+
+// New returns a brand new Logger configured with Opts. It
+// uses logr.NewKubeAwareLogSink which adds Type information and
+// Namespace/Name to the log.
+func New(opts ...zap.Opts) gologr.Logger {
+	zapLogger := gozapr.NewLogger(zap.NewRaw(opts...))
+
+	o := &zap.Options{}
+	for _, opt := range opts {
+		opt(o)
+	}
+	return logr.NewKubeAwareLogger(zapLogger, o.Development)
+}

pkg/log/logr/kube_aware_logger_sink.go

@@ -23,27 +23,41 @@ import (
 	"k8s.io/apimachinery/pkg/types"
 )
 
+var _ logr.LogSink = (*KubeAwareLogSink)(nil)
+
+// KubeAwareLogSink is a Kubernetes-aware logr.LogSink.
+// zapcore.ObjectMarshaler would be bypassed when using zapr and WithValues.
+// It would use a wrapper implements logr.Marshaler instead of using origin Kubernetes objects.
 type KubeAwareLogSink struct {
 	sink             logr.LogSink
 	kubeAwareEnabled *atomic.Bool
 }
 
+// NewKubeAwareLogger return the wrapper with existed logr.Logger.
+// logger is the backend logger.
+// kubeAwareEnabled is the flag to enable kube aware logging.
 func NewKubeAwareLogger(logger logr.Logger, kubeAwareEnabled bool) logr.Logger {
 	return logr.New(NewKubeAwareLogSink(logger.GetSink(), kubeAwareEnabled))
 }
 
+// NewKubeAwareLogSink return the wrapper with existed logr.LogSink.
+// sink is the backend logr.LogSink.
+// kubeAwareEnabled is the flag to enable kube aware logging.
 func NewKubeAwareLogSink(logSink logr.LogSink, kubeAwareEnabled bool) *KubeAwareLogSink {
 	return &KubeAwareLogSink{sink: logSink, kubeAwareEnabled: atomic.NewBool(kubeAwareEnabled)}
 }
 
+// Init implements logr.LogSink.
 func (k *KubeAwareLogSink) Init(info logr.RuntimeInfo) {
 	k.sink.Init(info)
 }
 
+// Enabled implements logr.LogSink.
 func (k *KubeAwareLogSink) Enabled(level int) bool {
 	return k.sink.Enabled(level)
 }
 
+// Info implements logr.LogSink.
 func (k *KubeAwareLogSink) Info(level int, msg string, keysAndValues ...interface{}) {
 	if !k.KubeAwareEnabled() {
 		k.sink.Info(level, msg, keysAndValues...)
@@ -53,6 +67,7 @@ func (k *KubeAwareLogSink) Info(level int, msg string, keysAndValues ...interfac
 	k.sink.Info(level, msg, k.wrapKeyAndValues(keysAndValues)...)
 }
 
+// Error implements logr.LogSink.
 func (k *KubeAwareLogSink) Error(err error, msg string, keysAndValues ...interface{}) {
 	if !k.KubeAwareEnabled() {
 		k.sink.Error(err, msg, keysAndValues...)
@@ -61,45 +76,50 @@ func (k *KubeAwareLogSink) Error(err error, msg string, keysAndValues ...interfa
 	k.sink.Error(err, msg, k.wrapKeyAndValues(keysAndValues)...)
 }
 
-func (k *KubeAwareLogSink) wrapKeyAndValues(keysAndValues []interface{}) []interface{} {
-	result := make([]interface{}, len(keysAndValues))
-	for i, item := range keysAndValues {
-		if i%2 == 0 {
-			// item is key, no need to resolve
-			result[i] = item
-			continue
-		}
-
-		switch val := item.(type) {
-		case runtime.Object:
-			result[i] = &kubeObjectWrapper{obj: val}
-		case types.NamespacedName:
-			result[i] = &namespacedNameWrapper{NamespacedName: val}
-		default:
-			result[i] = item
-		}
-	}
-	return result
-}
-
+// WithValues implements logr.LogSink.
 func (k *KubeAwareLogSink) WithValues(keysAndValues ...interface{}) logr.LogSink {
 	return &KubeAwareLogSink{
 		kubeAwareEnabled: k.kubeAwareEnabled,
 		sink:             k.sink.WithValues(k.wrapKeyAndValues(keysAndValues)...),
 	}
 }
 
+// WithName implements logr.LogSink.
 func (k *KubeAwareLogSink) WithName(name string) logr.LogSink {
 	return &KubeAwareLogSink{
 		kubeAwareEnabled: k.kubeAwareEnabled,
 		sink:             k.sink.WithName(name),
 	}
 }
 
+// KubeAwareEnabled return kube aware logging is enabled or not.
 func (k *KubeAwareLogSink) KubeAwareEnabled() bool {
 	return k.kubeAwareEnabled.Load()
 }
 
+// SetKubeAwareEnabled could update the kube aware logging flag.
 func (k *KubeAwareLogSink) SetKubeAwareEnabled(enabled bool) {
 	k.kubeAwareEnabled.Store(enabled)
 }
+
+// wrapKeyAndValues would replace the kubernetes objects with wrappers.
+func (k *KubeAwareLogSink) wrapKeyAndValues(keysAndValues []interface{}) []interface{} {
+	result := make([]interface{}, len(keysAndValues))
+	for i, item := range keysAndValues {
+		if i%2 == 0 {
+			// item is key, no need to resolve
+			result[i] = item
+			continue
+		}
+
+		switch val := item.(type) {
+		case runtime.Object:
+			result[i] = &kubeObjectWrapper{obj: val}
+		case types.NamespacedName:
+			result[i] = &namespacedNameWrapper{NamespacedName: val}
+		default:
+			result[i] = item
+		}
+	}
+	return result
+}

pkg/log/logr/kube_object_wrapper.go

@@ -17,11 +17,15 @@ limitations under the License.
 package logr
 
 import (
+	"reflect"
+
+	"github.com/go-logr/logr"
 	"k8s.io/apimachinery/pkg/api/meta"
 	"k8s.io/apimachinery/pkg/runtime"
-	"reflect"
 )
 
+var _ logr.Marshaler = (*kubeObjectWrapper)(nil)
+
 type kubeObjectWrapper struct {
 	obj runtime.Object
 }

pkg/log/logr/logr_test.go

@@ -18,7 +18,9 @@ package logr
 
 import (
 	"bytes"
+
 	"encoding/json"
+
 	"github.com/go-logr/logr"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
@@ -79,7 +81,7 @@ var _ = Describe("Logr logSink setup", func() {
 
 			It("should log a standard non-namespaced Kubernetes object name", func() {
 				node := &corev1.Node{}
-				node.Name = "some-node"
+				node.Name = "some-node-1"
 				logger.Info("here's a kubernetes object", "thing", node)
 
 				outRaw := logOut.Bytes()
@@ -93,7 +95,7 @@ var _ = Describe("Logr logSink setup", func() {
 
 			It("should log a standard Kubernetes object's kind, if set", func() {
 				node := &corev1.Node{}
-				node.Name = "some-node"
+				node.Name = "some-node-2"
 				node.APIVersion = "v1"
 				node.Kind = "Node"
 				logger.Info("here's a kubernetes object", "thing", node)
@@ -110,7 +112,7 @@ var _ = Describe("Logr logSink setup", func() {
 			})
 
 			It("should log a standard non-namespaced NamespacedName name", func() {
-				name := types.NamespacedName{Name: "some-node"}
+				name := types.NamespacedName{Name: "some-node-3"}
 				logger.Info("here's a kubernetes object", "thing", name)
 
 				outRaw := logOut.Bytes()

pkg/log/logr/namespaced_name_wrapper.go

@@ -16,7 +16,12 @@ limitations under the License.
 
 package logr
 
-import "k8s.io/apimachinery/pkg/types"
+import (
+	"github.com/go-logr/logr"
+	"k8s.io/apimachinery/pkg/types"
+)
+
+var _ logr.Marshaler = (*namespacedNameWrapper)(nil)
 
 type namespacedNameWrapper struct {
 	types.NamespacedName

pkg/log/zap/zap.go

@@ -39,6 +39,7 @@ type NewEncoderFunc func(...EncoderConfigOption) zapcore.Encoder
 // New returns a brand new Logger configured with Opts. It
 // uses KubeAwareEncoder which adds Type information and
 // Namespace/Name to the log.
+// Deprecated: use bootstrap.New as instead.
 func New(opts ...Opts) logr.Logger {
 	return zapr.NewLogger(NewRaw(opts...))
 }

pkg/log/zap/zap_test.go

@@ -178,7 +178,7 @@ var _ = Describe("Zap logger setup", func() {
 
 			It("should log a standard non-namespaced Kubernetes object name", func() {
 				node := &corev1.Node{}
-				node.Name = "some-node"
+				node.Name = "some-node-1"
 				logger.Info("here's a kubernetes object", "thing", node)
 
 				outRaw := logOut.Bytes()
@@ -192,7 +192,7 @@ var _ = Describe("Zap logger setup", func() {
 
 			It("should log a standard Kubernetes object's kind, if set", func() {
 				node := &corev1.Node{}
-				node.Name = "some-node"
+				node.Name = "some-node-2"
 				node.APIVersion = "v1"
 				node.Kind = "Node"
 				logger.Info("here's a kubernetes object", "thing", node)
@@ -209,7 +209,7 @@ var _ = Describe("Zap logger setup", func() {
 			})
 
 			It("should log a standard non-namespaced NamespacedName name", func() {
-				name := types.NamespacedName{Name: "some-node"}
+				name := types.NamespacedName{Name: "some-node-3"}
 				logger.Info("here's a kubernetes object", "thing", name)
 
 				outRaw := logOut.Bytes()