lightning: emit tidb log by change FilterCore to only allow matched p…

…ackages (#30700)
pingcap · Dec 16, 2021 · 5eac82b · 5eac82b
1 parent 43caa02
commit 5eac82b
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 16 deletions.
diff --git a/br/pkg/lightning/backend/local/engine.go b/br/pkg/lightning/backend/local/engine.go
@@ -883,7 +883,7 @@ func (e *Engine) loadEngineMeta() error {
 	jsonBytes, closer, err := e.db.Get(engineMetaKey)
 	if err != nil {
 		if err == pebble.ErrNotFound {
-			log.L().Debug("local db missing engine meta", zap.Stringer("uuid", e.UUID), zap.Error(err))
+			log.L().Debug("local db missing engine meta", zap.Stringer("uuid", e.UUID), log.ShortError(err))
 			return nil
 		}
 		return err

diff --git a/br/pkg/lightning/log/filter.go b/br/pkg/lightning/log/filter.go
@@ -17,14 +17,14 @@ type FilterCore struct {
 	filters []string
 }
 
-// NewFilterCore returns a FilterCore.
+// NewFilterCore returns a FilterCore, only logs under allowPackages will be written.
 //
-// Example, filter TiDB's log, `NewFilterCore(core, "github.com/pingcap/tidb/")`.
+// Example, only write br's log and ignore any other, `NewFilterCore(core, "github.com/pingcap/tidb/br/")`.
 // Note, must set AddCaller() to the logger.
-func NewFilterCore(core zapcore.Core, filteredPackages ...string) *FilterCore {
+func NewFilterCore(core zapcore.Core, allowPackages ...string) *FilterCore {
 	return &FilterCore{
 		Core:    core,
-		filters: filteredPackages,
+		filters: allowPackages,
 	}
 }
 
@@ -50,8 +50,8 @@ func (f *FilterCore) Write(entry zapcore.Entry, fields []zapcore.Field) error {
 	for i := range f.filters {
 		// Caller.Function is a package path-qualified function name.
 		if strings.Contains(entry.Caller.Function, f.filters[i]) {
-			return nil
+			return f.Core.Write(entry, fields)
 		}
 	}
-	return f.Core.Write(entry, fields)
+	return nil
 }
diff --git a/br/pkg/lightning/log/filter_test.go b/br/pkg/lightning/log/filter_test.go
@@ -25,13 +25,13 @@ func (s *testFilterSuite) TestFilter(c *C) {
 	)
 
 	logger, buffer = log.MakeTestLogger(zap.WrapCore(func(c zapcore.Core) zapcore.Core {
-		return log.NewFilterCore(c, "github.com/pingcap/tidb/br/")
+		return log.NewFilterCore(c, "github.com/pingcap/br/")
 	}), zap.AddCaller())
 	logger.Warn("the message", zap.Int("number", 123456), zap.Ints("array", []int{7, 8, 9}))
 	c.Assert(buffer.Stripped(), HasLen, 0)
 
 	logger, buffer = log.MakeTestLogger(zap.WrapCore(func(c zapcore.Core) zapcore.Core {
-		return log.NewFilterCore(c, "github.com/pingcap/br/").With([]zap.Field{zap.String("a", "b")})
+		return log.NewFilterCore(c, "github.com/pingcap/tidb/br/").With([]zap.Field{zap.String("a", "b")})
 	}), zap.AddCaller())
 	logger.Warn("the message", zap.Int("number", 123456), zap.Ints("array", []int{7, 8, 9}))
 	c.Assert(
@@ -40,7 +40,7 @@ func (s *testFilterSuite) TestFilter(c *C) {
 	)
 
 	logger, buffer = log.MakeTestLogger(zap.WrapCore(func(c zapcore.Core) zapcore.Core {
-		return log.NewFilterCore(c, "github.com/pingcap/tidb/br/").With([]zap.Field{zap.String("a", "b")})
+		return log.NewFilterCore(c, "github.com/pingcap/br/").With([]zap.Field{zap.String("a", "b")})
 	}), zap.AddCaller())
 	logger.Warn("the message", zap.Int("number", 123456), zap.Ints("array", []int{7, 8, 9}))
 	c.Assert(buffer.Stripped(), HasLen, 0)
@@ -49,11 +49,8 @@ func (s *testFilterSuite) TestFilter(c *C) {
 	logger, buffer = log.MakeTestLogger(zap.WrapCore(func(c zapcore.Core) zapcore.Core {
 		return log.NewFilterCore(c, "github.com/pingcap/check/").With([]zap.Field{zap.String("a", "b")})
 	}), zap.AddCaller())
-	logger.Warn("the message", zap.String("stack", "github.com/pingcap/check/"))
-	c.Assert(
-		buffer.Stripped(), Equals,
-		`{"$lvl":"WARN","$msg":"the message","a":"b","stack":"github.com/pingcap/check/"}`,
-	)
+	logger.Warn("the message", zap.String("stack", "github.com/pingcap/tidb/br/"))
+	c.Assert(buffer.Stripped(), HasLen, 0)
 }
 
 // PASS: filter_test.go:82: testFilterSuite.BenchmarkFilterRegexMatchString 1000000               1163 ns/op

diff --git a/br/pkg/lightning/log/log.go b/br/pkg/lightning/log/log.go
@@ -91,7 +91,7 @@ func InitLogger(cfg *Config, tidbLoglevel string) error {
 	}
 	filterTiDBLog := zap.WrapCore(func(core zapcore.Core) zapcore.Core {
 		// Filter logs from TiDB and PD.
-		return NewFilterCore(core, "github.com/tikv/pd/")
+		return NewFilterCore(core, "github.com/pingcap/tidb/br/")
 	})
 	// "-" is a special config for log to stdout.
 	if len(cfg.File) > 0 && cfg.File != "-" {