|
@@ -35,10 +35,12 @@ package logs
|
|
|
|
|
|
import (
|
|
|
"fmt"
|
|
|
+ "log"
|
|
|
"os"
|
|
|
"path"
|
|
|
"runtime"
|
|
|
"strconv"
|
|
|
+ "strings"
|
|
|
"sync"
|
|
|
"time"
|
|
|
)
|
|
@@ -55,16 +57,28 @@ const (
|
|
|
LevelDebug
|
|
|
)
|
|
|
|
|
|
-// Legacy loglevel constants to ensure backwards compatibility.
|
|
|
-//
|
|
|
-// Deprecated: will be removed in 1.5.0.
|
|
|
+// levelLogLogger is defined to implement log.Logger
|
|
|
+// the real log level will be LevelEmergency
|
|
|
+const levelLoggerImpl = -1
|
|
|
+
|
|
|
+// Name for adapter with beego official support
|
|
|
+const (
|
|
|
+ AdapterConsole = "console"
|
|
|
+ AdapterFile = "file"
|
|
|
+ AdapterMultiFile = "multifile"
|
|
|
+ AdapterMail = "stmp"
|
|
|
+ AdapterConn = "conn"
|
|
|
+ AdapterEs = "es"
|
|
|
+)
|
|
|
+
|
|
|
+// Legacy log level constants to ensure backwards compatibility.
|
|
|
const (
|
|
|
LevelInfo = LevelInformational
|
|
|
LevelTrace = LevelDebug
|
|
|
LevelWarn = LevelWarning
|
|
|
)
|
|
|
|
|
|
-type loggerType func() Logger
|
|
|
+type newLoggerFunc func() Logger
|
|
|
|
|
|
// Logger defines the behavior of a log provider.
|
|
|
type Logger interface {
|
|
@@ -74,12 +88,13 @@ type Logger interface {
|
|
|
Flush()
|
|
|
}
|
|
|
|
|
|
-var adapters = make(map[string]loggerType)
|
|
|
+var adapters = make(map[string]newLoggerFunc)
|
|
|
+var levelPrefix = [LevelDebug + 1]string{"[M] ", "[A] ", "[C] ", "[E] ", "[W] ", "[N] ", "[I] ", "[D] "}
|
|
|
|
|
|
// Register makes a log provide available by the provided name.
|
|
|
// If Register is called twice with the same name or if driver is nil,
|
|
|
// it panics.
|
|
|
-func Register(name string, log loggerType) {
|
|
|
+func Register(name string, log newLoggerFunc) {
|
|
|
if log == nil {
|
|
|
panic("logs: Register provide is nil")
|
|
|
}
|
|
@@ -94,15 +109,19 @@ func Register(name string, log loggerType) {
|
|
|
type BeeLogger struct {
|
|
|
lock sync.Mutex
|
|
|
level int
|
|
|
+ init bool
|
|
|
enableFuncCallDepth bool
|
|
|
loggerFuncCallDepth int
|
|
|
asynchronous bool
|
|
|
+ msgChanLen int64
|
|
|
msgChan chan *logMsg
|
|
|
signalChan chan string
|
|
|
wg sync.WaitGroup
|
|
|
outputs []*nameLogger
|
|
|
}
|
|
|
|
|
|
+const defaultAsyncMsgLen = 1e3
|
|
|
+
|
|
|
type nameLogger struct {
|
|
|
Logger
|
|
|
name string
|
|
@@ -119,18 +138,31 @@ var logMsgPool *sync.Pool
|
|
|
// NewLogger returns a new BeeLogger.
|
|
|
// channelLen means the number of messages in chan(used where asynchronous is true).
|
|
|
// if the buffering chan is full, logger adapters write to file or other way.
|
|
|
-func NewLogger(channelLen int64) *BeeLogger {
|
|
|
+func NewLogger(channelLens ...int64) *BeeLogger {
|
|
|
bl := new(BeeLogger)
|
|
|
bl.level = LevelDebug
|
|
|
bl.loggerFuncCallDepth = 2
|
|
|
- bl.msgChan = make(chan *logMsg, channelLen)
|
|
|
+ bl.msgChanLen = append(channelLens, 0)[0]
|
|
|
+ if bl.msgChanLen <= 0 {
|
|
|
+ bl.msgChanLen = defaultAsyncMsgLen
|
|
|
+ }
|
|
|
bl.signalChan = make(chan string, 1)
|
|
|
+ bl.setLogger(AdapterConsole)
|
|
|
return bl
|
|
|
}
|
|
|
|
|
|
// Async set the log to asynchronous and start the goroutine
|
|
|
-func (bl *BeeLogger) Async() *BeeLogger {
|
|
|
+func (bl *BeeLogger) Async(msgLen ...int64) *BeeLogger {
|
|
|
+ bl.lock.Lock()
|
|
|
+ defer bl.lock.Unlock()
|
|
|
+ if bl.asynchronous {
|
|
|
+ return bl
|
|
|
+ }
|
|
|
bl.asynchronous = true
|
|
|
+ if len(msgLen) > 0 && msgLen[0] > 0 {
|
|
|
+ bl.msgChanLen = msgLen[0]
|
|
|
+ }
|
|
|
+ bl.msgChan = make(chan *logMsg, bl.msgChanLen)
|
|
|
logMsgPool = &sync.Pool{
|
|
|
New: func() interface{} {
|
|
|
return &logMsg{}
|
|
@@ -143,10 +175,8 @@ func (bl *BeeLogger) Async() *BeeLogger {
|
|
|
|
|
|
// SetLogger provides a given logger adapter into BeeLogger with config string.
|
|
|
// config need to be correct JSON as string: {"interval":360}.
|
|
|
-func (bl *BeeLogger) SetLogger(adapterName string, config string) error {
|
|
|
- bl.lock.Lock()
|
|
|
- defer bl.lock.Unlock()
|
|
|
-
|
|
|
+func (bl *BeeLogger) setLogger(adapterName string, configs ...string) error {
|
|
|
+ config := append(configs, "{}")[0]
|
|
|
for _, l := range bl.outputs {
|
|
|
if l.name == adapterName {
|
|
|
return fmt.Errorf("logs: duplicate adaptername %q (you have set this logger before)", adapterName)
|
|
@@ -168,6 +198,18 @@ func (bl *BeeLogger) SetLogger(adapterName string, config string) error {
|
|
|
return nil
|
|
|
}
|
|
|
|
|
|
+// SetLogger provides a given logger adapter into BeeLogger with config string.
|
|
|
+// config need to be correct JSON as string: {"interval":360}.
|
|
|
+func (bl *BeeLogger) SetLogger(adapterName string, configs ...string) error {
|
|
|
+ bl.lock.Lock()
|
|
|
+ defer bl.lock.Unlock()
|
|
|
+ if !bl.init {
|
|
|
+ bl.outputs = []*nameLogger{}
|
|
|
+ bl.init = true
|
|
|
+ }
|
|
|
+ return bl.setLogger(adapterName, configs...)
|
|
|
+}
|
|
|
+
|
|
|
// DelLogger remove a logger adapter in BeeLogger.
|
|
|
func (bl *BeeLogger) DelLogger(adapterName string) error {
|
|
|
bl.lock.Lock()
|
|
@@ -196,7 +238,37 @@ func (bl *BeeLogger) writeToLoggers(when time.Time, msg string, level int) {
|
|
|
}
|
|
|
}
|
|
|
|
|
|
-func (bl *BeeLogger) writeMsg(logLevel int, msg string) error {
|
|
|
+func (bl *BeeLogger) Write(p []byte) (n int, err error) {
|
|
|
+ if len(p) == 0 {
|
|
|
+ return 0, nil
|
|
|
+ }
|
|
|
+ // writeMsg will always add a '\n' character
|
|
|
+ if p[len(p)-1] == '\n' {
|
|
|
+ p = p[0 : len(p)-1]
|
|
|
+ }
|
|
|
+ // set levelLoggerImpl to ensure all log message will be write out
|
|
|
+ err = bl.writeMsg(levelLoggerImpl, string(p))
|
|
|
+ if err == nil {
|
|
|
+ return len(p), err
|
|
|
+ }
|
|
|
+ return 0, err
|
|
|
+}
|
|
|
+
|
|
|
+func (bl *BeeLogger) writeMsg(logLevel int, msg string, v ...interface{}) error {
|
|
|
+ if !bl.init {
|
|
|
+ bl.lock.Lock()
|
|
|
+ bl.setLogger(AdapterConsole)
|
|
|
+ bl.lock.Unlock()
|
|
|
+ }
|
|
|
+ if logLevel == levelLoggerImpl {
|
|
|
+ // set to emergency to ensure all log will be print out correctly
|
|
|
+ logLevel = LevelEmergency
|
|
|
+ } else {
|
|
|
+ msg = levelPrefix[logLevel] + msg
|
|
|
+ }
|
|
|
+ if len(v) > 0 {
|
|
|
+ msg = fmt.Sprintf(msg, v...)
|
|
|
+ }
|
|
|
when := time.Now()
|
|
|
if bl.enableFuncCallDepth {
|
|
|
_, file, line, ok := runtime.Caller(bl.loggerFuncCallDepth)
|
|
@@ -205,7 +277,7 @@ func (bl *BeeLogger) writeMsg(logLevel int, msg string) error {
|
|
|
line = 0
|
|
|
}
|
|
|
_, filename := path.Split(file)
|
|
|
- msg = "[" + filename + ":" + strconv.FormatInt(int64(line), 10) + "]" + msg
|
|
|
+ msg = "[" + filename + ":" + strconv.FormatInt(int64(line), 10) + "] " + msg
|
|
|
}
|
|
|
if bl.asynchronous {
|
|
|
lm := logMsgPool.Get().(*logMsg)
|
|
@@ -273,8 +345,7 @@ func (bl *BeeLogger) Emergency(format string, v ...interface{}) {
|
|
|
if LevelEmergency > bl.level {
|
|
|
return
|
|
|
}
|
|
|
- msg := fmt.Sprintf("[M] "+format, v...)
|
|
|
- bl.writeMsg(LevelEmergency, msg)
|
|
|
+ bl.writeMsg(LevelEmergency, format, v...)
|
|
|
}
|
|
|
|
|
|
// Alert Log ALERT level message.
|
|
@@ -282,8 +353,7 @@ func (bl *BeeLogger) Alert(format string, v ...interface{}) {
|
|
|
if LevelAlert > bl.level {
|
|
|
return
|
|
|
}
|
|
|
- msg := fmt.Sprintf("[A] "+format, v...)
|
|
|
- bl.writeMsg(LevelAlert, msg)
|
|
|
+ bl.writeMsg(LevelAlert, format, v...)
|
|
|
}
|
|
|
|
|
|
// Critical Log CRITICAL level message.
|
|
@@ -291,8 +361,7 @@ func (bl *BeeLogger) Critical(format string, v ...interface{}) {
|
|
|
if LevelCritical > bl.level {
|
|
|
return
|
|
|
}
|
|
|
- msg := fmt.Sprintf("[C] "+format, v...)
|
|
|
- bl.writeMsg(LevelCritical, msg)
|
|
|
+ bl.writeMsg(LevelCritical, format, v...)
|
|
|
}
|
|
|
|
|
|
// Error Log ERROR level message.
|
|
@@ -300,17 +369,12 @@ func (bl *BeeLogger) Error(format string, v ...interface{}) {
|
|
|
if LevelError > bl.level {
|
|
|
return
|
|
|
}
|
|
|
- msg := fmt.Sprintf("[E] "+format, v...)
|
|
|
- bl.writeMsg(LevelError, msg)
|
|
|
+ bl.writeMsg(LevelError, format, v...)
|
|
|
}
|
|
|
|
|
|
// Warning Log WARNING level message.
|
|
|
func (bl *BeeLogger) Warning(format string, v ...interface{}) {
|
|
|
- if LevelWarning > bl.level {
|
|
|
- return
|
|
|
- }
|
|
|
- msg := fmt.Sprintf("[W] "+format, v...)
|
|
|
- bl.writeMsg(LevelWarning, msg)
|
|
|
+ bl.Warn(format, v...)
|
|
|
}
|
|
|
|
|
|
// Notice Log NOTICE level message.
|
|
@@ -318,17 +382,12 @@ func (bl *BeeLogger) Notice(format string, v ...interface{}) {
|
|
|
if LevelNotice > bl.level {
|
|
|
return
|
|
|
}
|
|
|
- msg := fmt.Sprintf("[N] "+format, v...)
|
|
|
- bl.writeMsg(LevelNotice, msg)
|
|
|
+ bl.writeMsg(LevelNotice, format, v...)
|
|
|
}
|
|
|
|
|
|
// Informational Log INFORMATIONAL level message.
|
|
|
func (bl *BeeLogger) Informational(format string, v ...interface{}) {
|
|
|
- if LevelInformational > bl.level {
|
|
|
- return
|
|
|
- }
|
|
|
- msg := fmt.Sprintf("[I] "+format, v...)
|
|
|
- bl.writeMsg(LevelInformational, msg)
|
|
|
+ bl.Info(format, v...)
|
|
|
}
|
|
|
|
|
|
// Debug Log DEBUG level message.
|
|
@@ -336,38 +395,31 @@ func (bl *BeeLogger) Debug(format string, v ...interface{}) {
|
|
|
if LevelDebug > bl.level {
|
|
|
return
|
|
|
}
|
|
|
- msg := fmt.Sprintf("[D] "+format, v...)
|
|
|
- bl.writeMsg(LevelDebug, msg)
|
|
|
+ bl.writeMsg(LevelDebug, format, v...)
|
|
|
}
|
|
|
|
|
|
// Warn Log WARN level message.
|
|
|
// compatibility alias for Warning()
|
|
|
func (bl *BeeLogger) Warn(format string, v ...interface{}) {
|
|
|
- if LevelWarning > bl.level {
|
|
|
+ if LevelWarn > bl.level {
|
|
|
return
|
|
|
}
|
|
|
- msg := fmt.Sprintf("[W] "+format, v...)
|
|
|
- bl.writeMsg(LevelWarning, msg)
|
|
|
+ bl.writeMsg(LevelWarn, format, v...)
|
|
|
}
|
|
|
|
|
|
// Info Log INFO level message.
|
|
|
// compatibility alias for Informational()
|
|
|
func (bl *BeeLogger) Info(format string, v ...interface{}) {
|
|
|
- if LevelInformational > bl.level {
|
|
|
+ if LevelInfo > bl.level {
|
|
|
return
|
|
|
}
|
|
|
- msg := fmt.Sprintf("[I] "+format, v...)
|
|
|
- bl.writeMsg(LevelInformational, msg)
|
|
|
+ bl.writeMsg(LevelInfo, format, v...)
|
|
|
}
|
|
|
|
|
|
// Trace Log TRACE level message.
|
|
|
// compatibility alias for Debug()
|
|
|
func (bl *BeeLogger) Trace(format string, v ...interface{}) {
|
|
|
- if LevelDebug > bl.level {
|
|
|
- return
|
|
|
- }
|
|
|
- msg := fmt.Sprintf("[D] "+format, v...)
|
|
|
- bl.writeMsg(LevelDebug, msg)
|
|
|
+ bl.Debug(format, v...)
|
|
|
}
|
|
|
|
|
|
// Flush flush all chan data.
|
|
@@ -386,6 +438,7 @@ func (bl *BeeLogger) Close() {
|
|
|
if bl.asynchronous {
|
|
|
bl.signalChan <- "close"
|
|
|
bl.wg.Wait()
|
|
|
+ close(bl.msgChan)
|
|
|
} else {
|
|
|
bl.flush()
|
|
|
for _, l := range bl.outputs {
|
|
@@ -393,7 +446,6 @@ func (bl *BeeLogger) Close() {
|
|
|
}
|
|
|
bl.outputs = nil
|
|
|
}
|
|
|
- close(bl.msgChan)
|
|
|
close(bl.signalChan)
|
|
|
}
|
|
|
|
|
@@ -407,16 +459,175 @@ func (bl *BeeLogger) Reset() {
|
|
|
}
|
|
|
|
|
|
func (bl *BeeLogger) flush() {
|
|
|
- for {
|
|
|
- if len(bl.msgChan) > 0 {
|
|
|
- bm := <-bl.msgChan
|
|
|
- bl.writeToLoggers(bm.when, bm.msg, bm.level)
|
|
|
- logMsgPool.Put(bm)
|
|
|
- continue
|
|
|
+ if bl.asynchronous {
|
|
|
+ for {
|
|
|
+ if len(bl.msgChan) > 0 {
|
|
|
+ bm := <-bl.msgChan
|
|
|
+ bl.writeToLoggers(bm.when, bm.msg, bm.level)
|
|
|
+ logMsgPool.Put(bm)
|
|
|
+ continue
|
|
|
+ }
|
|
|
+ break
|
|
|
}
|
|
|
- break
|
|
|
}
|
|
|
for _, l := range bl.outputs {
|
|
|
l.Flush()
|
|
|
}
|
|
|
}
|
|
|
+
|
|
|
+// beeLogger references the used application logger.
|
|
|
+var beeLogger *BeeLogger = NewLogger()
|
|
|
+
|
|
|
+// GetLogger returns the default BeeLogger
|
|
|
+func GetBeeLogger() *BeeLogger {
|
|
|
+ return beeLogger
|
|
|
+}
|
|
|
+
|
|
|
+var beeLoggerMap = struct {
|
|
|
+ sync.RWMutex
|
|
|
+ logs map[string]*log.Logger
|
|
|
+}{
|
|
|
+ logs: map[string]*log.Logger{},
|
|
|
+}
|
|
|
+
|
|
|
+// GetLogger returns the default BeeLogger
|
|
|
+func GetLogger(prefixes ...string) *log.Logger {
|
|
|
+ prefix := append(prefixes, "")[0]
|
|
|
+ if prefix != "" {
|
|
|
+ prefix = fmt.Sprintf(`[%s] `, strings.ToUpper(prefix))
|
|
|
+ }
|
|
|
+ beeLoggerMap.RLock()
|
|
|
+ l, ok := beeLoggerMap.logs[prefix]
|
|
|
+ if ok {
|
|
|
+ beeLoggerMap.RUnlock()
|
|
|
+ return l
|
|
|
+ }
|
|
|
+ beeLoggerMap.RUnlock()
|
|
|
+ beeLoggerMap.Lock()
|
|
|
+ defer beeLoggerMap.Unlock()
|
|
|
+ l, ok = beeLoggerMap.logs[prefix]
|
|
|
+ if !ok {
|
|
|
+ l = log.New(beeLogger, prefix, 0)
|
|
|
+ beeLoggerMap.logs[prefix] = l
|
|
|
+ }
|
|
|
+ return l
|
|
|
+}
|
|
|
+
|
|
|
+// Reset will remove all the adapter
|
|
|
+func Reset() {
|
|
|
+ beeLogger.Reset()
|
|
|
+}
|
|
|
+
|
|
|
+func Async(msgLen ...int64) *BeeLogger {
|
|
|
+ return beeLogger.Async(msgLen...)
|
|
|
+}
|
|
|
+
|
|
|
+// SetLevel sets the global log level used by the simple logger.
|
|
|
+func SetLevel(l int) {
|
|
|
+ beeLogger.SetLevel(l)
|
|
|
+}
|
|
|
+
|
|
|
+// EnableFuncCallDepth enable log funcCallDepth
|
|
|
+func EnableFuncCallDepth(b bool) {
|
|
|
+ beeLogger.enableFuncCallDepth = b
|
|
|
+}
|
|
|
+
|
|
|
+// SetLogFuncCall set the CallDepth, default is 3
|
|
|
+func SetLogFuncCall(b bool) {
|
|
|
+ beeLogger.EnableFuncCallDepth(b)
|
|
|
+ beeLogger.SetLogFuncCallDepth(3)
|
|
|
+}
|
|
|
+
|
|
|
+// SetLogFuncCallDepth set log funcCallDepth
|
|
|
+func SetLogFuncCallDepth(d int) {
|
|
|
+ beeLogger.loggerFuncCallDepth = d
|
|
|
+}
|
|
|
+
|
|
|
+// SetLogger sets a new logger.
|
|
|
+func SetLogger(adapter string, config ...string) error {
|
|
|
+ err := beeLogger.SetLogger(adapter, config...)
|
|
|
+ if err != nil {
|
|
|
+ return err
|
|
|
+ }
|
|
|
+ return nil
|
|
|
+}
|
|
|
+
|
|
|
+// Emergency logs a message at emergency level.
|
|
|
+func Emergency(f interface{}, v ...interface{}) {
|
|
|
+ beeLogger.Emergency(formatLog(f, v...))
|
|
|
+}
|
|
|
+
|
|
|
+// Alert logs a message at alert level.
|
|
|
+func Alert(f interface{}, v ...interface{}) {
|
|
|
+ beeLogger.Alert(formatLog(f, v...))
|
|
|
+}
|
|
|
+
|
|
|
+// Critical logs a message at critical level.
|
|
|
+func Critical(f interface{}, v ...interface{}) {
|
|
|
+ beeLogger.Critical(formatLog(f, v...))
|
|
|
+}
|
|
|
+
|
|
|
+// Error logs a message at error level.
|
|
|
+func Error(f interface{}, v ...interface{}) {
|
|
|
+ beeLogger.Error(formatLog(f, v...))
|
|
|
+}
|
|
|
+
|
|
|
+// Warning logs a message at warning level.
|
|
|
+func Warning(f interface{}, v ...interface{}) {
|
|
|
+ beeLogger.Warn(formatLog(f, v...))
|
|
|
+}
|
|
|
+
|
|
|
+// Warn compatibility alias for Warning()
|
|
|
+func Warn(f interface{}, v ...interface{}) {
|
|
|
+ beeLogger.Warn(formatLog(f, v...))
|
|
|
+}
|
|
|
+
|
|
|
+// Notice logs a message at notice level.
|
|
|
+func Notice(f interface{}, v ...interface{}) {
|
|
|
+ beeLogger.Notice(formatLog(f, v...))
|
|
|
+}
|
|
|
+
|
|
|
+// Informational logs a message at info level.
|
|
|
+func Informational(f interface{}, v ...interface{}) {
|
|
|
+ beeLogger.Info(formatLog(f, v...))
|
|
|
+}
|
|
|
+
|
|
|
+// Info compatibility alias for Warning()
|
|
|
+func Info(f interface{}, v ...interface{}) {
|
|
|
+ beeLogger.Info(formatLog(f, v...))
|
|
|
+}
|
|
|
+
|
|
|
+// Debug logs a message at debug level.
|
|
|
+func Debug(f interface{}, v ...interface{}) {
|
|
|
+ beeLogger.Debug(formatLog(f, v...))
|
|
|
+}
|
|
|
+
|
|
|
+// Trace logs a message at trace level.
|
|
|
+// compatibility alias for Warning()
|
|
|
+func Trace(f interface{}, v ...interface{}) {
|
|
|
+ beeLogger.Trace(formatLog(f, v...))
|
|
|
+}
|
|
|
+
|
|
|
+func formatLog(f interface{}, v ...interface{}) string {
|
|
|
+ var msg string
|
|
|
+ switch f.(type) {
|
|
|
+ case string:
|
|
|
+ msg = f.(string)
|
|
|
+ if len(v) == 0 {
|
|
|
+ return msg
|
|
|
+ }
|
|
|
+ if strings.Contains(msg, "%") && !strings.Contains(msg, "%%") {
|
|
|
+ //format string
|
|
|
+ } else {
|
|
|
+ //do not contain format char
|
|
|
+ msg += strings.Repeat(" %v", len(v))
|
|
|
+ }
|
|
|
+ default:
|
|
|
+ msg = fmt.Sprint(f)
|
|
|
+ if len(v) == 0 {
|
|
|
+ return msg
|
|
|
+ }
|
|
|
+ msg += strings.Repeat(" %v", len(v))
|
|
|
+ }
|
|
|
+ return fmt.Sprintf(msg, v...)
|
|
|
+}
|