feat: add NoFieldsColors option, fields with colors by default

antonfisher · Oct 20, 2018 · b7ed065 · b7ed065
1 parent f0afcd9
commit b7ed065
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -12,11 +12,12 @@ Default logrus formatter:
 
 ```go
 type Formatter struct {
+	FieldsOrder     []string // default: fields sorted alphabetically
 	TimestampFormat string   // default: time.StampMilli = "Jan _2 15:04:05.000"
 	HideKeys        bool     // show [fieldValue] instead of [fieldKey:fieldValue]
 	NoColors        bool     // disable colors
-	ShowFullLevel   bool     // true to show full level [WARNING] instead of [WARN]
-	FieldsOrder     []string // default: fields sorted alphabetically
+	NoFieldsColors  bool     // color only level, default is level + fields
+	ShowFullLevel   bool     // true to show full level [WARNING] instead [WARN]
 }
 ```
 

diff --git a/example/main.go b/example/main.go
@@ -11,13 +11,13 @@ func main() {
 	printDemo(&formatter.Formatter{
 		HideKeys:    true,
 		FieldsOrder: []string{"component", "category", "req"},
-	})
+	}, "nested-logrus-formatter")
 
 	fmt.Print("\n--- default logrus formatter ---\n\n")
-	printDemo(nil)
+	printDemo(nil, "default logrus formatter")
 }
 
-func printDemo(f logrus.Formatter) {
+func printDemo(f logrus.Formatter, title string) {
 	l := logrus.New()
 
 	l.SetLevel(logrus.DebugLevel)
@@ -26,7 +26,7 @@ func printDemo(f logrus.Formatter) {
 		l.SetFormatter(f)
 	}
 
-	l.Info("this is nested-logrus-formatter demo")
+	l.Infof("this is %v demo", title)
 
 	lWebServer := l.WithField("component", "web-server")
 	lWebServer.Info("starting...")

diff --git a/formatter.go b/formatter.go
@@ -12,11 +12,12 @@ import (
 
 // Formatter - logrus formatter, implements logrus.Formatter
 type Formatter struct {
+	FieldsOrder     []string // default: fields sorted alphabetically
 	TimestampFormat string   // default: time.StampMilli = "Jan _2 15:04:05.000"
 	HideKeys        bool     // show [fieldValue] instead of [fieldKey:fieldValue]
 	NoColors        bool     // disable colors
+	NoFieldsColors  bool     // color only level, default is level + fields
 	ShowFullLevel   bool     // true to show full level [WARNING] instead [WARN]
-	FieldsOrder     []string // default: fields sorted alphabetically
 }
 
 // Format an log entry
@@ -37,22 +38,20 @@ func (f *Formatter) Format(entry *logrus.Entry) ([]byte, error) {
 	// write level
 	level := strings.ToUpper(entry.Level.String())
 
-	if f.NoColors {
-		b.WriteString(" [")
-	} else {
-		fmt.Fprintf(b, " \x1b[%dm[", levelColor)
+	if !f.NoColors {
+		fmt.Fprintf(b, "\x1b[%dm", levelColor)
 	}
 
+	b.WriteString(" [")
 	if f.ShowFullLevel {
 		b.WriteString(level)
 	} else {
 		b.WriteString(level[:4])
 	}
+	b.WriteString("] ")
 
-	if f.NoColors {
-		b.WriteString("] ")
-	} else {
-		b.WriteString("]\x1b[0m ")
+	if !f.NoColors && f.NoFieldsColors {
+		b.WriteString("\x1b[0m ")
 	}
 
 	// write fields
@@ -62,6 +61,10 @@ func (f *Formatter) Format(entry *logrus.Entry) ([]byte, error) {
 		f.writeOrderedFields(b, entry)
 	}
 
+	if !f.NoColors && !f.NoFieldsColors {
+		b.WriteString("\x1b[0m ")
+	}
+
 	// write message
 	b.WriteString(entry.Message)
 	b.WriteByte('\n')