Merge pull request #440 from TarsCloud/feature/lbbniu/rogger

 perf(rogger): log increase convenience method

Author: lbbniu

tars/util/rogger/dyeing.go

@@ -90,10 +90,10 @@ func (l *Logger) DyeingWritef(ctx context.Context, depth int, level LogLevel, ex
 			} else {
 				file = filepath.Base(file)
 			}
-			fmt.Fprintf(buf, "%s:%s:%d|", file, getFuncName(runtime.FuncForPC(pc).Name()), line)
+			fmt.Fprintf(buf, "%s:%s:%d|", file, FuncName(runtime.FuncForPC(pc)), line)
 		}
-		if colored && l.IsConsoleWriter() {
-			buf.WriteString(level.coloredString())
+		if IsColored() && l.IsConsoleWriter() {
+			buf.WriteString(level.ColoredString())
 		} else {
 			buf.WriteString(level.String())
 		}

tars/util/rogger/logger.go

@@ -54,12 +54,14 @@ type Logger struct {
 }
 
 type JsonLog struct {
-	Pre   string `json:"pre,omitempty"`
-	Time  string `json:"time"`
-	Func  string `json:"func"`
-	File  string `json:"file"`
-	Level string `json:"level"`
-	Msg   string `json:"msg"`
+	Pre     string `json:"pre,omitempty"`
+	Time    string `json:"time"`
+	TraceId string `json:"trace_id,omitempty"`
+	SpanId  string `json:"span_id,omitempty"`
+	Func    string `json:"func"`
+	File    string `json:"file"`
+	Level   string `json:"level"`
+	Msg     string `json:"msg"`
 }
 
 // LogLevel is uint8 type
@@ -95,8 +97,8 @@ func (lv *LogLevel) String() string {
 	}
 }
 
