Merge pull request #4968 from Shubhamag12/issue-4930-logrus

⚠️  Migrate from logrus to log/slog

Author: k8s-ci-robot

cmd/cmd.go

@@ -17,11 +17,15 @@ limitations under the License.
 package cmd
 
 import (
-	"github.com/sirupsen/logrus"
+	"log"
+	"log/slog"
+	"os"
+
 	"github.com/spf13/afero"
 
 	"sigs.k8s.io/kubebuilder/v4/pkg/cli"
 	cfgv3 "sigs.k8s.io/kubebuilder/v4/pkg/config/v3"
+	"sigs.k8s.io/kubebuilder/v4/pkg/logging"
 	"sigs.k8s.io/kubebuilder/v4/pkg/machinery"
 	"sigs.k8s.io/kubebuilder/v4/pkg/plugin"
 	kustomizecommonv2 "sigs.k8s.io/kubebuilder/v4/pkg/plugins/common/kustomize/v2"
@@ -33,8 +37,14 @@ import (
 )
 
 func init() {
-	// Disable timestamps on the default TextFormatter
-	logrus.SetFormatter(&logrus.TextFormatter{DisableTimestamp: true})
+	opts := logging.HandlerOptions{
+		SlogOpts: slog.HandlerOptions{
+			Level: slog.LevelInfo,
+		},
+	}
+	handler := logging.NewHandler(os.Stdout, opts)
+	logger := slog.New(handler)
+	slog.SetDefault(logger)
 }
 
 // Run bootstraps & runs the CLI
@@ -50,7 +60,7 @@ func Run() {
 	}
 	externalPlugins, err := cli.DiscoverExternalPlugins(fs.FS)
 	if err != nil {
-		logrus.Error(err)
+		slog.Error("error discovering external plugins", "error", err)
 	}
 
 	c, err := cli.New(
@@ -71,9 +81,9 @@ func Run() {
 		cli.WithCompletion(),
 	)
 	if err != nil {
-		logrus.Fatal(err)
+		log.Fatal(err)
 	}
 	if err := c.Run(); err != nil {
-		logrus.Fatal(err)
+		log.Fatal(err)
 	}
 }

docs/book/src/plugins/extending/extending_cli_features_and_plugins.md

@@ -233,7 +233,7 @@ program in `kubebuilder init`. Following an example:
 package cli
 
 import (
-	log "github.com/sirupsen/logrus"
+	log "log/slog"
 	"github.com/spf13/cobra"
 
 	"sigs.k8s.io/kubebuilder/v4/pkg/cli"

go.mod

@@ -6,7 +6,6 @@ require (
 	github.com/gobuffalo/flect v1.0.3
 	github.com/onsi/ginkgo/v2 v2.23.4
 	github.com/onsi/gomega v1.38.0
-	github.com/sirupsen/logrus v1.9.3
 	github.com/spf13/afero v1.14.0
 	github.com/spf13/cobra v1.9.1
 	github.com/spf13/pflag v1.0.7

go.sum

@@ -48,8 +48,6 @@ github.com/rogpeppe/go-internal v1.9.0/go.mod h1:WtVeX8xhTBvf0smdhujwtBcq4Qrzq/f
 github.com/rogpeppe/go-internal v1.14.1 h1:UQB4HGPB6osV0SQTLymcB4TgvyWu6ZyliaW0tI/otEQ=
 github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7so1lCWt35ZSgc=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
-github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=
-github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
 github.com/spf13/afero v1.14.0 h1:9tH6MapGnn/j0eb0yIXiLjERO8RB6xIVZRDCX7PtqWA=
 github.com/spf13/afero v1.14.0/go.mod h1:acJQ8t0ohCGuMN3O+Pv0V0hgMxNYDlvdk+VTfyZmbYo=
 github.com/spf13/cobra v1.9.1 h1:CXSaggrXdbHK9CF+8ywj8Amf7PBRmPCOJugH954Nnlo=
@@ -60,7 +58,6 @@ github.com/spf13/pflag v1.0.7/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
 github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
-github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
 github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
@@ -78,7 +75,6 @@ golang.org/x/net v0.42.0 h1:jzkYrhi3YQWD6MLBJcsklgQsoAcw89EcZbJw8Z614hs=
 golang.org/x/net v0.42.0/go.mod h1:FF1RA5d3u7nAYA4z2TkclSCKh68eSXtiFwcWQpPXdt8=
 golang.org/x/sync v0.16.0 h1:ycBJEhp9p4vXvUZNszeOq0kGTPghopOL8q0fq3vstxw=
 golang.org/x/sync v0.16.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA=
-golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.34.0 h1:H5Y5sJ2L2JRdyv7ROF1he/lPdvFsd0mJHFw2ThKHxLA=
 golang.org/x/sys v0.34.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
 golang.org/x/text v0.27.0 h1:4fGWRpyh641NLlecmyl4LOe6yDdfaYNrGb2zdfo4JV4=

hack/docs/generate_samples.go

@@ -17,11 +17,13 @@ limitations under the License.
 package main
 
 import (
-	log "github.com/sirupsen/logrus"
+	"log/slog"
+	"os"
 
 	cronjob "sigs.k8s.io/kubebuilder/v4/hack/docs/internal/cronjob-tutorial"
 	gettingstarted "sigs.k8s.io/kubebuilder/v4/hack/docs/internal/getting-started"
 	multiversion "sigs.k8s.io/kubebuilder/v4/hack/docs/internal/multiversion-tutorial"
+	"sigs.k8s.io/kubebuilder/v4/pkg/logging"
 )
 
 // KubebuilderBinName make sure executing `build_kb` to generate kb executable from the source code
@@ -43,11 +45,18 @@ func main() {
 		"multiversion":    updateMultiversionTutorial,
 	}
 
-	log.SetFormatter(&log.TextFormatter{DisableTimestamp: true})
-	log.Println("Generating documents...")
+	opts := logging.HandlerOptions{
+		SlogOpts: slog.HandlerOptions{
+			Level: slog.LevelInfo,
+		},
+	}
+	handler := logging.NewHandler(os.Stdout, opts)
+	logger := slog.New(handler)
+	slog.SetDefault(logger)
+	slog.Info("Generating documents...")
 
 	for tutorial, updater := range tutorials {
-		log.Printf("Generating %s tutorial\n", tutorial)
+		slog.Info("Generating tutorial", "name", tutorial)
 		updater()
 	}
 }

hack/docs/internal/cronjob-tutorial/generate_cronjob.go

@@ -18,10 +18,10 @@ package cronjob
 
 import (
 	"fmt"
+	log "log/slog"
 	"os/exec"
 	"path/filepath"
 
-	log "github.com/sirupsen/logrus"
 	"github.com/spf13/afero"
 
 	hackutils "sigs.k8s.io/kubebuilder/v4/hack/docs/utils"
@@ -37,25 +37,25 @@ type Sample struct {
 
 // NewSample create a new instance of the cronjob sample and configure the KB CLI that will be used
 func NewSample(binaryPath, samplePath string) Sample {
-	log.Infof("Generating the sample context of Cronjob...")
+	log.Info("Generating the sample context of Cronjob...")
 	ctx := hackutils.NewSampleContext(binaryPath, samplePath, "GO111MODULE=on")
 	return Sample{&ctx}
 }
 
 // Prepare the Context for the sample project
 func (sp *Sample) Prepare() {
-	log.Infof("destroying directory for cronjob sample project")
+	log.Info("destroying directory for cronjob sample project")
 	sp.ctx.Destroy()
 
-	log.Infof("refreshing tools and creating directory...")
+	log.Info("refreshing tools and creating directory...")
 	err := sp.ctx.Prepare()
 
 	hackutils.CheckError("creating directory for sample project", err)
 }
 
 // GenerateSampleProject will generate the sample
 func (sp *Sample) GenerateSampleProject() {
-	log.Infof("Initializing the cronjob project")
+	log.Info("Initializing the cronjob project")
 
 	err := sp.ctx.Init(
 		"--domain", "tutorial.kubebuilder.io",
@@ -65,7 +65,7 @@ func (sp *Sample) GenerateSampleProject() {
 	)
 	hackutils.CheckError("Initializing the cronjob project", err)
 
-	log.Infof("Adding a new config type")
+	log.Info("Adding a new config type")
 	err = sp.ctx.CreateAPI(
 		"--group", "batch",
 		"--version", "v1",
@@ -74,7 +74,7 @@ func (sp *Sample) GenerateSampleProject() {
 	)
 	hackutils.CheckError("Creating the API", err)
 
-	log.Infof("Implementing admission webhook")
+	log.Info("Implementing admission webhook")
 	err = sp.ctx.CreateWebhook(
 		"--group", "batch",
 		"--version", "v1",
@@ -86,7 +86,7 @@ func (sp *Sample) GenerateSampleProject() {
 
 // UpdateTutorial the cronjob tutorial with the scaffold changes
 func (sp *Sample) UpdateTutorial() {
-	log.Println("Update tutorial with cronjob code")
+	log.Info("Update tutorial with cronjob code")
 	// 1. update specs
 	sp.updateSpec()
 	// 2. update webhook

hack/docs/internal/getting-started/generate_getting_started.go

@@ -17,11 +17,10 @@ limitations under the License.
 package gettingstarted
 
 import (
+	"log/slog"
 	"os/exec"
 	"path/filepath"
 
-	log "github.com/sirupsen/logrus"
-
 	hackutils "sigs.k8s.io/kubebuilder/v4/hack/docs/utils"
 	pluginutil "sigs.k8s.io/kubebuilder/v4/pkg/plugin/util"
 	"sigs.k8s.io/kubebuilder/v4/test/e2e/utils"
@@ -34,7 +33,7 @@ type Sample struct {
 
 // NewSample create a new instance of the getting started sample and configure the KB CLI that will be used
 func NewSample(binaryPath, samplePath string) Sample {
-	log.Infof("Generating the sample context of getting-started...")
+	slog.Info("Generating the sample context of getting-started...")
 	ctx := hackutils.NewSampleContext(binaryPath, samplePath, "GO111MODULE=on")
 	return Sample{&ctx}
 }
@@ -192,18 +191,18 @@ func (sp *Sample) updateController() {
 
 // Prepare the Context for the sample project
 func (sp *Sample) Prepare() {
-	log.Infof("Destroying directory for getting-started sample project")
+	slog.Info("Destroying directory for getting-started sample project")
 	sp.ctx.Destroy()
 
-	log.Infof("Refreshing tools and creating directory...")
+	slog.Info("Refreshing tools and creating directory...")
 	err := sp.ctx.Prepare()
 
 	hackutils.CheckError("Creating directory for sample project", err)
 }
 
 // GenerateSampleProject will generate the sample
 func (sp *Sample) GenerateSampleProject() {
-	log.Infof("Initializing the getting started project")
+	slog.Info("Initializing the getting started project")
 	err := sp.ctx.Init(
 		"--domain", "example.com",
 		"--repo", "example.com/memcached",
@@ -212,7 +211,7 @@ func (sp *Sample) GenerateSampleProject() {
 	)
 	hackutils.CheckError("Initializing the getting started project", err)
 
-	log.Infof("Adding a new config type")
+	slog.Info("Adding a new config type")
 	err = sp.ctx.CreateAPI(
 		"--group", "cache",
 		"--version", "v1alpha1",

hack/docs/internal/multiversion-tutorial/generate_multiversion.go

@@ -17,11 +17,10 @@ limitations under the License.
 package multiversion
 
 import (
+	log "log/slog"
 	"os/exec"
 	"path/filepath"
 
-	log "github.com/sirupsen/logrus"
-
 	hackutils "sigs.k8s.io/kubebuilder/v4/hack/docs/utils"
 	pluginutil "sigs.k8s.io/kubebuilder/v4/pkg/plugin/util"
 	"sigs.k8s.io/kubebuilder/v4/test/e2e/utils"
@@ -34,23 +33,23 @@ type Sample struct {
 
 // NewSample create a new instance of the sample and configure the KB CLI that will be used
 func NewSample(binaryPath, samplePath string) Sample {
-	log.Infof("Generating the sample context of MultiVersion Cronjob...")
+	log.Info("Generating the sample context of MultiVersion Cronjob...")
 	ctx := hackutils.NewSampleContext(binaryPath, samplePath, "GO111MODULE=on")
 	return Sample{&ctx}
 }
 
 // Prepare the Context for the sample project
 func (sp *Sample) Prepare() {
-	log.Infof("refreshing tools and creating directory for multiversion ...")
+	log.Info("refreshing tools and creating directory for multiversion ...")
 	err := sp.ctx.Prepare()
 	hackutils.CheckError("creating directory for multiversion project", err)
 }
 
 // GenerateSampleProject will generate the sample
 func (sp *Sample) GenerateSampleProject() {
-	log.Infof("Initializing the multiversion cronjob project")
+	log.Info("Initializing the multiversion cronjob project")
 
-	log.Infof("Creating v2 API")
+	log.Info("Creating v2 API")
 	err := sp.ctx.CreateAPI(
 		"--group", "batch",
 		"--version", "v2",
@@ -60,7 +59,7 @@ func (sp *Sample) GenerateSampleProject() {
 	)
 	hackutils.CheckError("Creating the v2 API without controller", err)
 
-	log.Infof("Creating conversion webhook for v1")
+	log.Info("Creating conversion webhook for v1")
 	err = sp.ctx.CreateWebhook(
 		"--group", "batch",
 		"--version", "v1",
@@ -71,7 +70,7 @@ func (sp *Sample) GenerateSampleProject() {
 	)
 	hackutils.CheckError("Creating conversion webhook for v1", err)
 
-	log.Infof("Workaround to fix the issue with the conversion webhook")
+	log.Info("Workaround to fix the issue with the conversion webhook")
 	// FIXME: This is a workaround to fix the issue with the conversion webhook
 	// We should be able to inject the code when we create webhooks with different
 	// types of webhooks. However, currently, we are not able to do that and we need to
@@ -81,7 +80,7 @@ func (sp *Sample) GenerateSampleProject() {
 	_, err = sp.ctx.Run(cmd)
 	hackutils.CheckError("Copying the code from cronjob tutorial", err)
 
-	log.Infof("Creating defaulting and validation webhook for v2")
+	log.Info("Creating defaulting and validation webhook for v2")
 	err = sp.ctx.CreateWebhook(
 		"--group", "batch",
 		"--version", "v2",
@@ -94,7 +93,7 @@ func (sp *Sample) GenerateSampleProject() {
 
 // UpdateTutorial the muilt-version sample tutorial with the scaffold changes
 func (sp *Sample) UpdateTutorial() {
-	log.Println("Update tutorial with multiversion code")
+	log.Info("Update tutorial with multiversion code")
 
 	// Update files according to the multiversion
 	sp.updateCronjobV1DueForce()

hack/docs/utils/utils.go

@@ -17,17 +17,16 @@ limitations under the License.
 package utils
 
 import (
+	log "log/slog"
 	"os"
 
-	log "github.com/sirupsen/logrus"
-
 	"sigs.k8s.io/kubebuilder/v4/test/e2e/utils"
 )
 
 // CheckError will exit with exit code 1 when err is not nil.
 func CheckError(msg string, err error) {
 	if err != nil {
-		log.Errorf("error %s: %s", msg, err)
+		log.Error("error occurred", "message", msg, "error", err)
 		os.Exit(1)
 	}
 }

pkg/cli/alpha/command.go

@@ -14,7 +14,8 @@ limitations under the License.
 package alpha
 
 import (
-	log "github.com/sirupsen/logrus"
+	"log"
+
 	"github.com/spf13/cobra"
 
 	"sigs.k8s.io/kubebuilder/v4/pkg/cli/alpha/internal"