Update to 8.0.4 | New: transfer a message to the request logger

Former-commit-id: 2bab3c9f28f7e9edd5d85e579349f70388af871d

middleware/logger/config.go

@@ -10,36 +10,48 @@ import (
 // See `Configuration` too.
 type SkipperFunc func(ctx context.Context) bool
 
-// Config are the options of the logger middlweare
-// contains 4 bools
-// Status, IP, Method, Path
-// if set to true then these will print
+// Config contains the options for the logger middleware
+// can be optionally be passed to the `New`.
 type Config struct {
-	// Status displays status code (bool)
+	// Status displays status code (bool).
 	//
-	// Defaults to true
+	// Defaults to true.
 	Status bool
-	// IP displays request's remote address (bool)
+	// IP displays request's remote address (bool).
 	//
-	// Defaults to true
+	// Defaults to true.
 	IP bool
-	// Method displays the http method (bool)
+	// Method displays the http method (bool).
 	//
-	// Defaults to true
+	// Defaults to true.
 	Method bool
-	// Path displays the request path (bool)
+	// Path displays the request path (bool).
 	//
-	// Defaults to true
+	// Defaults to true.
 	Path bool
-	// Columns will display the logs as well formatted columns (bool)
+
+	// Columns will display the logs as well formatted columns (bool).
 	// If custom `LogFunc` has been provided then this field is useless and users should
 	// use the `Columinize` function of the logger to get the ouput result as columns.
 	//
-	// Defaults to true
+	// Defaults to true.
 	Columns bool
+
+	// MessageContextKey if not empty,
+	// the middleware will try to fetch
+	// the contents with `ctx.Values().Get(MessageContextKey)`
+	// and if available then these contents will be
+	// appended as part of the logs (with `%v`, in order to be able to set a struct too),
+	// if Columns field was setted to true then
+	// a new column will be added named 'Message'.
+	//
+	// Defaults to empty.
+	MessageContextKey string
+
 	// LogFunc is the writer which logs are written to,
 	// if missing the logger middleware uses the app.Logger().Infof instead.
-	LogFunc func(now time.Time, latency time.Duration, status, ip, method, path string)
+	// Note that message argument can be empty.
+	LogFunc func(now time.Time, latency time.Duration, status, ip, method, path string, message interface{})
 	// Skippers used to skip the logging i.e by `ctx.Path()` and serve
 	// the next/main handler immediately.
 	Skippers []SkipperFunc
@@ -48,12 +60,22 @@ type Config struct {
 	skip SkipperFunc
 }
 
-// DefaultConfiguration returns a default configuration
+// DefaultConfig returns a default config
 // that have all boolean fields to true,
-// LogFunc to nil,
-// and Skippers to nil.
-func DefaultConfiguration() Config {
-	return Config{true, true, true, true, true, nil, nil, nil}
+// all strings are empty,
+// LogFunc and Skippers to nil as well.
+func DefaultConfig() Config {
+	return Config{
+		Status:            true,
+		IP:                true,
+		Method:            true,
+		Path:              true,
+		Columns:           true,
+		MessageContextKey: "",
+		LogFunc:           nil,
+		Skippers:          nil,
+		skip:              nil,
+	}
 }
 
 // AddSkipper adds a skipper to the configuration.

middleware/logger/logger.go

@@ -21,7 +21,7 @@ type requestLoggerMiddleware struct {
 //
 // Receives an optional configuation.
 func New(cfg ...Config) context.Handler {
-	c := DefaultConfiguration()
+	c := DefaultConfig()
 	if len(cfg) > 0 {
 		c = cfg[0]
 	}
@@ -48,6 +48,7 @@ func (l *requestLoggerMiddleware) ServeHTTP(ctx context.Context) {
 	startTime = time.Now()
 
 	ctx.Next()
+
 	//no time.Since in order to format it well after
 	endTime = time.Now()
 	latency = endTime.Sub(startTime)
@@ -68,27 +69,44 @@ func (l *requestLoggerMiddleware) ServeHTTP(ctx context.Context) {
 		path = ctx.Path()
 	}
 
+	var message interface{}
+	if ctxKey := l.config.MessageContextKey; ctxKey != "" {
+		message = ctx.Values().Get(ctxKey)
+	}
+
 	// print the logs
 	if logFunc := l.config.LogFunc; logFunc != nil {
-		logFunc(endTime, latency, status, ip, method, path)
+		logFunc(endTime, latency, status, ip, method, path, message)
 		return
 	}
 	endTimeFormatted := endTime.Format("2006/01/02 - 15:04:05")
 	if l.config.Columns {
-		output := Columnize(endTimeFormatted, latency, status, ip, method, path)
+		output := Columnize(endTimeFormatted, latency, status, ip, method, path, message)
 		ctx.Application().Logger().Out.Write([]byte(output))
 		return
 	}
 	// no new line, the framework's logger is responsible how to render each log.
-	ctx.Application().Logger().Infof("%s | %v %4v %s %s %s", endTimeFormatted, status, latency, ip, method, path)
+	line := fmt.Sprintf("%s | %v %4v %s %s %s", endTimeFormatted, status, latency, ip, method, path)
+	if message != nil {
+		line += fmt.Sprintf(" %v", message)
+	}
+	ctx.Application().Logger().Info(line)
 }
 
 // Columnize formats the given arguments as columns and returns the formatted output,
 // note that it appends a new line to the end.
-func Columnize(nowFormatted string, latency time.Duration, status, ip, method, path string) string {
+func Columnize(nowFormatted string, latency time.Duration, status, ip, method, path string, message interface{}) string {
+
+	titles := "Time | Status | Latency | IP | Method | Path"
+	line := fmt.Sprintf("%s | %v | %4v | %s | %s | %s", nowFormatted, status, latency, ip, method, path)
+	if message != nil {
+		titles += " | Message"
+		line += fmt.Sprintf(" | %v", message)
+	}
+
 	outputC := []string{
-		"Time | Status | Latency | IP | Method | Path",
-		fmt.Sprintf("%s | %v | %4v | %s | %s | %s", nowFormatted, status, latency, ip, method, path),
+		titles,
+		line,
 	}
 	output := columnize.SimpleFormat(outputC) + "\n"
 	return output