Documentation
¶
Index ¶
- Constants
- Variables
- func FormatPayload(payload []byte, length, cutLength, runesPerLine int) string
- func InitLog(level, formatter string, logMethod bool) error
- type CompColorMap
- type FieldMap
- type Logger
- func (l *Logger) Trace(args ...interface{})
- func (l *Logger) Tracef(format string, args ...interface{})
- func (l *Logger) Traceln(args ...interface{})
- func (l *Logger) WithComponent(comp string) *Logger
- func (l *Logger) WithError(err error) *Logger
- func (l *Logger) WithField(key string, value interface{}) *Logger
- func (l *Logger) WithFields(fields log.Fields) *Logger
- type TextFormatter
Constants ¶
View Source
const ( FORMATTER_TEXT = "text" FORMATTER_JSON = "json" FORMATTER_LOGFMT = "logfmt" )
Variables ¶
View Source
var Log = &Logger{log.StandardLogger()}
Functions ¶
func FormatPayload ¶
Types ¶
type CompColorMap ¶
CompColorMap keeps track of color for each component.
type Logger ¶
type Logger struct {
log.FieldLogger
}
func LogWithComponent ¶
func StandardLogger ¶
func StandardLogger() *Logger
func (*Logger) WithComponent ¶
type TextFormatter ¶
type TextFormatter struct {
// Override coloring based on CLICOLOR and CLICOLOR_FORCE. - https://bixense.com/clicolors/
EnvironmentOverrideColors bool
// Disable timestamp logging. useful when output is redirected to logging
// system that already adds timestamps.
DisableTimestamp bool
// 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
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
// 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
// QuoteEmptyFields will wrap empty fields in quotes if true
QuoteEmptyFields bool
// FieldMap allows users to customize the names of keys for default fields.
// As an example:
// formatter := &TextFormatter{
// FieldMap: FieldMap{
// FieldKeyTime: "@timestamp",
// FieldKeyLevel: "@level",
// FieldKeyMsg: "@message"}}
FieldMap FieldMap
ComponentMap FieldMap
ColorMap CompColorMap
// 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)
// contains filtered or unexported fields
}
TextFormatter formats logs into text
Click to show internal directories.
Click to hide internal directories.