Add caller to log messages; start changelog

Author: iand

CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+These are changes that will probably be included in the next release.
+
+### Added
+ * New AddCaller and CallerSkip options to add caller information to log messages
+
+### Fixed
+
+### Changed
+ 
+### Removed
+
+## [v0.1.0] - 2020-07-31
+
+Initial release

examples/example.go

@@ -23,6 +23,7 @@ func main() {
 	opts := logfmtr.DefaultOptions()
 	opts.Humanize = true
 	opts.Colorize = true
+	opts.CallerSkip = 0
 	demo(logfmtr.NewWithOptions(opts))
 }
 
@@ -33,5 +34,4 @@ func demo(base logr.Logger) {
 	log.V(1).V(1).Info("you should NOT see this")
 	log.Error(nil, "uh oh", "trouble", true, "reasons", []float64{0.1, 0.11, 3.14})
 	log.Error(fmt.Errorf("an error occurred"), "goodbye", "code", -1)
-
 }

logfmtr.go

@@ -5,6 +5,8 @@ import (
 	"fmt"
 	"io"
 	"os"
+	"path"
+	"runtime"
 	"strconv"
 	"strings"
 	"sync/atomic"
@@ -35,11 +37,13 @@ func NewWithOptions(opts Options) *Logger {
 		panic("logger was supplied with nil writer")
 	}
 	l := &Logger{
-		w:         opts.Writer,
-		humanize:  opts.Humanize,
-		tsFormat:  opts.TimestampFormat,
-		nameDelim: opts.NameDelim,
-		colorize:  opts.Colorize && opts.Humanize,
+		w:          opts.Writer,
+		humanize:   opts.Humanize,
+		tsFormat:   opts.TimestampFormat,
+		nameDelim:  opts.NameDelim,
+		colorize:   opts.Colorize && opts.Humanize,
+		addCaller:  opts.AddCaller,
+		callerSkip: opts.CallerSkip,
 	}
 	return l
 }
@@ -71,21 +75,30 @@ type Options struct {
 
 	// NameDelim is the delimiter character used when appending names of loggers.
 	NameDelim string
+
+	// AddCaller indicates that log messages should include the file and line number of the caller of the logger.
+	AddCaller bool
+
+	// CallerSkip adds frames to skip when determing the caller of the logger. Useful when the logger is wrapped
+	// by another logger.
+	CallerSkip int
 }
 
 var _ logr.Logger = (*Logger)(nil)
 
 // Logger is a logger that writes messages in the logfmt style.
 // See https://www.brandur.org/logfmt for more information.
 type Logger struct {
-	w         io.Writer
-	level     int
-	name      string
-	values    string
-	humanize  bool
-	tsFormat  string
-	nameDelim string
-	colorize  bool
+	w          io.Writer
+	level      int
+	name       string
+	values     string
+	humanize   bool
+	tsFormat   string
+	nameDelim  string
+	colorize   bool
+	addCaller  bool
+	callerSkip int
 }
 
 // Enabled repoorts whether this Logger is enabled with respect to the current global log level.
@@ -125,6 +138,12 @@ func (l *Logger) write(humanprefix, msg string, values string, extras ...interfa
 			b.WriteString("=")
 			b.WriteString(l.name)
 		}
+		if l.addCaller {
+			b.WriteRune(' ')
+			b.WriteString(l.key("caller"))
+			b.WriteString("=")
+			b.WriteString(l.caller(2))
+		}
 	} else {
 		b.WriteString("level=")
 		b.WriteString(strconv.Itoa(l.level))
@@ -141,11 +160,17 @@ func (l *Logger) write(humanprefix, msg string, values string, extras ...interfa
 			b.WriteString("ts=")
 			b.WriteString(quote(time.Now().UTC().Format(l.tsFormat)))
 		}
+		if l.addCaller {
+			b.WriteRune(' ')
+			b.WriteString("caller=")
+			b.WriteString(l.caller(2))
+		}
 	}
 	if len(extras) > 0 {
 		b.WriteRune(' ')
 		b.WriteString(l.flatten(extras...))
 	}
+
 	if l.values != "" {
 		b.WriteRune(' ')
 		b.WriteString(l.values)
@@ -158,6 +183,16 @@ func (l *Logger) write(humanprefix, msg string, values string, extras ...interfa
 	l.w.Write(b.Bytes())
 }
 
+func (l *Logger) caller(skip int) string {
+	for i := 1; i < 3; i++ {
+		_, file, line, ok := runtime.Caller(skip + l.callerSkip + i)
+		if ok && file != "<autogenerated>" {
+			return path.Base(file) + ":" + strconv.Itoa(line)
+		}
+	}
+	return "unknown"
+}
+
 // V returns a logger for a specific verbosity level, relative to this Logger.
 func (l *Logger) V(level int) logr.Logger {
 	l2 := *l
@@ -245,7 +280,7 @@ func stringify(v interface{}) string {
 }
 
 func quote(s string) string {
-	if strings.ContainsAny(s, " .") {
+	if strings.ContainsAny(s, " ") {
 		return fmt.Sprintf("%q", s)
 	}
 	return s