feat: update log with stacktrace

vuduongtp · Mar 20, 2024 · 19c4999 · 19c4999
1 parent 53ae46f
commit 19c4999
Show file tree

Hide file tree

Showing 5 changed files with 148 additions and 112 deletions.
diff --git a/constant.go b/constant.go
@@ -0,0 +1,69 @@
+package logadapter
+
+// custom logtype
+const (
+	LogTypeAPI      = "api"
+	LogTypeRequest  = "request"
+	LogTypeResponse = "response"
+	LogTypeError    = "error"
+	LogTypeDebug    = "debug"
+	LogTypeInfo     = "info"
+	LogTypeWarn     = "warn"
+	LogTypeSQL      = "sql"
+	LogTypeTrace    = "trace"
+)
+
+// custom constants
+const (
+	DefaultTimestampFormat = "2006-01-02 15:04:05.00000"
+	DefaultPrefix          = "LogAdapter_"
+	DefaultSourceField     = "stack_trace"
+)
+
+// Export HeaderKey constanst
+const (
+	CorrelationIDHeaderKey HeaderKey = "X-User-Correlation-Id"
+	RequestIDHeaderKey     HeaderKey = "X-Request-ID"
+	UserInfoHeaderKey      HeaderKey = "X-Userinfo"
+)
+
+// Export LogKey constanst
+const (
+	CorrelationIDLogKey LogKey = "correlation_id"
+	RequestIDLogKey     LogKey = "request_id"
+	UserInfoLogKey      LogKey = "user_info"
+)
+
+// Export default LogKeyMap
+var (
+	DefaultLogKeys []LogKey = []LogKey{CorrelationIDLogKey, RequestIDLogKey, UserInfoLogKey}
+	baseSourceDir  string
+)
+
+// custom log format
+const (
+	JSONFormat LogFormat = iota
+	PrettyJSONFormat
+	TextFormat
+)
+
+const (
+	// PanicLevel level, highest level of severity. Logs and then calls panic with the
+	// message passed to Debug, Info, ...
+	PanicLevel Level = iota
+	// FatalLevel level. Logs and then calls `logger.Exit(1)`. It will exit even if the
+	// logging level is set to Panic.
+	FatalLevel
+	// ErrorLevel level. Logs. Used for errors that should definitely be noted.
+	// Commonly used for hooks to send errors to an error tracking service.
+	ErrorLevel
+	// WarnLevel level. Non-critical entries that deserve eyes.
+	WarnLevel
+	// InfoLevel level. General operational entries about what's going on inside the
+	// application.
+	InfoLevel
+	// DebugLevel level. Usually only enabled when debugging. Very verbose logging.
+	DebugLevel
+	// TraceLevel level. Designates finer-grained informational events than the Debug.
+	TraceLevel
+)
diff --git a/echo_adapter.go b/echo_adapter.go
@@ -364,7 +364,7 @@ func LogWithEchoContext(c echo.Context, content ...interface{}) {
 			}
 		}
 	case LogTypeError:
-		source := map[string]interface{}{DefaultSourceField: getCaller()}
+		source := map[string]interface{}{DefaultSourceField: l.getCaller()}
 		if logger, ok := c.Logger().(*EchoLogger); ok {
 			logger.WithFields(mergeLogFields(logFields, source)).Error(content[0])
 		} else {
@@ -385,7 +385,7 @@ func LogWithEchoContext(c echo.Context, content ...interface{}) {
 			}
 		}
 	case LogTypeWarn:
