chore: new option to enable KubeAwareEncoder

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

Author: STRRL

pkg/log/zap/zap.go

@@ -170,6 +170,11 @@ type Options struct {
 	// TimeEncoder specifies the encoder for the timestamps in log messages.
 	// Defaults to EpochTimeEncoder as this is the default in Zap currently.
 	TimeEncoder zapcore.TimeEncoder
+	// UseKubeAwareEncoder configures the logger to use the KubeAwareEncoder for encoding kubernetes
+	// object as Type information and Namespace/Name.
+	// Note: KubeAwareEncoder could NOT resolve the object passed by logger.WithValues(), see
+	// https://github.com/kubernetes-sigs/controller-runtime/issues/1290
+	UseKubeAwareEncoder bool
 }
 
 // addDefaults adds defaults to the Options.
@@ -245,7 +250,11 @@ func NewRaw(opts ...Opts) *zap.Logger {
 	sink := zapcore.AddSync(o.DestWriter)
 
 	o.ZapOpts = append(o.ZapOpts, zap.AddCallerSkip(1), zap.ErrorOutput(sink))
-	log := zap.New(zapcore.NewCore(&KubeAwareEncoder{Encoder: o.Encoder, Verbose: o.Development}, sink, o.Level))
+	encoder := o.Encoder
+	if o.UseKubeAwareEncoder {
+		encoder = &KubeAwareEncoder{Encoder: o.Encoder, Verbose: o.Development}
+	}
+	log := zap.New(zapcore.NewCore(encoder, sink, o.Level))
 	log = log.WithOptions(o.ZapOpts...)
 	return log
 }