[patch] add global log level configuration interface SetLevel (#98)

kpango · web-flow · commit aeb3994b0c68 · 2021-06-17T10:55:00.000+09:00
Signed-off-by: kpango &lt;kpango@vdaas.org&gt;
diff --git a/README.md b/README.md
@@ -100,6 +100,15 @@ func main() {
 	glg.Print("Print")
 	glg.Println("Println")
 	glg.Printf("%s : %s", "printf", "formatted")
+
+	// set global log level to ERR level
+	glg.Info("before setting level to ERR this message will show")
+	glg.Get().SetLevel(glg.ERR)
+	glg.Info("after setting level to ERR this message will not show")
+	glg.Error("this log is ERR level this will show")
+	glg.Get().SetLevel(glg.DEBG)
+	glg.Info("log level is now DEBG, this INFO level log will show")
+
 	glg.CustomLog(customTag, "custom logging")
 	glg.CustomLog(customErrTag, "custom error logging")
 
diff --git a/example/main.go b/example/main.go
@@ -120,13 +120,9 @@ func main() {
 		// SetLevelWriter(glg.WARN, customWriter).
 		// SetLevelWriter(glg.ERR, customWriter).
 		// EnableJSON().
-		AddLevelWriter(glg.INFO, infolog).                         // add info log file destination
-		AddLevelWriter(glg.ERR, errlog).                           // add error log file destination
-		AddLevelWriter(glg.WARN, rotate).                          // add error log file destination
-		AddStdLevel(customTag, glg.STD, false).                    // user custom log level
-		AddErrLevel(customErrTag, glg.STD, true).                  // user custom error log level
-		SetLevelColor(glg.TagStringToLevel(customTag), glg.Cyan).  // set color output to user custom level
-		SetLevelColor(glg.TagStringToLevel(customErrTag), glg.Red) // set color output to user custom level
+		AddLevelWriter(glg.INFO, infolog). // add info log file destination
+		AddLevelWriter(glg.ERR, errlog).   // add error log file destination
+		AddLevelWriter(glg.WARN, rotate)   // add error log file destination
 
 	glg.Info("info")
 	glg.Infof("%s : %s", "info", "formatted")
@@ -145,10 +141,24 @@ func main() {
 	glg.Print("Print")
 	glg.Println("Println")
 	glg.Printf("%s : %s", "printf", "formatted")
+
+	// set global log level to ERR level
+	glg.Info("before setting level to ERR this message will show")
+	glg.Get().SetLevel(glg.ERR)
+	glg.Info("after setting level to ERR this message will not show")
+	glg.Error("this log is ERR level this will show")
+	glg.Get().SetLevel(glg.DEBG)
+	glg.Info("log level is now DEBG, this INFO level log will show")
+
+	glg.Get().
+		AddStdLevel(customTag, glg.STD, false).                    // user custom log level
+		AddErrLevel(customErrTag, glg.STD, true).                  // user custom error log level
+		SetLevelColor(glg.TagStringToLevel(customTag), glg.Cyan).  // set color output to user custom level
+		SetLevelColor(glg.TagStringToLevel(customErrTag), glg.Red) // set color output to user custom level
 	glg.CustomLog(customTag, "custom logging")
 	glg.CustomLog(customErrTag, "custom error logging")
 
-	glg.Info("kpango's glg supports disable timestamp for logging")
+	// glg.Info("kpango's glg supports disable timestamp for logging")
 	glg.Get().DisableTimestamp()
 	glg.Info("timestamp disabled")
 	glg.Warn("timestamp disabled")
diff --git a/glg.go b/glg.go
@@ -73,19 +73,20 @@ type logger struct {
 	color            func(string) string
 	isColor          bool
 	mode             MODE
+	prevMode         MODE
 	writeMode        wMode
 	disableTimestamp bool
 }
 
 const (
-	// LOG is log level
-	LOG LEVEL = iota
+	// DEBG is debug log level
+	DEBG LEVEL = iota + 1
 	// PRINT is print log level
 	PRINT
+	// LOG is log level
+	LOG
 	// INFO is info log level
 	INFO
-	// DEBG is debug log level
-	DEBG
 	// OK is success notify log level
 	OK
 	// WARN is warning log level
@@ -98,7 +99,7 @@ const (
 	FATAL
 
 	// NONE is disable Logging
-	NONE MODE = iota
+	NONE MODE = iota + 1
 	// STD is std log mode
 	STD
 	// BOTH is both log mode
@@ -107,7 +108,7 @@ const (
 	WRITER
 
 	// Internal writeMode
-	writeColorStd wMode = iota
+	writeColorStd wMode = iota + 1
 	writeStd
 	writeWriter
 	writeColorBoth
@@ -149,14 +150,14 @@ func init() {
 
 func (l LEVEL) String() string {
 	switch l {
-	case LOG:
-		return "LOG"
+	case DEBG:
+		return "DEBG"
 	case PRINT:
 		return "PRINT"
+	case LOG:
+		return "LOG"
 	case INFO:
 		return "INFO"
-	case DEBG:
-		return "DEBG"
 	case OK:
 		return "OK"
 	case WARN:
@@ -208,6 +209,12 @@ func New() *Glg {
 
 	for lev, log := range map[LEVEL]*logger{
 		// standard out
+		DEBG: {
+			std:     os.Stdout,
+			color:   Purple,
+			isColor: true,
+			mode:    STD,
+		},
 		PRINT: {
 			std:     os.Stdout,
 			color:   Colorless,
@@ -226,12 +233,6 @@ func New() *Glg {
 			isColor: true,
 			mode:    STD,
 		},
-		DEBG: {
-			std:     os.Stdout,
-			color:   Purple,
-			isColor: true,
-			mode:    STD,
-		},
 		OK: {
 			std:     os.Stdout,
 			color:   Cyan,
@@ -266,6 +267,7 @@ func New() *Glg {
 	} {
 		log.tag = lev.String()
 		log.rawtag = []byte(lsep + log.tag + sep)
+		log.prevMode = log.mode
 		log.updateMode()
 		g.logger.Store(lev, log)
 	}
@@ -299,10 +301,27 @@ func (g *Glg) EnablePoolBuffer(size int) *Glg {
 	return g
 }
 
+// SetLevel sets glg global log level
+func (g *Glg) SetLevel(lv LEVEL) *Glg {
+	g.logger.Range(func(lev LEVEL, l *logger) bool {
+		if lev < lv {
+			l.prevMode = l.mode
+			l.mode = NONE
+		} else {
+			l.mode = l.prevMode
+		}
+		l.updateMode()
+		g.logger.Store(lev, l)
+		return true
+	})
+	return g
+}
+
 // SetMode sets glg logging mode
 func (g *Glg) SetMode(mode MODE) *Glg {
 	g.logger.Range(func(lev LEVEL, l *logger) bool {
 		l.mode = mode
+		l.prevMode = mode
 		l.updateMode()
 		g.logger.Store(lev, l)
 		return true
@@ -316,6 +335,7 @@ func (g *Glg) SetLevelMode(level LEVEL, mode MODE) *Glg {
 	l, ok := g.logger.Load(level)
 	if ok {
 		l.mode = mode
+		l.prevMode = mode
 		l.updateMode()
 		g.logger.Store(level, l)
 	}
@@ -443,37 +463,27 @@ func (g *Glg) AddLevelWriter(level LEVEL, writer io.Writer) *Glg {
 
 // AddStdLevel adds std log level and returns LEVEL
 func (g *Glg) AddStdLevel(tag string, mode MODE, isColor bool) *Glg {
-	lev := LEVEL(atomic.AddUint32(g.levelCounter, 1))
-	tag = strings.ToUpper(tag)
-	g.levelMap.Store(tag, lev)
-	l := &logger{
-		writer:  nil,
-		std:     os.Stdout,
-		color:   Colorless,
-		isColor: isColor,
-		mode:    mode,
-		tag:     tag,
-		rawtag:  []byte(lsep + tag + sep),
-	}
-	l.updateMode()
-	g.logger.Store(lev, l)
-	return g
+	return g.addLevel(tag, mode, isColor, os.Stdout)
 }
 
 // AddErrLevel adds error log level and returns LEVEL
 func (g *Glg) AddErrLevel(tag string, mode MODE, isColor bool) *Glg {
-	atomic.AddUint32(g.levelCounter, 1)
-	lev := LEVEL(atomic.LoadUint32(g.levelCounter))
+	return g.addLevel(tag, mode, isColor, os.Stderr)
+}
+
+func (g *Glg) addLevel(tag string, mode MODE, isColor bool, std io.Writer) *Glg {
+	lev := LEVEL(atomic.AddUint32(g.levelCounter, 1))
 	tag = strings.ToUpper(tag)
 	g.levelMap.Store(tag, lev)
 	l := &logger{
-		writer:  nil,
-		std:     os.Stderr,
-		color:   Red,
-		isColor: isColor,
-		mode:    mode,
-		tag:     tag,
-		rawtag:  []byte(lsep + tag + sep),
+		writer:   nil,
+		std:      std,
+		color:    Colorless,
+		isColor:  isColor,
+		mode:     mode,
+		prevMode: mode,
+		tag:      tag,
+		rawtag:   []byte(lsep + tag + sep),
 	}
 	l.updateMode()
 	g.logger.Store(lev, l)
diff --git a/glg_test.go b/glg_test.go
@@ -178,6 +178,102 @@ func TestGlg_SetMode(t *testing.T) {
 	}
 }
 
+func TestGlg_SetLevel(t *testing.T) {
+	tests := []struct {
+		name   string
+		level  LEVEL
+		lv     LEVEL
+		expect MODE
+	}{
+		{
+			name:   "debug mode enables all",
+			level:  DEBG,
+			lv:     LOG,
+			expect: STD,
+		},
+		{
+			name:   "WARN mode disables ok",
+			level:  WARN,
+			lv:     OK,
+			expect: NONE,
+		},
+		{
+			name:   "WARN mode disables info",
+			level:  WARN,
+			lv:     INFO,
+			expect: NONE,
+		},
+		{
+			name:   "WARN mode disables log",
+			level:  WARN,
+			lv:     LOG,
+			expect: NONE,
+		},
+		{
+			name:   "WARN mode disables print",
+			level:  WARN,
+			lv:     PRINT,
+			expect: NONE,
+		},
+		{
+			name:   "WARN mode disables debug",
+			level:  WARN,
+			lv:     DEBG,
+			expect: NONE,
+		},
+		{
+			name:   "FATAL mode disables fail",
+			level:  FATAL,
+			lv:     FAIL,
+			expect: NONE,
+		},
+		{
+			name:   "FATAL mode disables err",
+			level:  FATAL,
+			lv:     ERR,
+			expect: NONE,
+		},
+		{
+			name:   "FATAL mode disables ok",
+			level:  FATAL,
+			lv:     OK,
+			expect: NONE,
+		},
+		{
+			name:   "FATAL mode disables info",
+			level:  FATAL,
+			lv:     INFO,
+			expect: NONE,
+		},
+		{
+			name:   "FATAL mode disables log",
+			level:  FATAL,
+			lv:     LOG,
+			expect: NONE,
+		},
+		{
+			name:   "FATAL mode disables print",
+			level:  FATAL,
+			lv:     PRINT,
+			expect: NONE,
+		},
+		{
+			name:   "FATAL mode disables debug",
+			level:  FATAL,
+			lv:     DEBG,
+			expect: NONE,
+		},
+	}
+	g := New()
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := g.SetLevel(tt.level).GetCurrentMode(tt.lv); got != tt.expect {
+				t.Errorf("Glg.SetLevel() = %v, want %v", got, tt.expect)
+			}
+		})
+	}
+}
+
 func TestGlg_SetLevelMode(t *testing.T) {
 	tests := []struct {
 		name  string
diff --git a/go.mod b/go.mod
@@ -3,7 +3,7 @@ module github.com/kpango/glg
 go 1.16
 
 require (
-	github.com/goccy/go-json v0.6.1
+	github.com/goccy/go-json v0.7.0
 	github.com/kpango/fastime v1.0.16
 	go.uber.org/zap v1.17.0
 )
diff --git a/go.sum b/go.sum
@@ -1,12 +1,8 @@
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
-github.com/goccy/go-json v0.5.1 h1:R9UYTOUvo7eIY9aeDMZ4L6OVtHaSr1k2No9W6MKjXrA=
-github.com/goccy/go-json v0.5.1/go.mod h1:6MelG93GURQebXPDq3khkgXZkazVtN9CRI+MGFi0w8I=
-github.com/goccy/go-json v0.6.0 h1:2IW/fnWqWQVWsoNEO708sGt7udTIjuBgCB/psq8L8Xo=
-github.com/goccy/go-json v0.6.0/go.mod h1:6MelG93GURQebXPDq3khkgXZkazVtN9CRI+MGFi0w8I=
-github.com/goccy/go-json v0.6.1 h1:O7xC9WR7B09imThbRIEMIWK4MVcxOsLzWtGe16cv5SU=
-github.com/goccy/go-json v0.6.1/go.mod h1:6MelG93GURQebXPDq3khkgXZkazVtN9CRI+MGFi0w8I=
+github.com/goccy/go-json v0.7.0 h1:ZsGt0RuL2c4EP8X33Ij8caSlBrcFx7eYKjlKG4HOWf8=
+github.com/goccy/go-json v0.7.0/go.mod h1:6MelG93GURQebXPDq3khkgXZkazVtN9CRI+MGFi0w8I=
 github.com/kpango/fastime v1.0.16 h1:1prFG/3pTjzcDeCTxt98VB4IvjxcySLs0ldCEhZg0R8=
 github.com/kpango/fastime v1.0.16/go.mod h1:lVqUTcXmQnk1wriyvq5DElbRSRDC0XtqbXQRdz0Eo+g=
 github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I=

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ module github.com/kpango/glg`
`3`	`3`	`go 1.16`
`4`	`4`
`5`	`5`	`require (`
`6`		`- github.com/goccy/go-json v0.6.1`
	`6`	`+ github.com/goccy/go-json v0.7.0`
`7`	`7`	`github.com/kpango/fastime v1.0.16`
`8`	`8`	`go.uber.org/zap v1.17.0`
`9`	`9`	`)`