-// Colored enable colored level string when use console writer
-func (lv *LogLevel) coloredString() string {
+// ColoredString enable colored level string when use console writer
+func (lv *LogLevel) ColoredString() string {
 	switch *lv {
 	case DEBUG:
 		return "\x1b[34mDEBUG\x1b[0m" // blue
@@ -166,14 +168,19 @@ func GetLogFormat() LogFormat {
 
 // GetFormat get global log format and return string
 func GetFormat() string {
-	return logLevel.String()
+	return logFormat.String()
 }
 
 // Colored enable colored level string when use console writer
 func Colored() {
 	colored = true
 }
 
+// IsColored returns whether to enable colored when use console writer
+func IsColored() bool {
+	return colored
+}
+
 // StringToLevel turns string to LogLevel
 func StringToLevel(level string) LogLevel {
 	switch level {
@@ -200,16 +207,43 @@ func SetCallerFlag(flag bool) {
 	callerFlag = flag
 }
 
+// CallerFlag returns the caller's state string when writing to the log
+func CallerFlag() bool {
+	return callerFlag
+}
+
 // SetLogName sets the log name
+// Deprecated: recommended to use SetName, v1.4.0 will be removed
 func (l *Logger) SetLogName(name string) {
 	l.name = name
 }
 
+// SetName sets the log name
+func (l *Logger) SetName(name string) {
+	l.name = name
+}
+
+// Name return the log name
+func (l *Logger) Name() string {
+	return l.name
+}
+
 // SetLogPrefix sets the log line prefix
+// Deprecated: recommended to use SetPrefix, v1.4.0 will be removed
 func (l *Logger) SetLogPrefix(pre string) {
 	l.prefix = pre
 }
 
+// SetPrefix sets the log line prefix
+func (l *Logger) SetPrefix(prefix string) {
+	l.prefix = prefix
+}
+
+// Prefix returns the log line prefix
+func (l *Logger) Prefix() string {
+	return l.prefix
+}
+
 // SetFileRoller sets the file rolled by size in MB, with max num of files.
 func (l *Logger) SetFileRoller(logpath string, num int, sizeMB int) error {
 	if err := os.MkdirAll(logpath, 0755); err != nil {
@@ -230,6 +264,11 @@ func (l *Logger) SetWriter(w LogWriter) {
 	l.writer = w
 }
 
+// Writer return the log LogWriter.
+func (l *Logger) Writer() LogWriter {
+	return l.writer
+}
+
 // SetDayRoller sets the logger to rotate by day, with max num files.
 func (l *Logger) SetDayRoller(logpath string, num int) error {
 	if err := os.MkdirAll(logpath, 0755); err != nil {
@@ -314,21 +353,25 @@ func (l *Logger) Writef(depth int, level LogLevel, format string, v []interface{
 	}
 
 	if logFormat == Json {
-		logQueue <- l.WriteJsonF(depth, level, format, v)
+		logQueue <- l.writeJson(depth, level, format, v)
 	} else {
-		logQueue <- l.WriteLineF(depth, level, format, v)
+		logQueue <- l.writeLine(depth, level, format, v)
 	}
 }
 
+// Deprecated: will be removed in a future version, v1.4.0 will be removed
 func (l *Logger) WriteLineF(depth int, level LogLevel, format string, v []interface{}) *logValue {
+	return l.writeLine(depth, level, format, v)
+}
+
+func (l *Logger) writeLine(depth int, level LogLevel, format string, v []interface{}) *logValue {
 	buf := bytes.NewBuffer(nil)
 	if l.writer.NeedPrefix() {
+		fmt.Fprintf(buf, "%s|", time.Now().Format("2006-01-02 15:04:05.000"))
 		if len(l.prefix) > 0 {
 			fmt.Fprintf(buf, "%s|", l.prefix)
 		}
 
-		fmt.Fprintf(buf, "%s|", time.Now().Format("2006-01-02 15:04:05.000"))
-
 		if callerFlag {
 			pc, file, line, ok := runtime.Caller(depth + callerSkip)
 			if !ok {
@@ -337,10 +380,10 @@ func (l *Logger) WriteLineF(depth int, level LogLevel, format string, v []interf
 			} else {
 				file = filepath.Base(file)
 			}
-			fmt.Fprintf(buf, "%s:%s:%d|", file, getFuncName(runtime.FuncForPC(pc).Name()), line)
+			fmt.Fprintf(buf, "%s:%s:%d|", file, FuncName(runtime.FuncForPC(pc)), line)
 		}
-		if colored && l.IsConsoleWriter() {
-			buf.WriteString(level.coloredString())
+		if IsColored() && l.IsConsoleWriter() {
+			buf.WriteString(level.ColoredString())
 		} else {
 			buf.WriteString(level.String())
 		}
@@ -358,7 +401,12 @@ func (l *Logger) WriteLineF(depth int, level LogLevel, format string, v []interf
 	return &logValue{value: buf.Bytes(), writer: l.writer}
 }
 
+// Deprecated: will be removed in a future version, v1.4.0 will be removed
 func (l *Logger) WriteJsonF(depth int, level LogLevel, format string, v []interface{}) *logValue {
+	return l.writeJson(depth, level, format, v)
+}
+
+func (l *Logger) writeJson(depth int, level LogLevel, format string, v []interface{}) *logValue {
 	log := JsonLog{}
 	log.Pre = l.prefix
 	log.Time = time.Now().Format("2006-01-02 15:04:05.000")
@@ -371,7 +419,7 @@ func (l *Logger) WriteJsonF(depth int, level LogLevel, format string, v []interf
 		} else {
 			file = filepath.Base(file)
 		}
-		log.Func = getFuncName(runtime.FuncForPC(pc).Name())
+		log.Func = FuncName(runtime.FuncForPC(pc))
 		log.File = fmt.Sprintf("%s:%d", file, line)
 	}
 	log.Level = level.String()
@@ -388,7 +436,13 @@ func (l *Logger) WriteJsonF(depth int, level LogLevel, format string, v []interf
 	return &logValue{value: buf.Bytes(), writer: l.writer}
 }
 
-func getFuncName(name string) string {
+// WriteLog write log into log files ignore the log level and log prefix
+func (l *Logger) WriteLog(msg []byte) {
+	logQueue <- &logValue{value: msg, writer: l.writer}
+}
+
+func FuncName(f *runtime.Func) string {
+	name := f.Name()
 	idx := strings.LastIndexByte(name, '/')
 	if idx != -1 {
 		name = name[idx:]
@@ -400,11 +454,6 @@ func getFuncName(name string) string {
 	return name
 }
 
-// WriteLog write log into log files ignore the log level and log prefix
-func (l *Logger) WriteLog(msg []byte) {
-	logQueue <- &logValue{value: msg, writer: l.writer}
-}
-
 // FlushLogger flush all log to disk.
 func FlushLogger() {
 	syncCancel()

tars/util/rogger/logger_test.go

@@ -5,8 +5,8 @@ import (
 	"time"
 )
 
-// XTestLogger test logger writes.
-func XTestLogger(t *testing.T) {
+// TestLogger test logger writes.
+func TestLogger(t *testing.T) {
 	SetLevel(DEBUG)
 	lg := GetLogger("debug")
 	// lg.SetConsole()
@@ -28,7 +28,7 @@ func XTestLogger(t *testing.T) {
 }
 
 // XTestGetLogList test get log list
-func XTestGetLogList(t *testing.T) {
+func TestGetLogList(t *testing.T) {
 	w := NewDateWriter("./logs", "abc", HOUR, 0)
 	w.cleanOldLogs()
 }