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
- type 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) WarnFunc(callback func() string)
- func (l *Logger) Warnf(message string, args ...any)
Examples ¶
Constants ¶
View Source
const ( LevelAll = "all" LevelError = "error" LevelWarn = "warn" LevelInfo = "info" LevelDebug = "debug" LevelNone = "none" )
string level values.
View Source
const ( DriverStdout = "stdout" DriverFile = "file" DriverBuffer = "buffer" )
DriverStdout logging driver support builtin
Variables ¶
View Source
var DefaultConfig = Config{ Level: "warn", Driver: DriverStdout, }
Functions ¶
func ShortCover ¶ added in v1.1.2
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` `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
func CoverLevel ¶ added in v1.1.2
CoverLevel cover input string level into `Level` Deprecated: replace by the func `ToLevel`
type Logger ¶
type Logger struct {
Level Level
// contains filtered or unexported fields
}
func NewLogger ¶
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
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.