Merge pull request #4885 from zhzhuang-zju/silence

silence the 'log.SetLogger(...) was never called; logs will not be displayed' error

Author: karmada-bot

cmd/controller-manager/controller-manager.go

@@ -21,6 +21,7 @@ import (
 
 	"k8s.io/component-base/cli"
 	_ "k8s.io/component-base/logs/json/register" // for JSON log format registration
+	"k8s.io/klog/v2"
 	controllerruntime "sigs.k8s.io/controller-runtime"
 	_ "sigs.k8s.io/controller-runtime/pkg/metrics"
 
@@ -29,6 +30,12 @@ import (
 
 func main() {
 	ctx := controllerruntime.SetupSignalHandler()
+	// Starting from version 0.15.0, controller-runtime expects its consumers to set a logger through log.SetLogger.
+	// If SetLogger is not called within the first 30 seconds of a binaries lifetime, it will get
+	// set to a NullLogSink and report an error. Here's to silence the "log.SetLogger(...) was never called; logs will not be displayed" error
+	// by setting a logger through log.SetLogger.
+	// More info refer to: https://github.com/karmada-io/karmada/pull/4885.
+	controllerruntime.SetLogger(klog.Background())
 	cmd := app.NewControllerManagerCommand(ctx)
 	code := cli.Run(cmd)
 	os.Exit(code)

cmd/metrics-adapter/main.go

@@ -21,13 +21,20 @@ import (
 
 	"k8s.io/component-base/cli"
 	_ "k8s.io/component-base/logs/json/register" // for JSON log format registration
+	"k8s.io/klog/v2"
 	controllerruntime "sigs.k8s.io/controller-runtime"
 
 	"github.com/karmada-io/karmada/cmd/metrics-adapter/app"
 )
 
 func main() {
 	ctx := controllerruntime.SetupSignalHandler()
+	// Starting from version 0.15.0, controller-runtime expects its consumers to set a logger through log.SetLogger.
+	// If SetLogger is not called within the first 30 seconds of a binaries lifetime, it will get
+	// set to a NullLogSink and report an error. Here's to silence the "log.SetLogger(...) was never called; logs will not be displayed" error
+	// by setting a logger through log.SetLogger.
+	// More info refer to: https://github.com/karmada-io/karmada/pull/4885.
+	controllerruntime.SetLogger(klog.Background())
 	cmd := app.NewMetricsAdapterCommand(ctx)
 	code := cli.Run(cmd)
 	os.Exit(code)

cmd/webhook/main.go

@@ -21,13 +21,20 @@ import (
 
 	"k8s.io/component-base/cli"
 	_ "k8s.io/component-base/logs/json/register" // for JSON log format registration
+	"k8s.io/klog/v2"
 	controllerruntime "sigs.k8s.io/controller-runtime"
 
 	"github.com/karmada-io/karmada/cmd/webhook/app"
 )
 
 func main() {
 	ctx := controllerruntime.SetupSignalHandler()
+	// Starting from version 0.15.0, controller-runtime expects its consumers to set a logger through log.SetLogger.
+	// If SetLogger is not called within the first 30 seconds of a binaries lifetime, it will get
+	// set to a NullLogSink and report an error. Here's to silence the "log.SetLogger(...) was never called; logs will not be displayed" error
+	// by setting a logger through log.SetLogger.
+	// More info refer to: https://github.com/karmada-io/karmada/pull/4885.
+	controllerruntime.SetLogger(klog.Background())
 	cmd := app.NewWebhookCommand(ctx)
 	code := cli.Run(cmd)
 	os.Exit(code)

examples/customresourceinterpreter/webhook/main.go

@@ -21,13 +21,20 @@ import (
 
 	"k8s.io/component-base/cli"
 	_ "k8s.io/component-base/logs/json/register" // for JSON log format registration
+	"k8s.io/klog/v2"
 	controllerruntime "sigs.k8s.io/controller-runtime"
 
 	"github.com/karmada-io/karmada/examples/customresourceinterpreter/webhook/app"
 )
 
 func main() {
 	ctx := controllerruntime.SetupSignalHandler()
+	// Starting from version 0.15.0, controller-runtime expects its consumers to set a logger through log.SetLogger.
+	// If SetLogger is not called within the first 30 seconds of a binaries lifetime, it will get
+	// set to a NullLogSink and report an error. Here's to silence the "log.SetLogger(...) was never called; logs will not be displayed" error
+	// by setting a logger through log.SetLogger.
+	// More info refer to: https://github.com/karmada-io/karmada/pull/4885.
+	controllerruntime.SetLogger(klog.Background())
 	cmd := app.NewWebhookCommand(ctx)
 	code := cli.Run(cmd)
 	os.Exit(code)