Merge pull request #800 from n2h9/chore-logger-add-option-to-output-caller-info

[logger] chore: add option to output caller info

Author: n2h9

logger/caller_hook.go

@@ -0,0 +1,71 @@
+package logger
+
+import (
+	"fmt"
+	"path/filepath"
+	"runtime"
+	"strings"
+	"sync"
+
+	"github.com/sirupsen/logrus"
+)
+
+// CallerHook adds real caller information to log entries
+type CallerHook struct {
+	skippedPaths []string
+}
+
+// defaultCallerSkippedPaths contains the default path patterns to skip when finding the real caller
+var (
+	defaultCallerSkippedPaths = []string{
+		"meshkit/logger",
+		"sirupsen/logrus",
+	}
+	defaultCallerSkippedPathsMu sync.RWMutex
+)
+
+// SetDefaultCallerSkippedPaths sets the default skipped paths on a package level
+func SetDefaultCallerSkippedPaths(paths []string) {
+	defaultCallerSkippedPathsMu.Lock()
+	defer defaultCallerSkippedPathsMu.Unlock()
+	defaultCallerSkippedPaths = paths
+}
+
+// Levels returns the levels this hook should be applied to
+func (hook *CallerHook) Levels() []logrus.Level {
+	return logrus.AllLevels
+}
+
+// shouldSkipFrame checks if a file path should be skipped
+func (hook *CallerHook) shouldSkipFrame(file string) bool {
+	for _, path := range hook.skippedPaths {
+		if strings.Contains(file, path) {
+			return true
+		}
+	}
+	return false
+}
+
+// Fire adds caller information to the log entry
+func (hook *CallerHook) Fire(entry *logrus.Entry) error {
+	// Skip frames to get to the real caller (outside skipped packages)
+	for i := range 16 {
+		pc, file, line, ok := runtime.Caller(i)
+		if !ok {
+			break
+		}
+
+		if !hook.shouldSkipFrame(file) {
+			fn := runtime.FuncForPC(pc)
+			funcName := "unknown"
+			if fn != nil {
+				funcName = fn.Name()
+			}
+
+			filename := filepath.Base(file)
+			entry.Data["caller"] = fmt.Sprintf("%s %s:%d", funcName, filename, line)
+			break
+		}
+	}
+	return nil
+}