logger

Documentation

Overview

Package logger basic and simple logger for application, it base the go embed `log` package. it's able to control output by log level, level order `all<debug<info<warn<error<none`.

Index

• Constants
• Variables
• func Prefix(level Level) string
• func ShortCover(short string) (lvlStr string)
• type Config
• type Level
  • func CoverLevel(lvl string, defLevel Level) Level
  • func ToLevel(lvl string, args ...Level) (Level, error)
• type Logger
  • func NewLogger(cfgs ...Config) *Logger
  • func (l *Logger) Buffer() *bytes.Buffer
  • func (l *Logger) DebugFunc(callback func() string)
  • func (l *Logger) Debugf(message string, args ...any)
  • func (l *Logger) ErrorFunc(callback func() string)
  • func (l *Logger) Errorf(message string, args ...any)
  • func (l *Logger) Format(prefix, message string, args ...any)
  • func (l *Logger) InfoFunc(callback func() string)
  • func (l *Logger) Infof(message string, args ...any)
  • func (l *Logger) Log() *log.Logger
  • func (l *Logger) Tracef(message string, args ...any)
  • func (l *Logger) WarnFunc(callback func() string)
  • func (l *Logger) Warnf(message string, args ...any)

Examples

• NewLogger

Constants

const (
	LevelAll   = "all"
	LevelError = "error"
	LevelWarn  = "warn"
	LevelInfo  = "info"
	LevelDebug = "debug"
	LevelTrace = "trace"
	LevelNone  = "none"
)

string level values.

const (
	DriverStdout = "stdout"
	DriverFile   = "file"
	DriverBuffer = "buffer"
)

DriverStdout logging driver support builtin

Variables

var DefaultConfig = Config{
	Level:  "warn",
	Driver: DriverStdout,
}

Functions

func Prefix

func Prefix(level Level) string

func ShortCover

func ShortCover(short string) (lvlStr string)

ShortCover short level string cover to matched level string. rule:

`a/A -> all`
`e/E -> error`
`w/W -> warning`
`i/I -> info`
`d/D -> debug`
`t/T -> trace`
`n/N -> none`

Types

type Config

type Config struct {
	Log   *log.Logger `yaml:"-" json:"-"`
	Level string
	// driver list: stdout, file, buffer
	Driver string
	// when Driver is file it will be work
	OutputDir string
}

Config builder logging configure.

type Level

type Level int8

const (
	LogAll Level = iota
	LogTrace
	LogDebug
	LogInfo
	LogWarn
	LogError
	LogNone
)

logging Level constant

func CoverLevel

func CoverLevel(lvl string, defLevel Level) Level

CoverLevel cover input string level into `Level` Deprecated: replace by the func `ToLevel`

func ToLevel

func ToLevel(lvl string, args ...Level) (Level, error)

ToLevel turn string to level

type Logger

type Logger struct {
	Level Level

	DisableColor bool
	// contains filtered or unexported fields
}

func NewLogger

func NewLogger(cfgs ...Config) *Logger

NewLogger build a simple logger user it.

Example

lg := NewLogger(Config{Level: "error"})
lg.Debugf("it's a debug level message")
lg.Warnf("it's a warn level message")
lg.Errorf("it's a error level message")

Output:

10:19:38 [ERROR] it's a error level message

func (*Logger) Buffer

func (l *Logger) Buffer() *bytes.Buffer

func (*Logger) DebugFunc

func (l *Logger) DebugFunc(callback func() string)

func (*Logger) Debugf

func (l *Logger) Debugf(message string, args ...any)

func (*Logger) ErrorFunc

func (l *Logger) ErrorFunc(callback func() string)

func (*Logger) Errorf

func (l *Logger) Errorf(message string, args ...any)

func (*Logger) Format

func (l *Logger) Format(prefix, message string, args ...any)

func (*Logger) InfoFunc

func (l *Logger) InfoFunc(callback func() string)

func (*Logger) Infof

func (l *Logger) Infof(message string, args ...any)

func (*Logger) Log

func (l *Logger) Log() *log.Logger

Log get embed go lib log when you need the instance.

func (*Logger) Tracef

func (l *Logger) Tracef(message string, args ...any)

func (*Logger) WarnFunc

func (l *Logger) WarnFunc(callback func() string)

func (*Logger) Warnf

func (l *Logger) Warnf(message string, args ...any)