logrus/text_formatter.go

351 lines
9.2 KiB
Go
Raw Normal View History

2014-03-11 03:22:08 +04:00
package logrus
import (
"bytes"
2014-03-11 03:22:08 +04:00
"fmt"
"os"
"runtime"
2014-03-11 03:22:08 +04:00
"sort"
2019-06-25 06:42:20 +03:00
"strconv"
2014-03-11 03:22:08 +04:00
"strings"
2017-02-06 03:10:19 +03:00
"sync"
"time"
"unicode/utf8"
2014-03-11 03:22:08 +04:00
)
const (
red = 31
yellow = 33
blue = 36
gray = 37
2014-03-11 03:22:08 +04:00
)
var baseTimestamp time.Time
func init() {
baseTimestamp = time.Now()
}
2017-07-26 15:26:30 +03:00
// TextFormatter formats logs into text
2014-03-11 03:22:08 +04:00
type TextFormatter struct {
2024-05-14 09:00:24 +03:00
// Set to true if want the log not to contain the startingKey, e.g.
// 0001-01-01T00:00:00Z warning message
ExcludeKey bool
// Set to true to bypass checking for a TTY before outputting colors.
2015-02-25 22:01:02 +03:00
ForceColors bool
// Force disabling colors.
DisableColors bool
2015-02-25 22:01:02 +03:00
2019-10-15 08:53:51 +03:00
// Force quoting of all values
ForceQuote bool
// DisableQuote disables quoting for all values.
// DisableQuote will have a lower priority than ForceQuote.
// If both of them are set to true, quote will be forced on all values.
DisableQuote bool
// Override coloring based on CLICOLOR and CLICOLOR_FORCE. - https://bixense.com/clicolors/
2018-08-09 16:00:46 +03:00
EnvironmentOverrideColors bool
2015-02-25 22:01:02 +03:00
// Disable timestamp logging. useful when output is redirected to logging
// system that already adds timestamps.
DisableTimestamp bool
2015-02-25 22:01:02 +03:00
// Enable logging the full timestamp when a TTY is attached instead of just
// the time passed since beginning of execution.
FullTimestamp bool
// TimestampFormat to use for display when a full timestamp is printed.
// The format to use is the same than for time.Format or time.Parse from the standard
// library.
// The standard Library already provides a set of predefined format.
TimestampFormat string
// 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 17:21:03 +03:00
// The keys sorting function, when uninitialized it uses sort.Strings.
SortingFunc func([]string)
// Disables the truncation of the level text to 4 characters.
DisableLevelTruncation bool
2018-01-24 07:04:29 +03:00
2019-06-05 10:10:46 +03:00
// PadLevelText Adds padding the level text so that all the levels output at the same length
// PadLevelText is a superset of the DisableLevelTruncation option
PadLevelText bool
// QuoteEmptyFields will wrap empty fields in quotes if true
QuoteEmptyFields bool
2017-02-05 17:21:03 +03:00
// Whether the logger's out is to a terminal
isTerminal bool
2017-11-22 06:43:47 +03:00
// FieldMap allows users to customize the names of keys for default fields.
// As an example:
2017-11-22 06:56:37 +03:00
// formatter := &TextFormatter{
2017-11-22 06:43:47 +03:00
// FieldMap: FieldMap{
2017-11-22 06:56:37 +03:00
// FieldKeyTime: "@timestamp",
2017-11-22 06:43:47 +03:00
// FieldKeyLevel: "@level",
2017-11-22 06:56:37 +03:00
// FieldKeyMsg: "@message"}}
2017-11-22 06:43:47 +03:00
FieldMap FieldMap
// CallerPrettyfier can be set by the user to modify the content
// of the function and file keys in the data when ReportCaller is
// activated. If any of the returned value is the empty string the
// corresponding key will be removed from fields.
CallerPrettyfier func(*runtime.Frame) (function string, file string)
terminalInitOnce sync.Once
2019-06-25 06:42:20 +03:00
// The max length of the level text, generated dynamically on init
levelTextMaxLength int
2014-03-11 03:22:08 +04:00
}
2017-02-15 16:08:26 +03:00
func (f *TextFormatter) init(entry *Entry) {
if entry.Logger != nil {
f.isTerminal = checkIfTerminal(entry.Logger.Out)
2017-02-15 16:08:26 +03:00
}
2019-06-25 06:42:20 +03:00
// Get the max length of the level text
for _, level := range AllLevels {
levelTextLength := utf8.RuneCount([]byte(level.String()))
2019-06-25 06:42:20 +03:00
if levelTextLength > f.levelTextMaxLength {
f.levelTextMaxLength = levelTextLength
}
}
2017-02-15 16:08:26 +03:00
}
func (f *TextFormatter) isColored() bool {
isColored := f.ForceColors || (f.isTerminal && (runtime.GOOS != "windows"))
2018-08-09 16:00:46 +03:00
if f.EnvironmentOverrideColors {
switch force, ok := os.LookupEnv("CLICOLOR_FORCE"); {
case ok && force != "0":
isColored = true
case ok && force == "0", os.Getenv("CLICOLOR") == "0":
isColored = false
}
2017-02-15 16:08:26 +03:00
}
return isColored && !f.DisableColors
2014-03-11 03:22:08 +04:00
}
2017-07-26 15:26:30 +03:00
// Format renders a single log entry
2014-03-11 03:22:08 +04:00
func (f *TextFormatter) Format(entry *Entry) ([]byte, error) {
data := make(Fields)
for k, v := range entry.Data {
data[k] = v
}
prefixFieldClashes(data, f.FieldMap, entry.HasCaller())
keys := make([]string, 0, len(data))
for k := range data {
keys = append(keys, k)
}
var funcVal, fileVal string
fixedKeys := make([]string, 0, 4+len(data))
if !f.DisableTimestamp {
fixedKeys = append(fixedKeys, f.FieldMap.resolve(FieldKeyTime))
}
fixedKeys = append(fixedKeys, f.FieldMap.resolve(FieldKeyLevel))
if entry.Message != "" {
fixedKeys = append(fixedKeys, f.FieldMap.resolve(FieldKeyMsg))
}
if entry.err != "" {
fixedKeys = append(fixedKeys, f.FieldMap.resolve(FieldKeyLogrusError))
}
if entry.HasCaller() {
if f.CallerPrettyfier != nil {
funcVal, fileVal = f.CallerPrettyfier(entry.Caller)
} else {
funcVal = entry.Caller.Function
fileVal = fmt.Sprintf("%s:%d", entry.Caller.File, entry.Caller.Line)
}
if funcVal != "" {
fixedKeys = append(fixedKeys, f.FieldMap.resolve(FieldKeyFunc))
}
if fileVal != "" {
fixedKeys = append(fixedKeys, f.FieldMap.resolve(FieldKeyFile))
}
}
if !f.DisableSorting {
if f.SortingFunc == nil {
sort.Strings(keys)
fixedKeys = append(fixedKeys, keys...)
} else {
if !f.isColored() {
fixedKeys = append(fixedKeys, keys...)
f.SortingFunc(fixedKeys)
} else {
f.SortingFunc(keys)
}
}
} else {
fixedKeys = append(fixedKeys, keys...)
}
var b *bytes.Buffer
if entry.Buffer != nil {
b = entry.Buffer
} else {
b = &bytes.Buffer{}
}
2014-03-11 03:22:08 +04:00
f.terminalInitOnce.Do(func() { f.init(entry) })
2014-03-11 03:22:08 +04:00
timestampFormat := f.TimestampFormat
if timestampFormat == "" {
2017-07-26 15:26:30 +03:00
timestampFormat = defaultTimestampFormat
}
if f.isColored() {
2018-11-06 13:01:28 +03:00
f.printColored(b, entry, keys, data, timestampFormat)
} else {
for _, key := range fixedKeys {
var value interface{}
switch {
case key == f.FieldMap.resolve(FieldKeyTime):
value = entry.Time.Format(timestampFormat)
case key == f.FieldMap.resolve(FieldKeyLevel):
value = entry.Level.String()
case key == f.FieldMap.resolve(FieldKeyMsg):
value = entry.Message
case key == f.FieldMap.resolve(FieldKeyLogrusError):
value = entry.err
case key == f.FieldMap.resolve(FieldKeyFunc) && entry.HasCaller():
value = funcVal
case key == f.FieldMap.resolve(FieldKeyFile) && entry.HasCaller():
value = fileVal
default:
value = data[key]
}
f.appendKeyValue(b, key, value)
2014-03-11 03:22:08 +04:00
}
}
b.WriteByte('\n')
return b.Bytes(), nil
2014-03-11 03:22:08 +04:00
}
func (f *TextFormatter) printColored(b *bytes.Buffer, entry *Entry, keys []string, data Fields, timestampFormat string) {
var levelColor int
switch entry.Level {
2017-10-20 15:40:54 +03:00
case DebugLevel, TraceLevel:
2015-02-20 18:32:47 +03:00
levelColor = gray
case WarnLevel:
levelColor = yellow
case ErrorLevel, FatalLevel, PanicLevel:
levelColor = red
2020-11-08 09:07:05 +03:00
case InfoLevel:
levelColor = blue
default:
levelColor = blue
}
levelText := strings.ToUpper(entry.Level.String())
2019-06-05 10:10:46 +03:00
if !f.DisableLevelTruncation && !f.PadLevelText {
levelText = levelText[0:4]
}
2019-06-05 10:10:46 +03:00
if f.PadLevelText {
2019-06-25 06:42:20 +03:00
// Generates the format string used in the next line, for example "%-6s" or "%-7s".
// Based on the max level text length.
formatString := "%-" + strconv.Itoa(f.levelTextMaxLength) + "s"
// Formats the level text by appending spaces up to the max length, for example:
// - "INFO "
// - "WARNING"
levelText = fmt.Sprintf(formatString, levelText)
2019-06-05 10:10:46 +03:00
}
// Remove a single newline if it already exists in the message to keep
// the behavior of logrus text_formatter the same as the stdlib log package
entry.Message = strings.TrimSuffix(entry.Message, "\n")
caller := ""
2016-12-01 02:15:38 +03:00
if entry.HasCaller() {
funcVal := fmt.Sprintf("%s()", entry.Caller.Function)
fileVal := fmt.Sprintf("%s:%d", entry.Caller.File, entry.Caller.Line)
if f.CallerPrettyfier != nil {
funcVal, fileVal = f.CallerPrettyfier(entry.Caller)
}
if fileVal == "" {
caller = funcVal
} else if funcVal == "" {
caller = fileVal
} else {
caller = fileVal + " " + funcVal
}
}
switch {
case f.DisableTimestamp:
fmt.Fprintf(b, "\x1b[%dm%s\x1b[0m%s %-44s ", levelColor, levelText, caller, entry.Message)
case !f.FullTimestamp:
fmt.Fprintf(b, "\x1b[%dm%s\x1b[0m[%04d]%s %-44s ", levelColor, levelText, int(entry.Time.Sub(baseTimestamp)/time.Second), caller, entry.Message)
default:
fmt.Fprintf(b, "\x1b[%dm%s\x1b[0m[%s]%s %-44s ", levelColor, levelText, entry.Time.Format(timestampFormat), caller, entry.Message)
}
for _, k := range keys {
v := data[k]
fmt.Fprintf(b, " \x1b[%dm%s\x1b[0m=", levelColor, k)
f.appendValue(b, v)
}
}
func (f *TextFormatter) needsQuoting(text string) bool {
2019-10-15 08:53:51 +03:00
if f.ForceQuote {
return true
}
if f.QuoteEmptyFields && len(text) == 0 {
return true
}
if f.DisableQuote {
return false
}
2014-12-18 17:09:01 +03:00
for _, ch := range text {
if !((ch >= 'a' && ch <= 'z') ||
(ch >= 'A' && ch <= 'Z') ||
2015-03-04 17:04:50 +03:00
(ch >= '0' && ch <= '9') ||
ch == '-' || ch == '.' || ch == '_' || ch == '/' || ch == '@' || ch == '^' || ch == '+') {
return true
2014-12-18 17:09:01 +03:00
}
}
return false
2014-12-18 17:09:01 +03:00
}
func (f *TextFormatter) appendKeyValue(b *bytes.Buffer, key string, value interface{}) {
if b.Len() > 0 {
b.WriteByte(' ')
}
2024-05-14 09:00:24 +03:00
if !f.ExcludeKey {
b.WriteString(key)
b.WriteByte('=')
}
f.appendValue(b, value)
}
func (f *TextFormatter) appendValue(b *bytes.Buffer, value interface{}) {
2017-07-12 18:33:04 +03:00
stringVal, ok := value.(string)
if !ok {
2017-07-12 18:16:13 +03:00
stringVal = fmt.Sprint(value)
}
2024-05-14 09:00:24 +03:00
// write value without quoting directly when ExcludeKey is true
if f.ExcludeKey {
2017-07-12 18:16:13 +03:00
b.WriteString(stringVal)
} else {
2024-05-14 09:00:24 +03:00
if !f.needsQuoting(stringVal) {
b.WriteString(stringVal)
} else {
b.WriteString(fmt.Sprintf("%q", stringVal))
}
}
}