Merging AddSkipPackageFromStackTrace API

entry.go

@@ -16,7 +16,7 @@ var (
 	bufferPool *sync.Pool
 
 	// qualified package name, cached at first use
-	logrusPackage string
+	skipPackageNameForCaller = make(map[string]struct{}, 1)
 
 	// Positions in the call stack when tracing to report the calling method
 	minimumCallerDepth int
@@ -170,7 +170,8 @@ func getCaller() *runtime.Frame {
 	callerInitOnce.Do(func() {
 		pcs := make([]uintptr, 2)
 		_ = runtime.Callers(0, pcs)
-		logrusPackage = getPackageName(runtime.FuncForPC(pcs[1]).Name())
+		//logrusPackage = getPackageName(runtime.FuncForPC(pcs[1]).Name())
+		AddSkipPackageFromStackTrace(getPackageName(runtime.FuncForPC(pcs[1]).Name()))
 
 		// now that we have the cache, we can skip a minimum count of known-logrus functions
 		// XXX this is dubious, the number of frames may vary
@@ -183,11 +184,11 @@ func getCaller() *runtime.Frame {
 	frames := runtime.CallersFrames(pcs[:depth])
 
 	for f, again := frames.Next(); again; f, again = frames.Next() {
-		pkg := getPackageName(f.Function)
+		//pkg := getPackageName(f.Function)
 
 		// If the caller isn't part of this package, we're done
-		if pkg != logrusPackage {
-			return &f //nolint:scopelint
+		if _, has := skipPackageNameForCaller[getPackageName(f.Function)]; !has {
+			return &f
 		}
 	}
 

exported.go

@@ -31,6 +31,13 @@ func SetReportCaller(include bool) {
 	std.SetReportCaller(include)
 }
 
+// AddSkipPackageFromStackTrace excludes package names from the caller report when
+// SetReportCaller set to true. Commonly used to skip a custom logrus wrapper package frames.
+// ex. log.AddSkipPackageFromStackTrace("mycoolapp/mylogger") // skip mycoolapp/mylogger wrapper.
+func AddSkipPackageFromStackTrace(name string) {
+	std.AddSkipPackageFromStackTrace(name)
+}
+
 // SetLevel sets the standard logger level.
 func SetLevel(level Level) {
 	std.SetLevel(level)

logger.go

@@ -335,12 +335,18 @@ func (logger *Logger) SetOutput(output io.Writer) {
 	logger.Out = output
 }
 
+// SetReportCaller logs the caller stack frame.
 func (logger *Logger) SetReportCaller(reportCaller bool) {
 	logger.mu.Lock()
 	defer logger.mu.Unlock()
 	logger.ReportCaller = reportCaller
 }
 
+// AddSkipPackageFromStackTrace excludes a package from the caller report.
+func (logger *Logger) AddSkipPackageFromStackTrace(name string) {
+	skipPackageNameForCaller[name] = struct{}{}
+}
+
 // ReplaceHooks replaces the logger hooks and returns the old ones
 func (logger *Logger) ReplaceHooks(hooks LevelHooks) LevelHooks {
 	logger.mu.Lock()