xlog

Documentation

Index

• type FileHandler
  • func NewFileHandler(path string) *FileHandler
  • func (h *FileHandler) HandleRecord(r string) error
• type Formatter
  • func BasicFormatter() *Formatter
  • func CustomMsgFormatter(recFmt string) *Formatter
  • func CustomTimeFormatter(tsFmt string) *Formatter
  • func JsonFormatter() *Formatter
  • func RawFormatter() *Formatter
  • func SimpleFormatter() *Formatter
  • func StdFormatter() *Formatter
  • func (f *Formatter) Emit(lvl Level, src string, msg string, args ...any) string
• type Handler
• type Level
  • func (l Level) String() string
• type Logger
  • func NewFileLogger(name, path string) *Logger
  • func NewLogger(name string) *Logger
  • func NewStdoutLogger(name string) *Logger
  • func (l *Logger) AddHandler(h Handler)
  • func (l *Logger) ChildLogger(name string) *Logger
  • func (l *Logger) ClearHandlers()
  • func (l *Logger) Debug(msg string, args ...any) error
  • func (l *Logger) Error(msg string, args ...any) error
  • func (l *Logger) Fatal(msg string, args ...any) error
  • func (l *Logger) Info(msg string, args ...any) error
  • func (l *Logger) Panic(msg string, args ...any) error
  • func (l *Logger) SetFormatter(f *Formatter)
  • func (l *Logger) Trace1(msg string, args ...any) error
  • func (l *Logger) Trace2(msg string, args ...any) error
  • func (l *Logger) Trace3(msg string, args ...any) error
  • func (l *Logger) Trace4(msg string, args ...any) error
  • func (l *Logger) Warn(msg string, args ...any) error
• type StdoutHandler
  • func NewStdoutHandler() *StdoutHandler
  • func (h *StdoutHandler) HandleRecord(r string) error

Types

type FileHandler

type FileHandler struct {
	FilePath string
}

Write log messages to file

func NewFileHandler

func NewFileHandler(path string) *FileHandler

func (*FileHandler) HandleRecord

func (h *FileHandler) HandleRecord(r string) error

type Formatter

type Formatter struct {
	RecordFormat string
	TimeFormat   string
	EscapeMsg    bool
}

func BasicFormatter

func BasicFormatter() *Formatter

basic text formatted log record, just timestamp and message

func CustomMsgFormatter

func CustomMsgFormatter(recFmt string) *Formatter

customized message text formatter

func CustomTimeFormatter

func CustomTimeFormatter(tsFmt string) *Formatter

customized timestamp text formatter

func JsonFormatter

func JsonFormatter() *Formatter

standard json formatted log record

func RawFormatter

func RawFormatter() *Formatter

raw text formatted log record, just the message

func SimpleFormatter

func SimpleFormatter() *Formatter

simple text formatted log record, without source

func StdFormatter

func StdFormatter() *Formatter

standard text formatted log record

func (*Formatter) Emit

func (f *Formatter) Emit(
	lvl Level, src string, msg string, args ...any) string

generate new formatted log record

type Handler

type Handler interface {
	HandleRecord(string) error
}

type Level

type Level int

const (
	TRACE4 Level = -50
	TRACE3 Level = -40
	TRACE2 Level = -30
	TRACE1 Level = -20
	DEBUG  Level = -10
	INFO   Level = 0
	WARN   Level = 10
	ERROR  Level = 20
	FATAL  Level = 30
	PANIC  Level = 40
)

logging levels

func (Level) String

func (l Level) String() string

Stringer interface, returns string of log level

type Logger

type Logger struct {
	Name  string
	Level Level
	// contains filtered or unexported fields
}

func NewFileLogger

func NewFileLogger(name, path string) *Logger

func NewLogger

func NewLogger(name string) *Logger

func NewStdoutLogger

func NewStdoutLogger(name string) *Logger

func (*Logger) AddHandler

func (l *Logger) AddHandler(h Handler)

func (*Logger) ChildLogger

func (l *Logger) ChildLogger(name string) *Logger

func (*Logger) ClearHandlers

func (l *Logger) ClearHandlers()

func (*Logger) Debug

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

func (*Logger) Error

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

func (*Logger) Fatal

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

func (*Logger) Info

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

func (*Logger) Panic

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

func (*Logger) SetFormatter

func (l *Logger) SetFormatter(f *Formatter)

func (*Logger) Trace1

func (l *Logger) Trace1(msg string, args ...any) error

func (*Logger) Trace2

func (l *Logger) Trace2(msg string, args ...any) error

func (*Logger) Trace3

func (l *Logger) Trace3(msg string, args ...any) error

func (*Logger) Trace4

func (l *Logger) Trace4(msg string, args ...any) error

func (*Logger) Warn

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

type StdoutHandler

type StdoutHandler struct {
}

Write log messages to Stdout

func NewStdoutHandler

func NewStdoutHandler() *StdoutHandler

func (*StdoutHandler) HandleRecord

func (h *StdoutHandler) HandleRecord(r string) error