From bca2f7250f38d501285b09ce3ef72412d7a00aab Mon Sep 17 00:00:00 2001 From: tison Date: Tue, 15 Jun 2021 10:54:37 +0800 Subject: [PATCH] logutil: InitLogger as a more abstract method, deprecated InitZapLogger (#25381) --- cmd/benchdb/main.go | 2 +- cmd/benchfilesort/main.go | 2 +- cmd/explaintest/main.go | 2 +- server/server_test.go | 2 +- tidb-server/main.go | 4 ++-- util/logutil/log.go | 15 ++++++++------- util/logutil/log_test.go | 6 +++--- 7 files changed, 17 insertions(+), 16 deletions(-) diff --git a/cmd/benchdb/main.go b/cmd/benchdb/main.go index 1971150a24..ee448cb707 100644 --- a/cmd/benchdb/main.go +++ b/cmd/benchdb/main.go @@ -54,7 +54,7 @@ var ( func main() { flag.Parse() flag.PrintDefaults() - err := logutil.InitZapLogger(logutil.NewLogConfig(*logLevel, logutil.DefaultLogFormat, "", logutil.EmptyFileLogConfig, false)) + err := logutil.InitLogger(logutil.NewLogConfig(*logLevel, logutil.DefaultLogFormat, "", logutil.EmptyFileLogConfig, false)) terror.MustNil(err) err = store.Register("tikv", driver.TiKVDriver{}) terror.MustNil(err) diff --git a/cmd/benchfilesort/main.go b/cmd/benchfilesort/main.go index 943968a0ea..e5b8204f18 100644 --- a/cmd/benchfilesort/main.go +++ b/cmd/benchfilesort/main.go @@ -381,7 +381,7 @@ func driveRunCmd() { } func init() { - err := logutil.InitZapLogger(logutil.NewLogConfig(logLevel, logutil.DefaultLogFormat, "", logutil.EmptyFileLogConfig, false)) + err := logutil.InitLogger(logutil.NewLogConfig(logLevel, logutil.DefaultLogFormat, "", logutil.EmptyFileLogConfig, false)) terror.MustNil(err) cwd, err1 := os.Getwd() terror.MustNil(err1) diff --git a/cmd/explaintest/main.go b/cmd/explaintest/main.go index ae4fa18d5a..95bc6b993a 100644 --- a/cmd/explaintest/main.go +++ b/cmd/explaintest/main.go @@ -611,7 +611,7 @@ func openDBWithRetry(driverName, dataSourceName string) (mdb *sql.DB, err error) func main() { flag.Parse() - err := logutil.InitZapLogger(logutil.NewLogConfig(logLevel, logutil.DefaultLogFormat, "", logutil.EmptyFileLogConfig, false)) + err := logutil.InitLogger(logutil.NewLogConfig(logLevel, logutil.DefaultLogFormat, "", logutil.EmptyFileLogConfig, false)) if err != nil { panic("init logger fail, " + err.Error()) } diff --git a/server/server_test.go b/server/server_test.go index 461b59a070..36356f5768 100644 --- a/server/server_test.go +++ b/server/server_test.go @@ -58,7 +58,7 @@ func TestT(t *testing.T) { } CustomVerboseFlag = true logLevel := os.Getenv("log_level") - err := logutil.InitZapLogger(logutil.NewLogConfig(logLevel, logutil.DefaultLogFormat, "", logutil.EmptyFileLogConfig, false)) + err := logutil.InitLogger(logutil.NewLogConfig(logLevel, logutil.DefaultLogFormat, "", logutil.EmptyFileLogConfig, false)) if err != nil { t.Fatal(err) } diff --git a/tidb-server/main.go b/tidb-server/main.go index f67c8d14e6..4aefec5748 100644 --- a/tidb-server/main.go +++ b/tidb-server/main.go @@ -306,7 +306,7 @@ func setupBinlogClient() { terror.MustNil(err) - err = pumpcli.InitLogger(cfg.Log.ToLogConfig()) + err = logutil.InitLogger(cfg.Log.ToLogConfig()) terror.MustNil(err) binloginfo.SetPumpsClient(client) @@ -588,7 +588,7 @@ func setGlobalVars() { func setupLog() { cfg := config.GetGlobalConfig() - err := logutil.InitZapLogger(cfg.Log.ToLogConfig()) + err := logutil.InitLogger(cfg.Log.ToLogConfig()) terror.MustNil(err) // trigger internal http(s) client init. diff --git a/util/logutil/log.go b/util/logutil/log.go index b624846584..6ccb146ff2 100644 --- a/util/logutil/log.go +++ b/util/logutil/log.go @@ -94,16 +94,11 @@ const ( OldSlowLogTimeFormat = "2006-01-02-15:04:05.999999999 -0700" ) -// SlowQueryLogger is used to log slow query, InitZapLogger will modify it according to config file. +// SlowQueryLogger is used to log slow query, InitLogger will modify it according to config file. var SlowQueryLogger = log.L() -// InitLogger delegates to InitZapLogger. Keeping it here for historical reason. +// InitLogger initializes a logger with cfg. func InitLogger(cfg *LogConfig) error { - return InitZapLogger(cfg) -} - -// InitZapLogger initializes a zap logger with cfg. -func InitZapLogger(cfg *LogConfig) error { gl, props, err := log.InitLogger(&cfg.Config, zap.AddStacktrace(zapcore.FatalLevel)) if err != nil { return errors.Trace(err) @@ -127,6 +122,12 @@ func InitZapLogger(cfg *LogConfig) error { return nil } +// InitZapLogger is delegated to InitLogger. +// Deprecated: prefer InitLogger +func InitZapLogger(cfg *LogConfig) error { + return InitLogger(cfg) +} + // SetLevel sets the zap logger's level. func SetLevel(level string) error { l := zap.NewAtomicLevel() diff --git a/util/logutil/log_test.go b/util/logutil/log_test.go index ecc9fb9d03..5733fb7259 100644 --- a/util/logutil/log_test.go +++ b/util/logutil/log_test.go @@ -66,14 +66,14 @@ func (s *testLogSuite) TestZapLoggerWithKeys(c *C) { fileCfg := FileLogConfig{log.FileLogConfig{Filename: "zap_log", MaxSize: 4096}} conf := NewLogConfig("info", DefaultLogFormat, "", fileCfg, false) - err := InitZapLogger(conf) + err := InitLogger(conf) c.Assert(err, IsNil) connID := uint64(123) ctx := WithConnID(context.Background(), connID) s.testZapLogger(ctx, c, fileCfg.Filename, zapLogWithConnIDPattern) os.Remove(fileCfg.Filename) - err = InitZapLogger(conf) + err = InitLogger(conf) c.Assert(err, IsNil) key := "ctxKey" val := "ctxValue" @@ -108,7 +108,7 @@ func (s *testLogSuite) testZapLogger(ctx context.Context, c *C, fileName, patter func (s *testLogSuite) TestSetLevel(c *C) { conf := NewLogConfig("info", DefaultLogFormat, "", EmptyFileLogConfig, false) - err := InitZapLogger(conf) + err := InitLogger(conf) c.Assert(err, IsNil) c.Assert(log.GetLevel(), Equals, zap.InfoLevel)