log

Documentation

Index

• Variables
• func AlarmFatal(msg string, exitCode int)
• func AlarmPanic(msg string)
• func Debug(msg string, keyValues ...any)
• func Error(msg string, keyValues ...any)
• func Fatal(msg string, keyValues ...any)
• func Info(msg string, keyValues ...any)
• func Panic(msg string, keyValues ...any)
• func RegisterLevel(l Level, s string) error
• func SetGlobalLogger(logger *Logger)
• func Warn(msg string, keyValues ...any)
• type Event
• type Formatter
• type Level
  • func (l Level) String() string
• type Logger
  • func New() *Logger
  • func (l *Logger) Debug(msg string, keyValues ...any)
  • func (l *Logger) Error(msg string, keyValues ...any)
  • func (l *Logger) Fatal(msg string, keyValues ...any)
  • func (l *Logger) Info(msg string, keyValues ...any)
  • func (l *Logger) Panic(msg string, keyValues ...any)
  • func (l *Logger) SetAlarmFatal(alarmFatal func(msg string, exitCode int))
  • func (l *Logger) SetAlarmPanic(alarmPanic func(msg string))
  • func (l *Logger) SetCallerSkip(skip int)
  • func (l *Logger) SetFields(fields ...func(f Formatter, event *Event) bytes.BufferWriter)
  • func (l *Logger) SetFormatter(formatter Formatter)
  • func (l *Logger) SetLevel(level Level)
  • func (l *Logger) SetWriter(writer io.Writer)
  • func (l *Logger) Warn(msg string, keyValues ...any)
• type TextFormatter
  • func (f *TextFormatter) FormatCaller(callerSkip int) bytes.BufferWriter
  • func (f *TextFormatter) FormatLevel(level Level) bytes.BufferWriter
  • func (f *TextFormatter) FormatMsg(msg string, keyValues ...any) bytes.BufferWriter
  • func (f *TextFormatter) FormatTime(t time.Time) bytes.BufferWriter
  • func (f *TextFormatter) MsgSplit() string

Variables

var (
	FieldLevel  = func(f Formatter, event *Event) bytes.BufferWriter { return f.FormatLevel(event.Level) }
	FieldTime   = func(f Formatter, event *Event) bytes.BufferWriter { return f.FormatTime(event.Time) }
	FieldCaller = func(f Formatter, event *Event) bytes.BufferWriter { return f.FormatCaller(event.CallerSkip) }
)

var ErrLevelAlreadyRegistered = errors.New("level already registered")

Functions

func AlarmFatal

func AlarmFatal(msg string, exitCode int)

func AlarmPanic

func AlarmPanic(msg string)

func Debug

func Debug(msg string, keyValues ...any)

func Error

func Error(msg string, keyValues ...any)

func Fatal

func Fatal(msg string, keyValues ...any)

func Info

func Info(msg string, keyValues ...any)

func Panic

func Panic(msg string, keyValues ...any)

func RegisterLevel

func RegisterLevel(l Level, s string) error

func SetGlobalLogger

func SetGlobalLogger(logger *Logger)

SetGlobalLogger sets a global logger.

CallerSkip of global logger should be 4 at least. Make sure that you set the correct caller skip.

func Warn

func Warn(msg string, keyValues ...any)

Types

type Event

type Event struct {
	CallerSkip int
	Level      Level
	Time       time.Time
}

type Formatter

type Formatter interface {
	FormatLevel(level Level) bytes.BufferWriter
	FormatTime(t time.Time) bytes.BufferWriter
	FormatCaller(callerSkip int) bytes.BufferWriter
	FormatMsg(msg string, keyValues ...any) bytes.BufferWriter
	MsgSplit() string
}

type Level

type Level uint8

const (
	LevelDebug Level = 10 * (1 + iota)
	LevelInfo
	LevelWarn
	LevelError
	LevelPanic
	LevelFatal

	LevelUnknown Level = 200
)

func (Level) String

func (l Level) String() string

type Logger

type Logger struct {
	// contains filtered or unexported fields
}

func New

func New() *Logger

func (*Logger) Debug

func (l *Logger) Debug(msg string, keyValues ...any)

func (*Logger) Error

func (l *Logger) Error(msg string, keyValues ...any)

func (*Logger) Fatal

func (l *Logger) Fatal(msg string, keyValues ...any)

func (*Logger) Info

func (l *Logger) Info(msg string, keyValues ...any)

func (*Logger) Panic

func (l *Logger) Panic(msg string, keyValues ...any)

func (*Logger) SetAlarmFatal

func (l *Logger) SetAlarmFatal(alarmFatal func(msg string, exitCode int))

func (*Logger) SetAlarmPanic

func (l *Logger) SetAlarmPanic(alarmPanic func(msg string))

func (*Logger) SetCallerSkip

func (l *Logger) SetCallerSkip(skip int)

func (*Logger) SetFields

func (l *Logger) SetFields(fields ...func(f Formatter, event *Event) bytes.BufferWriter)

func (*Logger) SetFormatter

func (l *Logger) SetFormatter(formatter Formatter)

func (*Logger) SetLevel

func (l *Logger) SetLevel(level Level)

func (*Logger) SetWriter

func (l *Logger) SetWriter(writer io.Writer)

func (*Logger) Warn

func (l *Logger) Warn(msg string, keyValues ...any)

type TextFormatter

type TextFormatter struct{}

func (*TextFormatter) FormatCaller

func (f *TextFormatter) FormatCaller(callerSkip int) bytes.BufferWriter

func (*TextFormatter) FormatLevel

func (f *TextFormatter) FormatLevel(level Level) bytes.BufferWriter

func (*TextFormatter) FormatMsg

func (f *TextFormatter) FormatMsg(msg string, keyValues ...any) bytes.BufferWriter

func (*TextFormatter) FormatTime

func (f *TextFormatter) FormatTime(t time.Time) bytes.BufferWriter

func (*TextFormatter) MsgSplit

func (f *TextFormatter) MsgSplit() string