-		source := map[string]interface{}{DefaultSourceField: getCaller()}
+		source := map[string]interface{}{DefaultSourceField: l.getCaller()}
 		if logger, ok := c.Logger().(*EchoLogger); ok {
 			logger.WithFields(mergeLogFields(logFields, source)).Warn(content[0])
 		} else {

diff --git a/gorm_adapter.go b/gorm_adapter.go
@@ -74,7 +74,7 @@ func (l *GormLogger) Trace(ctx context.Context, begin time.Time, fc func() (stri
 	fields := mergeLogFields(trace, GetLogFieldFromContext(ctx))
 
 	if l.SourceField != "" {
-		fields[l.SourceField] = getCaller()
+		fields[l.SourceField] = l.getCaller()
 	}
 	if err != nil && !(errors.Is(err, gorm.ErrRecordNotFound) && l.SkipErrRecordNotFound) {
 		fields[logrus.ErrorKey] = err

diff --git a/main.go b/main.go
@@ -2,94 +2,28 @@ package logadapter
 
 import (
 	"context"
+	"fmt"
 	"io"
 	"os"
+	"runtime"
 	"strings"
 
 	log "github.com/sirupsen/logrus"
 	"gopkg.in/natefinch/lumberjack.v2"
 )
 
-// custom logtype
-const (
-	LogTypeAPI      = "api"
-	LogTypeRequest  = "request"
-	LogTypeResponse = "response"
-	LogTypeError    = "error"
-	LogTypeDebug    = "debug"
-	LogTypeInfo     = "info"
-	LogTypeWarn     = "warn"
-	LogTypeSQL      = "sql"
-	LogTypeTrace    = "trace"
-)
-
-// custom constants
-const (
-	DefaultTimestampFormat = "2006-01-02 15:04:05.00000"
-	DefaultPrefix          = "LogAdapter_"
-	DefaultSourceField     = "stack_trace"
-)
-
 // HeaderKey is key from http Header
 type HeaderKey string
 
-// Export HeaderKey constanst
-const (
-	CorrelationIDHeaderKey HeaderKey = "X-User-Correlation-Id"
-	RequestIDHeaderKey     HeaderKey = "X-Request-ID"
-	UserInfoHeaderKey      HeaderKey = "X-Userinfo"
-)
-
 // LogKey is key for log messages
 type LogKey string
 
-// Export LogKey constanst
-const (
-	CorrelationIDLogKey LogKey = "correlation_id"
-	RequestIDLogKey     LogKey = "request_id"
-	UserInfoLogKey      LogKey = "user_info"
-)
-
-// Export default LogKeyMap
-var (
-	DefaultLogKeys []LogKey = []LogKey{CorrelationIDLogKey, RequestIDLogKey, UserInfoLogKey}
-	baseSourceDir  string
-)
-
 // LogFormat log format
 type LogFormat uint32
 
-// custom log format
-const (
-	JSONFormat LogFormat = iota
-	PrettyJSONFormat
-	TextFormat
-)
-
 // Level log level
 type Level uint32
 
-const (
-	// PanicLevel level, highest level of severity. Logs and then calls panic with the
-	// message passed to Debug, Info, ...
-	PanicLevel Level = iota
-	// FatalLevel level. Logs and then calls `logger.Exit(1)`. It will exit even if the
-	// logging level is set to Panic.
-	FatalLevel
-	// ErrorLevel level. Logs. Used for errors that should definitely be noted.
-	// Commonly used for hooks to send errors to an error tracking service.
-	ErrorLevel
-	// WarnLevel level. Non-critical entries that deserve eyes.
-	WarnLevel
-	// InfoLevel level. General operational entries about what's going on inside the
-	// application.
-	InfoLevel
-	// DebugLevel level. Usually only enabled when debugging. Very verbose logging.
-	DebugLevel
-	// TraceLevel level. Designates finer-grained informational events than the Debug.
-	TraceLevel
-)
-
 // Config config instance log
 type Config struct {
 	IsUseLogFile    bool        // set true if write to file
@@ -115,6 +49,7 @@ type Logger struct {
 	logFormat       LogFormat
 	timestampFormat string
 	logKeys         []LogKey
+	ignoredPaths    []string
 }
 
 var l *Logger
@@ -136,6 +71,18 @@ func (cl customFormat) Format(entry *log.Entry) ([]byte, error) {
 	return cl.formatter.Format(entry)
 }
 
+// SetIgnoredPaths for ignored path in stack trace field.
+// By default logadapter print stacktrace with log has lever higher than WARN, always print stack trace with gorm_adapter
+// Not to print file path has "runtime/" in stack trace. We use logadapter.UpdateIgnoredPaths([]string{"runtime/"})
+func SetIgnoredPaths(paths []string) { l.SetIgnoredPaths(paths) }
+
+// SetIgnoredPaths for ignored path in stack trace field.
+// By default logadapter print stacktrace with log has lever higher than WARN, always print stack trace with gorm_adapter
+// Not to print file path has "runtime/" in stack trace. We use logadapter.UpdateIgnoredPaths([]string{"runtime/"})
+func (l *Logger) SetIgnoredPaths(paths []string) {
+	l.ignoredPaths = paths
+}
+
 // SetFormatter set logger formatter
 func SetFormatter(logFormat LogFormat) { l.SetFormatter(logFormat) }
 
@@ -185,10 +132,12 @@ func SetDefaultFields(fields map[string]interface{}) { l.SetDefaultFields(fields
 
 // SetDefaultFields set default fields for all log
 func (l *Logger) SetDefaultFields(fields map[string]interface{}) {
-	l.Logger.SetFormatter(customFormat{
-		defaultFields: fields,
-		formatter:     l.Formatter,
-	})
+	if len(fields) > 0 {
+		l.Logger.SetFormatter(customFormat{
+			defaultFields: fields,
+			formatter:     l.Formatter,
+		})
+	}
 }
 
 // SetLogFile set log file, log file will be storaged in logs folder
@@ -318,6 +267,47 @@ func SetCustomLogField(ctx context.Context, logKey string, value interface{}) co
 	return l.SetCustomLogField(ctx, logKey, value)
 }
 
+func (l *Logger) getCaller() string {
+	var caller string
+	pc := make([]uintptr, 10)
+	n := runtime.Callers(2, pc)
+	if n == 0 {
+		return caller
+	}
+	pc = pc[:n]
+	frames := runtime.CallersFrames(pc)
+	for {
+		frame, more := frames.Next()
+
+		if strings.Contains(frame.File, baseSourceDir) {
+			continue
+		}
+		var isIgnore bool
+		for _, path := range l.ignoredPaths {
+			if strings.Contains(frame.File, path) {
+				isIgnore = true
+				continue
+			}
+		}
+		if isIgnore {
+			continue
+		}
+
+		if len(frame.Function) > 0 && len(frame.File) > 0 {
+			if len(caller) > 0 {
+				caller += "\n"
+			}
+			caller += fmt.Sprintf("%s\n\t%s:%d", getFunctionName(frame.Function), frame.File, frame.Line)
+		}
+
+		if !more {
+			break
+		}
+	}
+
+	return caller
+}
+
 // NewWithConfig returns a logger instance with custom configuration
 func NewWithConfig(config *Config) *Logger {
 	if config == nil {
@@ -379,25 +369,25 @@ func Info(args ...interface{}) {
 
 // Warn log with warn level
 func Warn(args ...interface{}) {
-	field := log.Fields{DefaultSourceField: getCaller()}
+	field := log.Fields{DefaultSourceField: l.getCaller()}
 	l.WithFields(field).Warn(args...)
 }
 
 // Error log with error level
 func Error(args ...interface{}) {
-	field := log.Fields{DefaultSourceField: getCaller()}
+	field := log.Fields{DefaultSourceField: l.getCaller()}
 	l.WithFields(field).Error(args...)
 }
 
 // Fatal log with fatal level
 func Fatal(args ...interface{}) {
-	field := log.Fields{DefaultSourceField: getCaller()}
+	field := log.Fields{DefaultSourceField: l.getCaller()}
 	l.WithFields(field).Fatal(args...)
 }
 
 // Panic log with panic level
 func Panic(args ...interface{}) {
-	field := log.Fields{DefaultSourceField: getCaller()}
+	field := log.Fields{DefaultSourceField: l.getCaller()}
 	l.WithFields(field).Panic(args...)
 }
 
@@ -418,25 +408,25 @@ func InfoWithContext(ctx context.Context, args ...interface{}) {
 
 // WarnWithContext log with warn level
 func WarnWithContext(ctx context.Context, args ...interface{}) {
-	field := log.Fields{DefaultSourceField: getCaller()}
+	field := log.Fields{DefaultSourceField: l.getCaller()}
 	l.SetContext(ctx).WithFields(field).Warn(args...)
 }
 
 // ErrorWithContext log with error level
 func ErrorWithContext(ctx context.Context, args ...interface{}) {
-	field := log.Fields{DefaultSourceField: getCaller()}
+	field := log.Fields{DefaultSourceField: l.getCaller()}
 	l.SetContext(ctx).WithFields(field).Error(args...)
 }
 
 // FatalWithContext log with fatal level
 func FatalWithContext(ctx context.Context, args ...interface{}) {
-	field := log.Fields{DefaultSourceField: getCaller()}
+	field := log.Fields{DefaultSourceField: l.getCaller()}
 	l.SetContext(ctx).WithFields(field).Fatal(args...)
 }
 
 // PanicWithContext log with panic level
 func PanicWithContext(ctx context.Context, args ...interface{}) {
-	field := log.Fields{DefaultSourceField: getCaller()}
+	field := log.Fields{DefaultSourceField: l.getCaller()}
 	l.SetContext(ctx).WithFields(field).Panic(args...)
 }
 
@@ -466,12 +456,12 @@ func LogWithContext(ctx context.Context, content ...interface{}) {
 	case LogTypeAPI:
 		l.Logger.WithFields(logFields).Info(content[0])
 	case LogTypeError:
-		field := log.Fields{DefaultSourceField: getCaller()}
+		field := log.Fields{DefaultSourceField: l.getCaller()}
 		l.Logger.WithFields(mergeLogFields(logFields, field)).Error(content[0])
 	case LogTypeInfo:
 		l.Logger.WithFields(logFields).Info(content[0])
 	case LogTypeWarn:
-		field := log.Fields{DefaultSourceField: getCaller()}
+		field := log.Fields{DefaultSourceField: l.getCaller()}
 		l.Logger.WithFields(mergeLogFields(logFields, field)).Warn(content[0])
 	case LogTypeRequest, LogTypeResponse:
 		l.Logger.WithFields(logFields).Info(content[0])