README
¶
Log
Usage
all the logger of a package should be registered in a registry, which is also a logger
package logutil
import (
"github.com/dyweb/gommon/log"
)
var Registry = log.NewLibraryLogger()
func NewPackageLogger() *log.Logger {
l := log.NewPackageLoggerWithSkip(1)
Registry.AddChild(l)
return l
}
var log = logutil.NewPackageLogger()
func foo() {
// structual way
log.DebugF("open", dlog.Fields{"file": file})
// default handler
// debug 20180204 open file=test.yml
// logfmtish handler
// lvl=debug t=20180204 msg=open file=test.yml
// json handler
// {"lvl": "debug", "t": "20180204", "msg": "open", "file": "test.yml"}
// traditional way
log.Debugf("open %s", file)
// debug 20180204 open test.yml
// a mixed way, this would lose hint from IDE for printf placeholders
log.DebugFf(dlog.Fields{"file": file}, "open with error %v", err)
// default handler
// for expensive operation, check before log
if log.IsDebugEnabled() {
log.Debug("counter". dlog.Fields{"counter": CountExpensive()})
}
}
Documentation
¶
Overview ¶
Code generated by gommon from log/gommon.yml DO NOT EDIT.
Code generated by gommon from log/logger_generated.go.tmpl DO NOT EDIT.
Package log is not usable yet, see legacy/log
Index ¶
- Constants
- Variables
- func NewTestHandler() *testHandler
- func PreOrderDFS(root *Logger, visited map[*Logger]bool, cb func(l *Logger))
- func SetHandlerRecursive(root *Logger, handler Handler)
- func SetLevelRecursive(root *Logger, level Level)
- func ToStringTree(root *Logger) *structure.StringTreeNode
- type Field
- type FieldType
- type Fields
- type Handler
- type Identity
- type Level
- type LoggableStruct
- type Logger
- func NewApplicationLogger() *Logger
- func NewFunctionLogger(packageLogger *Logger) *Logger
- func NewLibraryLogger() *Logger
- func NewMethodLogger(structLogger *Logger) *Logger
- func NewPackageLogger() *Logger
- func NewPackageLoggerWithSkip(skip int) *Logger
- func NewStructLogger(packageLogger *Logger, loggable LoggableStruct) *Logger
- func (l *Logger) AddChild(child *Logger)
- func (l *Logger) Debug(args ...interface{})
- func (l *Logger) DebugF(msg string, fields Fields)
- func (l *Logger) Debugf(format string, args ...interface{})
- func (l *Logger) DisableSource()
- func (l *Logger) EnableSource()
- func (l *Logger) Error(args ...interface{})
- func (l *Logger) ErrorF(msg string, fields Fields)
- func (l *Logger) Errorf(format string, args ...interface{})
- func (l *Logger) Fatal(args ...interface{})
- func (l *Logger) FatalF(msg string, fields Fields)
- func (l *Logger) Fatalf(format string, args ...interface{})
- func (l *Logger) Identity() *Identity
- func (l *Logger) Info(args ...interface{})
- func (l *Logger) InfoF(msg string, fields Fields)
- func (l *Logger) Infof(format string, args ...interface{})
- func (l *Logger) IsDebugEnabled() bool
- func (l *Logger) IsErrorEnabled() bool
- func (l *Logger) IsInfoEnabled() bool
- func (l *Logger) IsTraceEnabled() bool
- func (l *Logger) IsWarnEnabled() bool
- func (l *Logger) Level() Level
- func (l *Logger) Panic(args ...interface{})
- func (l *Logger) PanicF(msg string, fields Fields)
- func (l *Logger) Panicf(format string, args ...interface{})
- func (l *Logger) PrintTree()
- func (l *Logger) PrintTreeTo(w io.Writer)
- func (l *Logger) SetHandler(h Handler)
- func (l *Logger) SetLevel(level Level)
- func (l *Logger) Trace(args ...interface{})
- func (l *Logger) TraceF(msg string, fields Fields)
- func (l *Logger) Tracef(format string, args ...interface{})
- func (l *Logger) Warn(args ...interface{})
- func (l *Logger) WarnF(msg string, fields Fields)
- func (l *Logger) Warnf(format string, args ...interface{})
- type LoggerType
- type Syncer
Constants ¶
View Source
const MagicPackageLoggerFunctionName = "init"
View Source
const MagicStructLoggerFunctionName = "LoggerIdentity"
Variables ¶
View Source
var UnknownIdentity = Identity{Package: "unk", Type: UnknownLogger}
Functions ¶
func NewTestHandler ¶
func NewTestHandler() *testHandler
func PreOrderDFS ¶
TODO: test it .... map traverse order is random, we need radix tree, it is need for pretty print as well
func SetHandlerRecursive ¶
func SetLevelRecursive ¶
func ToStringTree ¶
func ToStringTree(root *Logger) *structure.StringTreeNode
Types ¶
type Handler ¶
type Handler interface {
HandleLog(level Level, time time.Time, msg string)
HandleLogWithSource(level Level, time time.Time, msg string, source string)
// TODO: pass pointer for fields?
HandleLogWithFields(level Level, time time.Time, msg string, fields Fields)
HandleLogWithSourceFields(level Level, time time.Time, msg string, source string, fields Fields)
Flush()
}
func DefaultHandler ¶
func DefaultHandler() Handler
func NewIOHandler ¶ added in v0.0.3
type Identity ¶
type Identity struct {
Package string
Function string
Struct string
File string
Line int
Type LoggerType
}
Identity is based where the logger is initialized, it is NOT exactly where the log happens. It is used for applying filter rules and print logger hierarchy. TODO: example
func NewIdentityFromCaller ¶
TODO: document all the black magic here ... https://github.com/dyweb/gommon/issues/32
func (*Identity) Diff ¶
TODO: this is used for print tree like structure ... it's hard to maintain exact parent and child logger due to cycle import
func (*Identity) SourceLocation ¶
type Level ¶
type Level uint8
Level is log level
const ( // FatalLevel log error and call `os.Exit(1)` // TODO: allow user hook exit? FatalLevel Level = iota // PanicLevel log error and call `panic` PanicLevel // ErrorLevel log error ErrorLevel // WarnLevel log warning WarnLevel // InfoLevel log info InfoLevel // DebugLevel log debug message, user should enable DebugLevel logging when report bug DebugLevel // TraceLevel is very verbose, user should enable it only on packages they are currently investing instead of globally TraceLevel )
func (Level) ColoredString ¶ added in v0.0.3
type LoggableStruct ¶
type Logger ¶
type Logger struct {
// contains filtered or unexported fields
}
func NewApplicationLogger ¶
func NewApplicationLogger() *Logger
func NewFunctionLogger ¶
func NewLibraryLogger ¶
func NewLibraryLogger() *Logger
func NewMethodLogger ¶
func NewPackageLogger ¶
func NewPackageLogger() *Logger
func NewStructLogger ¶
func NewStructLogger(packageLogger *Logger, loggable LoggableStruct) *Logger
func (*Logger) AddChild ¶
TODO: allow release a child logger, this will be a trouble if we created 1,000 Client struct with its own logger...
func (*Logger) DisableSource ¶ added in v0.0.3
func (l *Logger) DisableSource()
func (*Logger) EnableSource ¶ added in v0.0.3
func (l *Logger) EnableSource()
func (*Logger) IsDebugEnabled ¶
func (*Logger) IsErrorEnabled ¶
func (*Logger) IsInfoEnabled ¶
func (*Logger) IsTraceEnabled ¶
func (*Logger) IsWarnEnabled ¶
func (*Logger) PrintTreeTo ¶
func (*Logger) SetHandler ¶
type LoggerType ¶
type LoggerType uint8
const ( UnknownLogger LoggerType = iota ApplicationLogger LibraryLogger PackageLogger FunctionLogger StructLogger MethodLogger )
func (LoggerType) String ¶
func (tpe LoggerType) String() string
Source Files
¶
Directories
Click to show internal directories.
Click to hide internal directories.