| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187 |
- // Copyright (C) 2014 Jakob Borg. All rights reserved. Use of this source code
- // is governed by an MIT-style license that can be found in the LICENSE file.
- // Package logger implements a standardized logger with callback functionality
- package logger
- import (
- "fmt"
- "io/ioutil"
- "log"
- "os"
- "strings"
- "sync"
- )
- type LogLevel int
- const (
- LevelDebug LogLevel = iota
- LevelVerbose
- LevelInfo
- LevelOK
- LevelWarn
- LevelFatal
- NumLevels
- )
- // A MessageHandler is called with the log level and message text.
- type MessageHandler func(l LogLevel, msg string)
- type Logger struct {
- logger *log.Logger
- handlers [NumLevels][]MessageHandler
- mut sync.Mutex
- }
- // The default logger logs to standard output with a time prefix.
- var DefaultLogger = New()
- func New() *Logger {
- if os.Getenv("LOGGER_DISCARD") != "" {
- // Hack to completely disable logging, for example when running benchmarks.
- return &Logger{
- logger: log.New(ioutil.Discard, "", 0),
- }
- }
- return &Logger{
- logger: log.New(os.Stdout, "", log.Ltime),
- }
- }
- // AddHandler registers a new MessageHandler to receive messages with the
- // specified log level or above.
- func (l *Logger) AddHandler(level LogLevel, h MessageHandler) {
- l.mut.Lock()
- defer l.mut.Unlock()
- l.handlers[level] = append(l.handlers[level], h)
- }
- // See log.SetFlags
- func (l *Logger) SetFlags(flag int) {
- l.logger.SetFlags(flag)
- }
- // See log.SetPrefix
- func (l *Logger) SetPrefix(prefix string) {
- l.logger.SetPrefix(prefix)
- }
- func (l *Logger) callHandlers(level LogLevel, s string) {
- for _, h := range l.handlers[level] {
- h(level, strings.TrimSpace(s))
- }
- }
- // Debugln logs a line with a DEBUG prefix.
- func (l *Logger) Debugln(vals ...interface{}) {
- l.mut.Lock()
- defer l.mut.Unlock()
- s := fmt.Sprintln(vals...)
- l.logger.Output(2, "DEBUG: "+s)
- l.callHandlers(LevelDebug, s)
- }
- // Debugf logs a formatted line with a DEBUG prefix.
- func (l *Logger) Debugf(format string, vals ...interface{}) {
- l.mut.Lock()
- defer l.mut.Unlock()
- s := fmt.Sprintf(format, vals...)
- l.logger.Output(2, "DEBUG: "+s)
- l.callHandlers(LevelDebug, s)
- }
- // Infoln logs a line with a VERBOSE prefix.
- func (l *Logger) Verboseln(vals ...interface{}) {
- l.mut.Lock()
- defer l.mut.Unlock()
- s := fmt.Sprintln(vals...)
- l.logger.Output(2, "VERBOSE: "+s)
- l.callHandlers(LevelVerbose, s)
- }
- // Infof logs a formatted line with a VERBOSE prefix.
- func (l *Logger) Verbosef(format string, vals ...interface{}) {
- l.mut.Lock()
- defer l.mut.Unlock()
- s := fmt.Sprintf(format, vals...)
- l.logger.Output(2, "VERBOSE: "+s)
- l.callHandlers(LevelVerbose, s)
- }
- // Infoln logs a line with an INFO prefix.
- func (l *Logger) Infoln(vals ...interface{}) {
- l.mut.Lock()
- defer l.mut.Unlock()
- s := fmt.Sprintln(vals...)
- l.logger.Output(2, "INFO: "+s)
- l.callHandlers(LevelInfo, s)
- }
- // Infof logs a formatted line with an INFO prefix.
- func (l *Logger) Infof(format string, vals ...interface{}) {
- l.mut.Lock()
- defer l.mut.Unlock()
- s := fmt.Sprintf(format, vals...)
- l.logger.Output(2, "INFO: "+s)
- l.callHandlers(LevelInfo, s)
- }
- // Okln logs a line with an OK prefix.
- func (l *Logger) Okln(vals ...interface{}) {
- l.mut.Lock()
- defer l.mut.Unlock()
- s := fmt.Sprintln(vals...)
- l.logger.Output(2, "OK: "+s)
- l.callHandlers(LevelOK, s)
- }
- // Okf logs a formatted line with an OK prefix.
- func (l *Logger) Okf(format string, vals ...interface{}) {
- l.mut.Lock()
- defer l.mut.Unlock()
- s := fmt.Sprintf(format, vals...)
- l.logger.Output(2, "OK: "+s)
- l.callHandlers(LevelOK, s)
- }
- // Warnln logs a formatted line with a WARNING prefix.
- func (l *Logger) Warnln(vals ...interface{}) {
- l.mut.Lock()
- defer l.mut.Unlock()
- s := fmt.Sprintln(vals...)
- l.logger.Output(2, "WARNING: "+s)
- l.callHandlers(LevelWarn, s)
- }
- // Warnf logs a formatted line with a WARNING prefix.
- func (l *Logger) Warnf(format string, vals ...interface{}) {
- l.mut.Lock()
- defer l.mut.Unlock()
- s := fmt.Sprintf(format, vals...)
- l.logger.Output(2, "WARNING: "+s)
- l.callHandlers(LevelWarn, s)
- }
- // Fatalln logs a line with a FATAL prefix and exits the process with exit
- // code 1.
- func (l *Logger) Fatalln(vals ...interface{}) {
- l.mut.Lock()
- defer l.mut.Unlock()
- s := fmt.Sprintln(vals...)
- l.logger.Output(2, "FATAL: "+s)
- l.callHandlers(LevelFatal, s)
- os.Exit(1)
- }
- // Fatalf logs a formatted line with a FATAL prefix and exits the process with
- // exit code 1.
- func (l *Logger) Fatalf(format string, vals ...interface{}) {
- l.mut.Lock()
- defer l.mut.Unlock()
- s := fmt.Sprintf(format, vals...)
- l.logger.Output(2, "FATAL: "+s)
- l.callHandlers(LevelFatal, s)
- os.Exit(1)
- }
|