mirror of https://github.com/sirupsen/logrus.git
45 lines
1.4 KiB
Go
45 lines
1.4 KiB
Go
package logrus
|
|
|
|
// The Formatter interface is used to implement a custom Formatter. It takes an
|
|
// `Entry`. It exposes all the fields, including the default ones:
|
|
//
|
|
// * `entry.Data["msg"]`. The message passed from Info, Warn, Error ..
|
|
// * `entry.Data["time"]`. The timestamp.
|
|
// * `entry.Data["level"]. The level the entry was logged at.
|
|
//
|
|
// Any additional fields added with `WithField` or `WithFields` are also in
|
|
// `entry.Data`. Format is expected to return an array of bytes which are then
|
|
// logged to `logger.Out`.
|
|
type Formatter interface {
|
|
Format(*Entry) ([]byte, error)
|
|
}
|
|
|
|
// This is to not silently overwrite `time`, `msg` and `level` fields when
|
|
// dumping it. If this code wasn't there doing:
|
|
//
|
|
// logrus.WithField("level", 1).Info("hello")
|
|
//
|
|
// Would just silently drop the user provided level. Instead with this code
|
|
// it'll logged as:
|
|
//
|
|
// {"level": "info", "fields.level": 1, "msg": "hello", "time": "..."}
|
|
//
|
|
// It's not exported because it's still using Data in an opionated way. It's to
|
|
// avoid code duplication between the two default formatters.
|
|
func prefixFieldClashes(entry *Entry) {
|
|
_, ok := entry.Data["time"]
|
|
if ok {
|
|
entry.Data["fields.time"] = entry.Data["time"]
|
|
}
|
|
|
|
_, ok = entry.Data["msg"]
|
|
if ok {
|
|
entry.Data["fields.msg"] = entry.Data["msg"]
|
|
}
|
|
|
|
_, ok = entry.Data["level"]
|
|
if ok {
|
|
entry.Data["fields.level"] = entry.Data["level"]
|
|
}
|
|
}
|