minor

Author: kataras

HISTORY.md

@@ -30,7 +30,7 @@ Introduce the [Formatter](https://github.com/kataras/golog/blob/master/formatter
 
 ## Sa 06 June 2020 | v0.0.16
 
-- New `Fields` map type that can be passed to `Logf/Debugf/Infof/Warnf/Errorf/Fatalf` functions and set the `Log.Fields` data field (which can be retrieved through a custom `LogHandler`).
+- New `Fields` type that can be passed to `Logf/Debugf/Infof/Warnf/Errorf/Fatalf` functions and set the `Log.Fields` data field (which can be retrieved through a custom `LogHandler`).
 - Add `Log.Stacktrace` of new `Frame` type which holds the callers stack trace when `Debug/Debugf`.
 - Add `json` struct fields to the `Log` structure.
 - Update the [customize-output](_examples/customize-output) example.

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2017-2020 Gerasimos Maropoulos.
+Copyright (c) 2017-2021 Gerasimos Maropoulos.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

_benchmarks/golog_test.go

@@ -30,5 +30,5 @@ func printGolog(i int) {
 	golog.Errorf("[%d] This is an error message", i)
 	golog.Warnf("[%d] This is a warning message", i)
 	golog.Infof("[%d] This is an info message", i)
-	golog.Debugf("[%d] This is a debug message", i)
+	// Debug on golog prints the whole stacktrace, while logrus does not, don't include that.
 }

_benchmarks/logrus_test.go

@@ -23,5 +23,4 @@ func printLogrus(i int) {
 	logrus.Errorf("[%d] This is an error message", i)
 	logrus.Warnf("[%d] This is a warning message", i)
 	logrus.Infof("[%d] This is an info message", i)
-	logrus.Debugf("[%d] This is a debug message", i)
 }

_benchmarks/std_test.go

@@ -1,5 +1,3 @@
-// +build ignore
-
 package benchmarks
 
 import (
@@ -27,8 +25,7 @@ func BenchmarkStdPrint(b *testing.B) {
 }
 
 func printStd(i int) {
-	log.Printf("[%d] [%s] This is an error message\n", i, pio.Red("[ERRO]"))
-	log.Printf("[%d] [%s] This is a warning message\n", i, pio.Purple("[WARN]"))
-	log.Printf("[%d] [%s] This is an info message\n", i, pio.LightGreen("[INFO]"))
-	log.Printf("[%d] [%s] This is a debug message\n", i, pio.Yellow("[DBUG]"))
+	log.Printf("[%d] [%s] This is an error message\n", i, pio.Rich("[ERRO]", pio.Red))
+	log.Printf("[%d] [%s] This is a warning message\n", i, pio.Rich("[WARN]", pio.Magenta))
+	log.Printf("[%d] [%s] This is an info message\n", i, pio.Rich("[INFO]", pio.Green))
 }

_examples/customize-output/main.go

@@ -26,7 +26,7 @@ func main() {
 	*/
 	golog.Debugf("This is a %s with data (debug prints the stacktrace too)", "message", golog.Fields{
 		"username": "kataras",
-	})
+	}) // If more than one golog.Fields passed, then they are merged into a single map.
 
 	/* Example Output:
 	{
@@ -36,12 +36,23 @@ func main() {
 	    "fields": {
 	        "home": "https://iris-go.com"
 	    }
+		"stacktrace": [...]
 	}
 	*/
 	golog.Infof("An info message", golog.Fields{"home": "https://iris-go.com"})
 
 	golog.Warnf("Hey, warning here")
 	golog.Errorf("Something went wrong!")
+
+	// You can also pass custom structs, like normally you would do.
+	type myCustomData struct {
+		Username string `json:"username"`
+		Email    string `json:"email"`
+	}
+	golog.Fatalf("A fatal error for %s screen!", "home", golog.Fields{"data": myCustomData{
+		Username: "kataras",
+		Email:    "kataras2006@hotmail.com",
+	}})
 }
 
 /* Manually, use it for any custom format:

doc.go

@@ -1,31 +1,32 @@
-// Copyright (c) 2017-2020 Gerasimos Maropoulos.
-// All rights reserved.
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are
-// met:
-//
-//    * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-//    * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-//    * Neither the name of golog nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+/*
+Copyright (c) 2017-2021 Gerasimos Maropoulos.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+   * Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+   * Redistributions in binary form must reproduce the above
+copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the
+distribution.
+   * Neither the name of golog nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 /*
 Package golog provides an easy to use foundation for your logging operations.
@@ -36,7 +37,7 @@ Source code and other details for the project are available at GitHub:
 
 Current Version
 
-0.1.4
+0.1.7
 
 Installation
 
@@ -385,9 +386,8 @@ If you enjoy what you just saw and want to learn more, please follow the below l
 Examples:
 
 	https://github.com/kataras/golog/tree/master/_examples
-
 */
-package golog // import "github.com/kataras/golog"
+package golog
 
 // Version is the version string representation of the "golog" package.
-const Version = "0.1.4"
+const Version = "0.1.7"

logger.go

@@ -73,7 +73,7 @@ func New() *Logger {
 	}
 }
 
-// Fields is just a custom type of the map type.
+// Fields is a map type.
 // One or more values of `Fields` type can be passed
 // on all Log methods except `Print/Printf/Println` to set the `Log.Fields` field,
 // which can be accessed through a custom LogHandler.
@@ -368,26 +368,26 @@ func (l *Logger) Println(v ...interface{}) {
 	l.print(DisableLevel, fmt.Sprint(v...), true, nil)
 }
 
-func splitArgsFields(v []interface{}) ([]interface{}, Fields) {
+func splitArgsFields(values []interface{}) ([]interface{}, Fields) {
 	var (
-		args   = v[:0]
+		args   = values[:0]
 		fields Fields
 	)
 
-	for _, val := range v {
-		f, ok := val.(Fields)
-		if ok {
-			if len(fields) > 0 { // upsert new values.
-				for k, v := range f {
-					fields[k] = v
-				}
-			} else {
-				fields = f // set fields.
+	for _, value := range values {
+		if f, ok := value.(Fields); ok {
+			if fields == nil {
+				fields = make(Fields)
+			}
+
+			for k, v := range f {
+				fields[k] = v
 			}
+
 			continue
 		}
 
-		args = append(args, val) // use it as fmt argument.
+		args = append(args, value) // use it as fmt argument.
 	}
 
 	return args, fields
@@ -408,8 +408,11 @@ func (l *Logger) Log(level Level, v ...interface{}) {
 // It adds a new line in the end.
 func (l *Logger) Logf(level Level, format string, args ...interface{}) {
 	if l.Level >= level {
-		args, fields := splitArgsFields(args)
-		msg := fmt.Sprintf(format, args...)
+		arguments, fields := splitArgsFields(args)
+		msg := format
+		if len(arguments) > 0 {
+			msg = fmt.Sprintf(msg, arguments...)
+		}
 		l.print(level, msg, l.NewLine, fields)
 	}
 }