Merge pull request #847 from hzxuzhonghu/logger-improve

nlgwcy · web-flow · commit 53caaa81015e · 2024-09-14T17:24:16.000+08:00
make default logger only print to stderr not file
diff --git a/daemon/main.go b/daemon/main.go
@@ -25,7 +25,7 @@ import (
 )
 
 func main() {
-	var log = logger.NewLoggerField("main")
+	var log = logger.NewLoggerScope("main")
 	cmd := manager.NewCommand()
 	if err := cmd.Execute(); err != nil {
 		log.Error(err)
diff --git a/daemon/manager/manager.go b/daemon/manager/manager.go
@@ -43,7 +43,7 @@ const (
 	pkgSubsys = "manager"
 )
 
-var log = logger.NewLoggerField(pkgSubsys)
+var log = logger.NewLoggerScope(pkgSubsys)
 
 func NewCommand() *cobra.Command {
 	configs := options.NewBootstrapConfigs()
diff --git a/pkg/auth/rbac.go b/pkg/auth/rbac.go
@@ -47,7 +47,7 @@ const (
 )
 
 var (
-	log = logger.NewLoggerField("pkg/auth")
+	log = logger.NewLoggerScope("auth")
 )
 
 type Rbac struct {
diff --git a/pkg/bpf/bpf.go b/pkg/bpf/bpf.go
@@ -39,7 +39,7 @@ import (
 )
 
 var (
-	log  = logger.NewLoggerField("pkg/bpf")
+	log  = logger.NewLoggerScope("bpf")
 	hash = fnv.New32a()
 )
 
diff --git a/pkg/cache/v2/listener.go b/pkg/cache/v2/listener.go
@@ -32,7 +32,7 @@ import (
 
 var RWListener sync.RWMutex
 
-var log = logger.NewLoggerField("cache/v2")
+var log = logger.NewLoggerScope("cache/v2")
 
 type ListenerCache struct {
 	mutex            sync.RWMutex
diff --git a/pkg/cache/v2/maps/listener.go b/pkg/cache/v2/maps/listener.go
@@ -35,7 +35,7 @@ import (
 )
 
 var (
-	log = logger.NewLoggerField("cache/v2/maps")
+	log = logger.NewLoggerScope("cache/v2/maps")
 )
 
 func listenerToGolang(goMsg *listener_v2.Listener, cMsg *C.Listener__Listener) error {
diff --git a/pkg/cni/install.go b/pkg/cni/install.go
@@ -31,7 +31,7 @@ import (
 	"kmesh.net/kmesh/pkg/logger"
 )
 
-var log = logger.NewLoggerField("cni installer")
+var log = logger.NewLoggerScope("cni installer")
 
 func (i *Installer) addCniConfig() error {
 	var err error
diff --git a/pkg/cni/plugin/plugin.go b/pkg/cni/plugin/plugin.go
@@ -36,7 +36,7 @@ import (
 )
 
 var (
-	log = logger.NewLoggerFieldWithoutStdout("plugin/cniplugin")
+	log = logger.NewFileLogger("cniplugin")
 )
 
 // cniConf is whatever you expect your configuration json to be. This is whatever
diff --git a/pkg/controller/ads/ads_controller.go b/pkg/controller/ads/ads_controller.go
@@ -27,7 +27,7 @@ import (
 )
 
 var (
-	log = logger.NewLoggerField("ads_controller")
+	log = logger.NewLoggerScope("ads_controller")
 )
 
 type Controller struct {
diff --git a/pkg/controller/bypass/bypass_controller.go b/pkg/controller/bypass/bypass_controller.go
@@ -34,7 +34,7 @@ import (
 )
 
 var (
-	log = logger.NewLoggerField("bypass")
+	log = logger.NewLoggerScope("bypass")
 )
 
 const (
diff --git a/pkg/controller/config/config.go b/pkg/controller/config/config.go
@@ -45,7 +45,7 @@ const (
 )
 
 var (
-	log    = logger.NewLoggerField("controller/config")
+	log    = logger.NewLoggerScope("controller/config")
 	config *XdsConfig
 )
 
diff --git a/pkg/controller/controller.go b/pkg/controller/controller.go
@@ -33,7 +33,7 @@ import (
 
 var (
 	ctx, cancel = context.WithCancel(context.Background())
-	log         = logger.NewLoggerField("controller")
+	log         = logger.NewLoggerScope("controller")
 )
 
 type Controller struct {
diff --git a/pkg/controller/manage/manage_controller.go b/pkg/controller/manage/manage_controller.go
@@ -41,7 +41,7 @@ import (
 	"kmesh.net/kmesh/pkg/utils"
 )
 
-var log = logger.NewLoggerField("manage_controller")
+var log = logger.NewLoggerScope("manage_controller")
 
 const (
 	MaxRetries             = 5
diff --git a/pkg/controller/security/manager.go b/pkg/controller/security/manager.go
@@ -27,7 +27,7 @@ import (
 	"kmesh.net/kmesh/pkg/logger"
 )
 
-var log = logger.NewLoggerField("security")
+var log = logger.NewLoggerScope("security")
 
 type certItem struct {
 	cert   *istiosecurity.SecretItem
diff --git a/pkg/controller/telemetry/utils.go b/pkg/controller/telemetry/utils.go
@@ -30,7 +30,7 @@ import (
 )
 
 var (
-	log            = logger.NewLoggerField("pkg/telemetry")
+	log            = logger.NewLoggerScope("telemetry")
 	mu             sync.Mutex
 	deleteWorkload = []*workloadapi.Workload{}
 	deleteService  = []string{}
diff --git a/pkg/controller/workload/bpfcache/factory.go b/pkg/controller/workload/bpfcache/factory.go
@@ -23,7 +23,7 @@ import (
 	"kmesh.net/kmesh/pkg/logger"
 )
 
-var log = logger.NewLoggerField("workload_bpfcache")
+var log = logger.NewLoggerScope("workload_bpfcache")
 
 type Cache struct {
 	bpfMap bpf2go.KmeshCgroupSockWorkloadMaps
diff --git a/pkg/controller/workload/workload_controller.go b/pkg/controller/workload/workload_controller.go
@@ -33,7 +33,7 @@ const (
 	AuthorizationType = "type.googleapis.com/istio.security.Authorization"
 )
 
-var log = logger.NewLoggerField("workload_controller")
+var log = logger.NewLoggerScope("workload_controller")
 
 type Controller struct {
 	Stream           discoveryv3.AggregatedDiscoveryService_DeltaAggregatedResourcesClient
diff --git a/pkg/dns/dns.go b/pkg/dns/dns.go
@@ -38,7 +38,7 @@ import (
 )
 
 var (
-	log = logger.NewLoggerField("dns_resolver")
+	log = logger.NewLoggerScope("dns_resolver")
 )
 
 const (
diff --git a/pkg/logger/logger.go b/pkg/logger/logger.go
@@ -33,9 +33,8 @@ import (
 )
 
 const (
-	logSubsys   = "subsys"
-	mapName     = "kmesh_events"
-	MAX_MSG_LEN = 255
+	logSubsys = "subsys"
+	mapName   = "kmesh_events"
 )
 
 type LogEvent struct {
@@ -44,8 +43,8 @@ type LogEvent struct {
 }
 
 var (
-	defaultLogger  = InitializeDefaultLogger(false)
-	fileOnlyLogger = InitializeDefaultLogger(true)
+	defaultLogger  = initDefaultLogger()
+	fileOnlyLogger = initFileLogger()
 
 	defaultLogLevel = logrus.InfoLevel
 	defaultLogFile  = "/var/run/kmesh/daemon.log"
@@ -61,22 +60,6 @@ var (
 	}
 )
 
-func PrintLogs() error {
-	logsPath := defaultLogFile
-	file, err := os.Open(logsPath)
-	if err != nil {
-		return err
-	}
-	defer file.Close()
-
-	// Redirct file contents to STDOUT
-	_, err = io.Copy(os.Stdout, file)
-	if err != nil {
-		return err
-	}
-	return nil
-}
-
 func SetLoggerLevel(loggerName string, level logrus.Level) error {
 	logger, exists := loggerMap[loggerName]
 	if !exists || logger == nil {
@@ -102,12 +85,17 @@ func GetLoggerNames() []string {
 	return names
 }
 
-// InitializeDefaultLogger return a initialized logger
-func InitializeDefaultLogger(onlyFile bool) *logrus.Logger {
+// initDefaultLogger return a default logger
+func initDefaultLogger() *logrus.Logger {
 	logger := logrus.New()
 	logger.SetFormatter(defaultLogFormat)
 	logger.SetLevel(defaultLogLevel)
+	return logger
+}
 
+// initFileLogger return a file only logger
+func initFileLogger() *logrus.Logger {
+	logger := initDefaultLogger()
 	path, _ := filepath.Split(defaultLogFile)
 	err := os.MkdirAll(path, 0o700)
 	if err != nil {
@@ -121,29 +109,21 @@ func InitializeDefaultLogger(onlyFile bool) *logrus.Logger {
 		MaxAge:     28,    //days
 		Compress:   false, // disabled by default
 	}
-
-	if onlyFile {
-		logger.SetOutput(io.Writer(logfile))
-	} else {
-		logger.SetOutput(io.MultiWriter(os.Stdout, logfile))
-	}
-
+	logger.SetOutput(io.Writer(logfile))
 	return logger
 }
 
-// NewLoggerField allocates a new log entry and adds a field to it.
-func NewLoggerField(pkgSubsys string) *logrus.Entry {
-	return defaultLogger.WithField(logSubsys, pkgSubsys)
+// NewLoggerScope allocates a new log entry for a specific scope.
+func NewLoggerScope(scope string) *logrus.Entry {
+	return defaultLogger.WithField(logSubsys, scope)
 }
 
-// NewLoggerFieldFileOnly don't output log to stdout
-func NewLoggerFieldWithoutStdout(pkgSubsys string) *logrus.Entry {
+// NewFileLogger don't output log to stdout
+func NewFileLogger(pkgSubsys string) *logrus.Entry {
 	return fileOnlyLogger.WithField(logSubsys, pkgSubsys)
 }
 
-/*
-print bpf log to daemon process.
-*/
+// print bpf log in daemon process
 func StartRingBufReader(ctx context.Context, mode string, bpfFsPath string) error {
 	var path string
 
@@ -166,7 +146,7 @@ func StartRingBufReader(ctx context.Context, mode string, bpfFsPath string) erro
 }
 
 func handleLogEvents(ctx context.Context, rbMap *ebpf.Map) {
-	log := NewLoggerField("ebpf")
+	log := NewLoggerScope("ebpf")
 	events, err := ringbuf.NewReader(rbMap)
 	if err != nil {
 		log.Errorf("ringbuf new reader from rb map failed:%v", err)
diff --git a/pkg/status/status_server.go b/pkg/status/status_server.go
@@ -39,7 +39,7 @@ import (
 	"kmesh.net/kmesh/pkg/logger"
 )
 
-var log = logger.NewLoggerField("status")
+var log = logger.NewLoggerScope("status")
 
 const (
 	adminAddr = "localhost:15200"
diff --git a/pkg/utils/exec.go b/pkg/utils/exec.go
@@ -28,7 +28,7 @@ import (
 	"kmesh.net/kmesh/pkg/logger"
 )
 
-var log = logger.NewLoggerField("utils")
+var log = logger.NewLoggerScope("utils")
 
 func ExecuteWithRedirect(cmd string, args []string, stdout io.Writer) error {
 	var err error

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ import (`
`25`	`25`	`)`
`26`	`26`
`27`	`27`	`func main() {`
`28`		`- var log = logger.NewLoggerField("main")`
	`28`	`+ var log = logger.NewLoggerScope("main")`
`29`	`29`	`cmd := manager.NewCommand()`
`30`	`30`	`if err := cmd.Execute(); err != nil {`
`31`	`31`	`log.Error(err)`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ const (`
`43`	`43`	`pkgSubsys = "manager"`
`44`	`44`	`)`
`45`	`45`
`46`		`-var log = logger.NewLoggerField(pkgSubsys)`
	`46`	`+var log = logger.NewLoggerScope(pkgSubsys)`
`47`	`47`
`48`	`48`	`func NewCommand() *cobra.Command {`
`49`	`49`	`configs := options.NewBootstrapConfigs()`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ const (`
`47`	`47`	`)`
`48`	`48`
`49`	`49`	`var (`
`50`		`- log = logger.NewLoggerField("pkg/auth")`
	`50`	`+ log = logger.NewLoggerScope("auth")`
`51`	`51`	`)`
`52`	`52`
`53`	`53`	`type Rbac struct {`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ import (`
`39`	`39`	`)`
`40`	`40`
`41`	`41`	`var (`
`42`		`- log = logger.NewLoggerField("pkg/bpf")`
	`42`	`+ log = logger.NewLoggerScope("bpf")`
`43`	`43`	`hash = fnv.New32a()`
`44`	`44`	`)`
`45`	`45`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ import (`
`35`	`35`	`)`
`36`	`36`
`37`	`37`	`var (`
`38`		`- log = logger.NewLoggerField("cache/v2/maps")`
	`38`	`+ log = logger.NewLoggerScope("cache/v2/maps")`
`39`	`39`	`)`
`40`	`40`
`41`	`41`	`func listenerToGolang(goMsg listener_v2.Listener, cMsg C.Listener__Listener) error {`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ import (`
`31`	`31`	`"kmesh.net/kmesh/pkg/logger"`
`32`	`32`	`)`
`33`	`33`
`34`		`-var log = logger.NewLoggerField("cni installer")`
	`34`	`+var log = logger.NewLoggerScope("cni installer")`
`35`	`35`
`36`	`36`	`func (i *Installer) addCniConfig() error {`
`37`	`37`	`var err error`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ import (`
`36`	`36`	`)`
`37`	`37`
`38`	`38`	`var (`
`39`		`- log = logger.NewLoggerFieldWithoutStdout("plugin/cniplugin")`
	`39`	`+ log = logger.NewFileLogger("cniplugin")`
`40`	`40`	`)`
`41`	`41`
`42`	`42`	`// cniConf is whatever you expect your configuration json to be. This is whatever`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ import (`
`27`	`27`	`)`
`28`	`28`
`29`	`29`	`var (`
`30`		`- log = logger.NewLoggerField("ads_controller")`
	`30`	`+ log = logger.NewLoggerScope("ads_controller")`
`31`	`31`	`)`
`32`	`32`
`33`	`33`	`type Controller struct {`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ import (`
`34`	`34`	`)`
`35`	`35`
`36`	`36`	`var (`
`37`		`- log = logger.NewLoggerField("bypass")`
	`37`	`+ log = logger.NewLoggerScope("bypass")`
`38`	`38`	`)`
`39`	`39`
`40`	`40`	`const (`