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"
|
|
|
|
"sort"
|
|
|
|
"strings"
|
2017-02-06 00:10:19 +00:00
|
|
|
"sync"
|
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
|
2016-08-23 17:23:35 +00:00
|
|
|
blue = 36
|
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
|
2018-02-14 01:44:51 +00:00
|
|
|
emptyFieldMap FieldMap
|
2014-09-16 21:19:03 +00:00
|
|
|
)
|
|
|
|
|
2014-05-04 00:43:55 +00:00
|
|
|
func init() {
|
|
|
|
baseTimestamp = time.Now()
|
|
|
|
}
|
|
|
|
|
2017-07-26 12:26:30 +00:00
|
|
|
// TextFormatter formats logs into text
|
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
|
2017-02-05 14:21:03 +00:00
|
|
|
|
2016-08-31 13:54:59 +00:00
|
|
|
// Disables the truncation of the level text to 4 characters.
|
|
|
|
DisableLevelTruncation bool
|
2018-01-24 04:04:29 +00:00
|
|
|
|
2017-02-14 10:53:03 +00:00
|
|
|
// QuoteEmptyFields will wrap empty fields in quotes if true
|
|
|
|
QuoteEmptyFields bool
|
|
|
|
|
2017-02-05 14:21:03 +00:00
|
|
|
// Whether the logger's out is to a terminal
|
2017-02-14 11:51:23 +00:00
|
|
|
isTerminal bool
|
|
|
|
|
2017-11-22 03:43:47 +00:00
|
|
|
// FieldMap allows users to customize the names of keys for default fields.
|
|
|
|
// As an example:
|
2017-11-22 03:56:37 +00:00
|
|
|
// formatter := &TextFormatter{
|
2017-11-22 03:43:47 +00:00
|
|
|
// FieldMap: FieldMap{
|
2017-11-22 03:56:37 +00:00
|
|
|
// FieldKeyTime: "@timestamp",
|
2017-11-22 03:43:47 +00:00
|
|
|
// FieldKeyLevel: "@level",
|
2017-11-22 03:56:37 +00:00
|
|
|
// FieldKeyMsg: "@message"}}
|
2017-11-22 03:43:47 +00:00
|
|
|
FieldMap FieldMap
|
|
|
|
|
2017-02-14 11:51:23 +00:00
|
|
|
sync.Once
|
2014-03-10 23:22:08 +00:00
|
|
|
}
|
|
|
|
|
2017-02-15 13:08:26 +00:00
|
|
|
func (f *TextFormatter) init(entry *Entry) {
|
|
|
|
if entry.Logger != nil {
|
2017-09-06 17:34:58 +00:00
|
|
|
f.isTerminal = checkIfTerminal(entry.Logger.Out)
|
2017-02-15 13:08:26 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-07-26 12:26:30 +00:00
|
|
|
// Format renders a single log entry
|
2014-03-10 23:22:08 +00:00
|
|
|
func (f *TextFormatter) Format(entry *Entry) ([]byte, error) {
|
2018-06-19 01:32:35 +00:00
|
|
|
prefixFieldClashes(entry.Data, f.FieldMap)
|
|
|
|
|
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)
|
|
|
|
}
|
2018-06-19 01:32:35 +00:00
|
|
|
|
|
|
|
var b *bytes.Buffer
|
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
|
|
|
|
2017-02-15 13:08:26 +00:00
|
|
|
f.Do(func() { f.init(entry) })
|
2017-02-05 14:21:03 +00:00
|
|
|
|
|
|
|
isColored := (f.ForceColors || f.isTerminal) && !f.DisableColors
|
2014-03-10 23:22:08 +00:00
|
|
|
|
2015-07-17 01:02:46 +00:00
|
|
|
timestampFormat := f.TimestampFormat
|
|
|
|
if timestampFormat == "" {
|
2017-07-26 12:26:30 +00:00
|
|
|
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 {
|
2017-11-22 03:43:47 +00:00
|
|
|
f.appendKeyValue(b, f.FieldMap.resolve(FieldKeyTime), entry.Time.Format(timestampFormat))
|
2014-12-15 19:02:02 +00:00
|
|
|
}
|
2017-11-22 03:43:47 +00:00
|
|
|
f.appendKeyValue(b, f.FieldMap.resolve(FieldKeyLevel), entry.Level.String())
|
2015-06-20 00:20:59 +00:00
|
|
|
if entry.Message != "" {
|
2017-11-22 03:43:47 +00:00
|
|
|
f.appendKeyValue(b, f.FieldMap.resolve(FieldKeyMsg), entry.Message)
|
2015-06-20 00:20:59 +00:00
|
|
|
}
|
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
|
|
|
|
}
|
|
|
|
|
2016-08-31 13:54:59 +00:00
|
|
|
levelText := strings.ToUpper(entry.Level.String())
|
|
|
|
if !f.DisableLevelTruncation {
|
|
|
|
levelText = levelText[0:4]
|
|
|
|
}
|
2014-09-17 00:19:42 +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-01-11 05:43:36 +00:00
|
|
|
fmt.Fprintf(b, "\x1b[%dm%s\x1b[0m[%04d] %-44s ", levelColor, levelText, int(entry.Time.Sub(baseTimestamp)/time.Second), entry.Message)
|
2015-02-20 16:43:24 +00:00
|
|
|
} else {
|
2015-07-20 17:43:12 +00:00
|
|
|
fmt.Fprintf(b, "\x1b[%dm%s\x1b[0m[%s] %-44s ", levelColor, levelText, entry.Time.Format(timestampFormat), 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
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-02-14 10:53:03 +00:00
|
|
|
func (f *TextFormatter) needsQuoting(text string) bool {
|
|
|
|
if f.QuoteEmptyFields && len(text) == 0 {
|
|
|
|
return true
|
|
|
|
}
|
2014-12-18 14:09:01 +00:00
|
|
|
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') ||
|
2017-06-18 13:48:52 +00:00
|
|
|
ch == '-' || ch == '.' || ch == '_' || ch == '/' || ch == '@' || 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{}) {
|
2017-07-25 07:39:35 +00:00
|
|
|
if b.Len() > 0 {
|
2017-07-21 14:14:28 +00:00
|
|
|
b.WriteByte(' ')
|
|
|
|
}
|
2015-06-27 14:09:22 +00:00
|
|
|
b.WriteString(key)
|
|
|
|
b.WriteByte('=')
|
2016-09-28 10:55:00 +00:00
|
|
|
f.appendValue(b, value)
|
|
|
|
}
|
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{}) {
|
2017-07-12 15:33:04 +00:00
|
|
|
stringVal, ok := value.(string)
|
|
|
|
if !ok {
|
2017-07-12 15:16:13 +00:00
|
|
|
stringVal = fmt.Sprint(value)
|
|
|
|
}
|
|
|
|
|
|
|
|
if !f.needsQuoting(stringVal) {
|
|
|
|
b.WriteString(stringVal)
|
|
|
|
} else {
|
2017-07-13 11:46:35 +00:00
|
|
|
b.WriteString(fmt.Sprintf("%q", stringVal))
|
2015-01-04 08:01:49 +00:00
|
|
|
}
|
2014-03-14 17:01:06 +00:00
|
|
|
}
|