Changed to pass handlers struct to FormatFunc + added Getters for easier handler format overriding.

Author: joeybloggs

.gitignore

@@ -22,3 +22,5 @@ _testmain.go
 *.exe
 *.test
 *.prof
+old.txt
+new.txt

README.md

@@ -1,6 +1,6 @@
 ## log
 <img align="right" src="https://raw.githubusercontent.com/go-playground/log/master/logo.png">
-![Project status](https://img.shields.io/badge/version-2.3-green.svg)
+![Project status](https://img.shields.io/badge/version-3.0.0-green.svg)
 [![Build Status](https://semaphoreci.com/api/v1/joeybloggs/log/branches/master/badge.svg)](https://semaphoreci.com/joeybloggs/log)
 [![Coverage Status](https://coveralls.io/repos/github/go-playground/log/badge.svg?branch=master)](https://coveralls.io/github/go-playground/log?branch=master)
 [![Go Report Card](https://goreportcard.com/badge/github.com/go-playground/log)](https://goreportcard.com/report/github.com/go-playground/log)
@@ -18,7 +18,7 @@ Features
 - [x] Logger is simple, only logic to create the log entry and send it off to the handlers and they take it from there.
 - [x] Sends the log entry to the handlers asynchronously, but waits for all to complete; meaning all your handlers can be dealing with the log entry at the same time, but log will wait until all have completed before moving on.
 - [x] Ability to specify which log levels get sent to each handler
-- [x] Built-in console + syslog
+- [x] Built-in console, syslog, http and email handlers
 - [x] Handlers are simple to write + easy to register
 - [x] Logger is a singleton ( one of the few instances a singleton is desired ) so the root package registers which handlers are used and any libraries just follow suit.
 
@@ -203,12 +203,12 @@ make one log library better than another!
 go test -cpu=4 -bench=. -benchmem=true
 
 PASS
-BenchmarkLogConsoleTenFieldsParallel-4	 1000000	      1930 ns/op	    1113 B/op	      35 allocs/op
-BenchmarkLogConsoleSimpleParallel-4   	 3000000	       450 ns/op	      88 B/op	       4 allocs/op
-BenchmarkLogrusText10Fields-4         	  300000	      3943 ns/op	    4291 B/op	      63 allocs/op
-BenchmarkLogrusTextSimple-4           	 2000000	       633 ns/op	     672 B/op	      15 allocs/op
-BenchmarkLog1510Fields-4              	  100000	     16375 ns/op	    4378 B/op	      92 allocs/op
-BenchmarkLog15Simple-4                	 1000000	      1982 ns/op	     320 B/op	       9 allocs/op
+BenchmarkLogConsoleTenFieldsParallel-4	 1000000	      1985 ns/op	    1113 B/op	      35 allocs/op
+BenchmarkLogConsoleSimpleParallel-4   	 3000000	       455 ns/op	      88 B/op	       4 allocs/op
+BenchmarkLogrusText10Fields-4         	  300000	      4179 ns/op	    4291 B/op	      63 allocs/op
+BenchmarkLogrusTextSimple-4           	 2000000	       655 ns/op	     672 B/op	      15 allocs/op
+BenchmarkLog1510Fields-4              	  100000	     16376 ns/op	    4378 B/op	      92 allocs/op
+BenchmarkLog15Simple-4                	 1000000	      1983 ns/op	     320 B/op	       9 allocs/op
 ok  	github.com/go-playground/log/benchmarks	10.716s
 ```
 

benchmarks/benchmark_test.go

@@ -28,26 +28,6 @@ var _jane = user{
 	CreatedAt: time.Date(1980, 1, 1, 12, 0, 0, 0, time.UTC),
 }
 
-const (
-	newLine               = byte('\n')
-	defaultTS             = "2006-01-02T15:04:05.000000000Z07:00"
-	colorFields           = "%s %s%6s%s %-25s"
-	colorNoFields         = "%s %s%6s%s %s"
-	colorKeyValue         = " %s%s%s=%v"
-	colorFieldsCaller     = "%s %s%6s%s %s:%d %-25s"
-	colorNoFieldsCaller   = "%s %s%6s%s %s:%d %s"
-	noColorFields         = "%s %6s %-25s"
-	noColorNoFields       = "%s %6s %s"
-	noColorKeyValue       = " %s=%v"
-	noColorFieldsCaller   = "%s %6s %s:%d %-25s"
-	noColorNoFieldsCaller = "%s %6s %s:%d %s"
-	equals                = byte('=')
-	v                     = "%v"
-	base10                = 10
-	space                 = byte(' ')
-	colon                 = byte(':')
-)
-
 // NOTE: log is a singleton, which means handlers need to be
 // setup only once otherwise each test just adds another log
 // handler and results are cumulative... makes benchmarking
@@ -56,7 +36,7 @@ const (
 func TestMain(m *testing.M) {
 
 	cLog := console.New()
-	cLog.DisplayColor(false)
+	cLog.SetDisplayColor(false)
 	cLog.SetWriter(ioutil.Discard)
 	cLog.SetBuffersAndWorkers(3, 3)
 

handlers/console/console.go

@@ -14,7 +14,7 @@ import (
 // FormatFunc is the function that the workers use to create
 // a new Formatter per worker allowing reusable go routine safe
 // variable to be used within your Formatter function.
-type FormatFunc func() Formatter
+type FormatFunc func(c *Console) Formatter
 
 // Formatter is the function used to format the Redis entry
 type Formatter func(e *log.Entry) []byte
@@ -58,44 +58,66 @@ var defaultColors = [...]log.ANSIEscSeq{
 
 // New returns a new instance of the console logger
 func New() *Console {
-	c := &Console{
+	return &Console{
 		buffer:          0,
 		numWorkers:      1,
 		colors:          defaultColors,
 		writer:          os.Stderr,
 		timestampFormat: log.DefaultTimeFormat,
 		displayColor:    true,
 		fileDisplay:     log.Lshortfile,
+		formatFunc:      defaultFormatFunc,
 	}
-
-	c.formatFunc = c.defaultFormatFunc
-
-	return c
 }
 
 // SetFilenameDisplay tells Console the filename, when present, how to display
 func (c *Console) SetFilenameDisplay(fd log.FilenameDisplay) {
 	c.fileDisplay = fd
 }
 
+// FilenameDisplay returns Console's current filename display setting
+func (c *Console) FilenameDisplay() log.FilenameDisplay {
+	return c.fileDisplay
+}
+
 // RedirectSTDLogOutput tells Console to redirect the std Logger output
 // to the log package itself.
 func (c *Console) RedirectSTDLogOutput(b bool) {
 	c.redirStdOutput = b
 }
 
-// DisplayColor tells Console to output in color or not
+// SetDisplayColor tells Console to output in color or not
 // Default is : true
-func (c *Console) DisplayColor(color bool) {
+func (c *Console) SetDisplayColor(color bool) {
 	c.displayColor = color
 }
 
+// DisplayColor returns if logging color or not
+func (c *Console) DisplayColor() bool {
+	return c.displayColor
+}
+
+// GetDisplayColor returns the color for the given log level
+func (c *Console) GetDisplayColor(level log.Level) log.ANSIEscSeq {
+	return c.colors[level]
+}
+
 // SetTimestampFormat sets Console's timestamp output format
 // Default is : "2006-01-02T15:04:05.000000000Z07:00"
 func (c *Console) SetTimestampFormat(format string) {
 	c.timestampFormat = format
 }
 
+// TimestampFormat returns Console's current timestamp output format
+func (c *Console) TimestampFormat() string {
+	return c.timestampFormat
+}
+
+// GOPATH returns the GOPATH calculated by Console
+func (c *Console) GOPATH() string {
+	return c.gopath
+}
+
 // SetWriter sets Console's wriiter
 // Default is : os.Stderr
 func (c *Console) SetWriter(w io.Writer) {
@@ -182,7 +204,7 @@ func (c *Console) handleLog(entries <-chan *log.Entry) {
 	var e *log.Entry
 	// var b io.WriterTo
 	var b []byte
-	formatter := c.formatFunc()
+	formatter := c.formatFunc(c)
 
 	for e = range entries {
 
@@ -194,24 +216,28 @@ func (c *Console) handleLog(entries <-chan *log.Entry) {
 	}
 }
 
-func (c *Console) defaultFormatFunc() Formatter {
+func defaultFormatFunc(c *Console) Formatter {
 
 	var b []byte
 	var file string
 	var lvl string
 	var i int
 
-	if c.displayColor {
+	gopath := c.GOPATH()
+	tsFormat := c.TimestampFormat()
+	fnameDisplay := c.FilenameDisplay()
+
+	if c.DisplayColor() {
 
 		var color log.ANSIEscSeq
 
 		return func(e *log.Entry) []byte {
 			b = b[0:0]
-			color = c.colors[e.Level]
+			color = c.GetDisplayColor(e.Level)
 
 			if e.Line == 0 {
 
-				b = append(b, e.Timestamp.Format(c.timestampFormat)...)
+				b = append(b, e.Timestamp.Format(tsFormat)...)
 				b = append(b, space)
 				b = append(b, color...)
 
@@ -228,7 +254,7 @@ func (c *Console) defaultFormatFunc() Formatter {
 			} else {
 				file = e.File
 
-				if c.fileDisplay == log.Lshortfile {
+				if fnameDisplay == log.Lshortfile {
 
 					for i = len(file) - 1; i > 0; i-- {
 						if file[i] == '/' {
@@ -237,10 +263,10 @@ func (c *Console) defaultFormatFunc() Formatter {
 						}
 					}
 				} else {
-					file = file[len(c.gopath):]
+					file = file[len(gopath):]
 				}
 
-				b = append(b, e.Timestamp.Format(c.timestampFormat)...)
+				b = append(b, e.Timestamp.Format(tsFormat)...)
 				b = append(b, space)
 				b = append(b, color...)
 
@@ -308,7 +334,7 @@ func (c *Console) defaultFormatFunc() Formatter {
 
 		if e.Line == 0 {
 
-			b = append(b, e.Timestamp.Format(c.timestampFormat)...)
+			b = append(b, e.Timestamp.Format(tsFormat)...)
 			b = append(b, space)
 
 			lvl = e.Level.String()
@@ -324,7 +350,7 @@ func (c *Console) defaultFormatFunc() Formatter {
 		} else {
 			file = e.File
 
-			if c.fileDisplay == log.Lshortfile {
+			if fnameDisplay == log.Lshortfile {
 
 				for i = len(file) - 1; i > 0; i-- {
 					if file[i] == '/' {
@@ -333,10 +359,10 @@ func (c *Console) defaultFormatFunc() Formatter {
 					}
 				}
 			} else {
-				file = file[len(c.gopath):]
+				file = file[len(gopath):]
 			}
 
-			b = append(b, e.Timestamp.Format(c.timestampFormat)...)
+			b = append(b, e.Timestamp.Format(tsFormat)...)
 			b = append(b, space)
 
 			lvl = e.Level.String()

handlers/console/console_test.go

@@ -26,7 +26,7 @@ func TestConsoleLogger(t *testing.T) {
 
 	cLog := New()
 	cLog.SetWriter(buff)
-	cLog.DisplayColor(false)
+	cLog.SetDisplayColor(false)
 	cLog.SetBuffersAndWorkers(3, 0)
 	cLog.SetTimestampFormat("MST")
 	log.SetCallerInfoLevels(log.WarnLevel, log.ErrorLevel, log.PanicLevel, log.AlertLevel, log.FatalLevel)
@@ -121,7 +121,7 @@ func TestConsoleLoggerColor(t *testing.T) {
 
 	cLog := New()
 	cLog.SetWriter(buff)
-	cLog.DisplayColor(true)
+	cLog.SetDisplayColor(true)
 	cLog.SetBuffersAndWorkers(3, 3)
 	cLog.SetTimestampFormat("MST")
 
@@ -216,7 +216,7 @@ func TestCustomFormatFunc(t *testing.T) {
 	cLog.SetWriter(buff)
 	cLog.SetTimestampFormat("2006")
 	cLog.SetBuffersAndWorkers(3, 2)
-	cLog.SetFormatFunc(func() Formatter {
+	cLog.SetFormatFunc(func(c *Console) Formatter {
 
 		var b []byte
 
@@ -241,7 +241,7 @@ func TestSetFilename(t *testing.T) {
 
 	cLog := New()
 	cLog.SetWriter(buff)
-	cLog.DisplayColor(false)
+	cLog.SetDisplayColor(false)
 	cLog.SetBuffersAndWorkers(3, 1)
 	cLog.SetTimestampFormat("MST")
 	cLog.SetFilenameDisplay(log.Llongfile)
@@ -260,7 +260,7 @@ func TestSetFilenameColor(t *testing.T) {
 
 	cLog := New()
 	cLog.SetWriter(buff)
-	cLog.DisplayColor(true)
+	cLog.SetDisplayColor(true)
 	cLog.SetBuffersAndWorkers(3, 1)
 	cLog.SetTimestampFormat("MST")
 	cLog.SetFilenameDisplay(log.Llongfile)
@@ -280,7 +280,7 @@ func TestConsoleSTDLogCapturing(t *testing.T) {
 
 	cLog := New()
 	cLog.SetWriter(buff)
-	cLog.DisplayColor(false)
+	cLog.SetDisplayColor(false)
 	cLog.SetBuffersAndWorkers(3, 3)
 	cLog.SetTimestampFormat("MST")
 	cLog.RedirectSTDLogOutput(true)

handlers/email/email.go

@@ -124,6 +124,11 @@ func (email *Email) To() []string {
 	return email.to
 }
 
+// Template returns the Email's template
+func (email *Email) Template() *template.Template {
+	return email.template
+}
+
 // SetTimestampFormat sets Email's timestamp output format
 // Default is : "2006-01-02T15:04:05.000000000Z07:00"
 func (email *Email) SetTimestampFormat(format string) {
@@ -187,13 +192,14 @@ func (email *Email) Run() chan<- *log.Entry {
 func defaultFormatFunc(email *Email) Formatter {
 	var err error
 	b := new(bytes.Buffer)
+	template := email.Template()
 	message := gomail.NewMessage()
 	message.SetHeader("From", email.from)
 	message.SetHeader("To", email.to...)
 
 	return func(e *log.Entry) *gomail.Message {
 		b.Reset()
-		if err = email.template.ExecuteTemplate(b, "email", e); err != nil {
+		if err = template.ExecuteTemplate(b, "email", e); err != nil {
 			log.WithFields(log.F("error", err)).Error("Error parsing Email handler template")
 		}