2014-03-10 23:22:08 +00:00
|
|
|
package logrus
|
|
|
|
|
|
|
|
import (
|
2014-05-24 14:46:03 +00:00
|
|
|
"bytes"
|
2014-03-10 23:22:08 +00:00
|
|
|
"fmt"
|
2015-05-12 14:31:17 +00:00
|
|
|
"runtime"
|
2014-03-10 23:22:08 +00:00
|
|
|
"sort"
|
|
|
|
"strings"
|
2014-05-04 00:43:55 +00:00
|
|
|
"time"
|
2014-03-10 23:22:08 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
const (
|
|
|
|
nocolor = 0
|
|
|
|
red = 31
|
|
|
|
green = 32
|
|
|
|
yellow = 33
|
|
|
|
blue = 34
|
2015-02-20 15:32:47 +00:00
|
|
|
gray = 37
|
2014-03-10 23:22:08 +00:00
|
|
|
)
|
|
|
|
|
2014-09-16 21:19:03 +00:00
|
|
|
var (
|
2015-04-04 00:25:25 +00:00
|
|
|
baseTimestamp time.Time
|
|
|
|
isTerminal bool
|
2014-09-16 21:19:03 +00:00
|
|
|
)
|
|
|
|
|
2014-05-04 00:43:55 +00:00
|
|
|
func init() {
|
|
|
|
baseTimestamp = time.Now()
|
2014-09-16 21:19:03 +00:00
|
|
|
isTerminal = IsTerminal()
|
2014-05-04 00:43:55 +00:00
|
|
|
}
|
|
|
|
|
2014-03-10 23:22:08 +00:00
|
|
|
type TextFormatter struct {
|
2014-03-16 03:36:51 +00:00
|
|
|
// Set to true to bypass checking for a TTY before outputting colors.
|
2015-02-25 19:01:02 +00:00
|
|
|
ForceColors bool
|
|
|
|
|
|
|
|
// Force disabling colors.
|
2014-08-13 17:30:25 +00:00
|
|
|
DisableColors bool
|
2015-02-25 19:01:02 +00:00
|
|
|
|
|
|
|
// Disable timestamp logging. useful when output is redirected to logging
|
|
|
|
// system that already adds timestamps.
|
2014-12-15 19:02:02 +00:00
|
|
|
DisableTimestamp bool
|
2015-02-25 19:01:02 +00:00
|
|
|
|
|
|
|
// Enable logging the full timestamp when a TTY is attached instead of just
|
|
|
|
// the time passed since beginning of execution.
|
|
|
|
FullTimestamp bool
|
2015-03-09 15:19:51 +00:00
|
|
|
|
2015-04-04 00:25:25 +00:00
|
|
|
// TimestampFormat to use for display when a full timestamp is printed
|
2015-03-26 23:04:45 +00:00
|
|
|
TimestampFormat string
|
|
|
|
|
2015-03-09 15:19:51 +00:00
|
|
|
// The fields are sorted by default for a consistent output. For applications
|
|
|
|
// that log extremely frequently and don't use the JSON formatter this may not
|
|
|
|
// be desired.
|
|
|
|
DisableSorting bool
|
2014-03-10 23:22:08 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func (f *TextFormatter) Format(entry *Entry) ([]byte, error) {
|
2016-06-18 13:47:44 +00:00
|
|
|
var b *bytes.Buffer
|
2017-01-11 18:19:12 +00:00
|
|
|
keys := make([]string, 0, len(entry.Data))
|
2014-09-17 00:19:42 +00:00
|
|
|
for k := range entry.Data {
|
|
|
|
keys = append(keys, k)
|
|
|
|
}
|
2015-03-09 15:19:51 +00:00
|
|
|
|
|
|
|
if !f.DisableSorting {
|
|
|
|
sort.Strings(keys)
|
|
|
|
}
|
2016-06-18 13:47:44 +00:00
|
|
|
if entry.Buffer != nil {
|
|
|
|
b = entry.Buffer
|
|
|
|
} else {
|
|
|
|
b = &bytes.Buffer{}
|
|
|
|
}
|
2014-03-10 23:22:08 +00:00
|
|
|
|
2016-11-30 23:15:38 +00:00
|
|
|
prefixFieldClashes(entry.Data, entry.HasCaller())
|
2014-07-27 01:26:04 +00:00
|
|
|
|
2015-05-12 14:31:17 +00:00
|
|
|
isColorTerminal := isTerminal && (runtime.GOOS != "windows")
|
|
|
|
isColored := (f.ForceColors || isColorTerminal) && !f.DisableColors
|
2014-03-10 23:22:08 +00:00
|
|
|
|
2015-07-17 01:02:46 +00:00
|
|
|
timestampFormat := f.TimestampFormat
|
|
|
|
if timestampFormat == "" {
|
|
|
|
timestampFormat = DefaultTimestampFormat
|
2015-03-26 23:04:45 +00:00
|
|
|
}
|
2014-09-17 00:19:42 +00:00
|
|
|
if isColored {
|
2015-07-20 17:43:12 +00:00
|
|
|
f.printColored(b, entry, keys, timestampFormat)
|
2014-03-14 17:01:06 +00:00
|
|
|
} else {
|
2014-12-15 19:02:02 +00:00
|
|
|
if !f.DisableTimestamp {
|
2015-07-17 01:02:46 +00:00
|
|
|
f.appendKeyValue(b, "time", entry.Time.Format(timestampFormat))
|
2014-12-15 19:02:02 +00:00
|
|
|
}
|
2015-01-15 18:40:48 +00:00
|
|
|
f.appendKeyValue(b, "level", entry.Level.String())
|
2016-11-30 23:15:38 +00:00
|
|
|
if entry.HasCaller() {
|
2016-12-06 20:53:21 +00:00
|
|
|
f.appendKeyValue(b, "func", entry.Caller)
|
2016-11-26 03:02:56 +00:00
|
|
|
}
|
2015-06-20 00:20:59 +00:00
|
|
|
if entry.Message != "" {
|
|
|
|
f.appendKeyValue(b, "msg", entry.Message)
|
|
|
|
}
|
2014-09-17 00:19:42 +00:00
|
|
|
for _, key := range keys {
|
2015-01-15 18:40:48 +00:00
|
|
|
f.appendKeyValue(b, key, entry.Data[key])
|
2014-03-10 23:22:08 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-05-24 14:46:03 +00:00
|
|
|
b.WriteByte('\n')
|
2015-01-15 18:40:48 +00:00
|
|
|
return b.Bytes(), nil
|
2014-03-10 23:22:08 +00:00
|
|
|
}
|
2014-03-14 17:01:06 +00:00
|
|
|
|
2015-07-20 17:43:12 +00:00
|
|
|
func (f *TextFormatter) printColored(b *bytes.Buffer, entry *Entry, keys []string, timestampFormat string) {
|
2014-09-17 00:19:42 +00:00
|
|
|
var levelColor int
|
|
|
|
switch entry.Level {
|
2015-02-20 15:32:47 +00:00
|
|
|
case DebugLevel:
|
|
|
|
levelColor = gray
|
2014-09-17 00:19:42 +00:00
|
|
|
case WarnLevel:
|
|
|
|
levelColor = yellow
|
|
|
|
case ErrorLevel, FatalLevel, PanicLevel:
|
|
|
|
levelColor = red
|
|
|
|
default:
|
|
|
|
levelColor = blue
|
|
|
|
}
|
|
|
|
|
|
|
|
levelText := strings.ToUpper(entry.Level.String())[0:4]
|
|
|
|
|
2016-11-26 03:02:56 +00:00
|
|
|
caller := ""
|
2016-11-30 22:07:10 +00:00
|
|
|
|
2016-11-30 23:15:38 +00:00
|
|
|
if entry.HasCaller() {
|
2016-11-29 17:35:34 +00:00
|
|
|
caller = fmt.Sprintf(" %s()", entry.Caller)
|
2016-11-26 03:02:56 +00:00
|
|
|
}
|
|
|
|
|
2016-08-24 21:59:41 +00:00
|
|
|
if f.DisableTimestamp {
|
|
|
|
fmt.Fprintf(b, "\x1b[%dm%s\x1b[0m %-44s ", levelColor, levelText, entry.Message)
|
|
|
|
} else if !f.FullTimestamp {
|
2017-02-03 22:56:03 +00:00
|
|
|
fmt.Fprintf(b, "\x1b[%dm%s\x1b[0m[%04d]%s %-44s ", levelColor, levelText, int(entry.Time.Sub(baseTimestamp)/time.Second), caller, entry.Message)
|
2015-02-20 16:43:24 +00:00
|
|
|
} else {
|
2017-02-03 22:56:03 +00:00
|
|
|
fmt.Fprintf(b, "\x1b[%dm%s\x1b[0m[%s]%s %-44s ", levelColor, levelText, entry.Time.Format(timestampFormat), caller, entry.Message)
|
2015-02-20 16:43:24 +00:00
|
|
|
}
|
2014-09-17 00:19:42 +00:00
|
|
|
for _, k := range keys {
|
|
|
|
v := entry.Data[k]
|
2016-09-28 10:55:00 +00:00
|
|
|
fmt.Fprintf(b, " \x1b[%dm%s\x1b[0m=", levelColor, k)
|
|
|
|
f.appendValue(b, v)
|
2014-09-17 00:19:42 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-12-18 14:09:01 +00:00
|
|
|
func needsQuoting(text string) bool {
|
|
|
|
for _, ch := range text {
|
|
|
|
if !((ch >= 'a' && ch <= 'z') ||
|
|
|
|
(ch >= 'A' && ch <= 'Z') ||
|
2015-03-04 14:04:50 +00:00
|
|
|
(ch >= '0' && ch <= '9') ||
|
2014-12-18 14:09:01 +00:00
|
|
|
ch == '-' || ch == '.') {
|
2016-04-16 08:18:56 +00:00
|
|
|
return true
|
2014-12-18 14:09:01 +00:00
|
|
|
}
|
|
|
|
}
|
2016-04-16 08:18:56 +00:00
|
|
|
return false
|
2014-12-18 14:09:01 +00:00
|
|
|
}
|
|
|
|
|
2015-06-27 14:09:22 +00:00
|
|
|
func (f *TextFormatter) appendKeyValue(b *bytes.Buffer, key string, value interface{}) {
|
|
|
|
|
|
|
|
b.WriteString(key)
|
|
|
|
b.WriteByte('=')
|
2016-09-28 10:55:00 +00:00
|
|
|
f.appendValue(b, value)
|
|
|
|
b.WriteByte(' ')
|
|
|
|
}
|
2015-06-27 14:09:22 +00:00
|
|
|
|
2016-09-28 10:55:00 +00:00
|
|
|
func (f *TextFormatter) appendValue(b *bytes.Buffer, value interface{}) {
|
2015-06-27 14:09:22 +00:00
|
|
|
switch value := value.(type) {
|
2014-12-15 19:20:33 +00:00
|
|
|
case string:
|
2016-04-16 08:18:56 +00:00
|
|
|
if !needsQuoting(value) {
|
2015-06-27 14:09:22 +00:00
|
|
|
b.WriteString(value)
|
2015-01-15 18:40:48 +00:00
|
|
|
} else {
|
2015-06-27 14:09:22 +00:00
|
|
|
fmt.Fprintf(b, "%q", value)
|
2015-01-15 18:40:48 +00:00
|
|
|
}
|
2014-12-15 19:20:33 +00:00
|
|
|
case error:
|
2015-06-27 14:09:22 +00:00
|
|
|
errmsg := value.Error()
|
2016-04-16 08:18:56 +00:00
|
|
|
if !needsQuoting(errmsg) {
|
2015-06-27 14:09:22 +00:00
|
|
|
b.WriteString(errmsg)
|
2015-01-15 18:40:48 +00:00
|
|
|
} else {
|
2016-09-28 10:55:00 +00:00
|
|
|
fmt.Fprintf(b, "%q", errmsg)
|
2015-01-15 18:40:48 +00:00
|
|
|
}
|
2014-10-03 15:58:24 +00:00
|
|
|
default:
|
2015-06-27 14:09:22 +00:00
|
|
|
fmt.Fprint(b, value)
|
2015-01-04 08:01:49 +00:00
|
|
|
}
|
2014-03-14 17:01:06 +00:00
|
|
|
}
|