xlog package - github.com/xfxdev/xlog - Go Packages (original) (raw)

Package xlog implements a simple logging package.

The Logger provide some methods for formatting log message output and log filter by set log level. The Layouter used to format the log message according to the format you want.

It also has a predefined 'standard' Logger accessible through helper functions which are easier to use than creating a Logger manually.

The Fatal[f] functions call os.Exit(1) after writing the log message. The Panic[f] functions call panic after writing the log message.

• Constants
• Variables
• func AddListener(lis Listener) bool
• func Close() error
• func Debug(v ...interface{})
• func Debugf(format string, v ...interface{})
• func Error(v ...interface{})
• func Errorf(format string, v ...interface{})
• func Fatal(v ...interface{})
• func Fatalf(format string, v ...interface{})
• func Info(v ...interface{})
• func Infof(format string, v ...interface{})
• func Log(level Level, v ...interface{})
• func Logf(level Level, format string, v ...interface{})
• func Panic(v ...interface{})
• func Panicf(format string, v ...interface{})
• func ParseAndSetLevel(lev string) error
• func RemoveListener(lis Listener) bool
• func SetLayout(layout string)
• func SetLevel(lev Level)
• func Warn(v ...interface{})
• func Warnf(format string, v ...interface{})
• type Layouter
• type Level
• • func ParseLevel(str string) (Level, bool)
• type Listener
• type Logger
• • func New(lev Level, lis Listener, layout string) *Logger
• • func (l *Logger) AddListener(lis Listener) bool
  • func (l *Logger) Close() error
  • func (l *Logger) Debug(v ...interface{})
  • func (l *Logger) Debugf(format string, v ...interface{})
  • func (l *Logger) Error(v ...interface{})
  • func (l *Logger) Errorf(format string, v ...interface{})
  • func (l *Logger) Fatal(v ...interface{})
  • func (l *Logger) Fatalf(format string, v ...interface{})
  • func (l *Logger) Info(v ...interface{})
  • func (l *Logger) Infof(format string, v ...interface{})
  • func (l *Logger) Log(level Level, msg string)
  • func (l *Logger) Panic(v ...interface{})
  • func (l *Logger) Panicf(format string, v ...interface{})
  • func (l *Logger) RemoveAllListeners()
  • func (l *Logger) RemoveListener(lis Listener) bool
  • func (l *Logger) SetLayout(layout string)
  • func (l *Logger) SetLevel(lev Level)
  • func (l *Logger) Warn(v ...interface{})
  • func (l *Logger) Warnf(format string, v ...interface{})
• type W2FileListener
• • func NewW2FileListener(filePath string) (*W2FileListener, error)
• • func (l *W2FileListener) Close() error
  • func (l *W2FileListener) Write(p []byte) (n int, err error)

DefaultLoggerLayout give the default log layout. "%L %D %T %l" mean "[INFO] 2017/01/05 18:02:17 some log msg..." See Layouter for details.

View Source

var Level2Str = []string{ "PANIC", "FATAL", "ERROR", "WARN", "INFO", "DEBUG", }

Level2Str used to conver Level value to string.

func AddListener(lis Listener) bool

AddListener is equivalent to Logger.AddListener.

Close is use to close the logger

func Debug(v ...interface{})

Debug is equivalent to Logger.Debug.

func Debugf(format string, v ...interface{})

Debugf is equivalent to Logger.Debugf.

func Error(v ...interface{})

Error is equivalent to Logger.Error.

func Errorf(format string, v ...interface{})

Errorf is equivalent to Logger.Errorf.

func Fatal(v ...interface{})

Fatal is equivalent to Logger.Fatal.

func Fatalf(format string, v ...interface{})

Fatalf is equivalent to Logger.Fatalf.

func Info(v ...interface{})

Info is equivalent to Logger.Info.

func Infof(format string, v ...interface{})

Infof is equivalent to Logger.Infof.

func Log(level Level, v ...interface{})

Log is equivalent to Logger.Log.

func Logf(level Level, format string, v ...interface{})

Logf is equivalent to Logger.Logf.

func Panic(v ...interface{})

Panic is equivalent to Logger.Panic.

func Panicf(format string, v ...interface{})

Panicf is equivalent to Logger.Panicf.

func RemoveListener(lis Listener) bool

RemoveListener is equivalent to Logger.RemoveListener.

SetLayout is equivalent to Logger.SetLayout.

SetLevel is equivalent to Logger.SetLevel.

func Warn(v ...interface{})

Warn is equivalent to Logger.Warn.

func Warnf(format string, v ...interface{})

Warnf is equivalent to Logger.Warnf.

type Layouter interface {

}

Layouter used to format log message.

%y : year %M : month %d : day %h : hour %m : min %s : second %l : log msg %L : log level %F : file eg: /a/b/c/d.go %f : short file eg: d.go %i : line %D : %y/%M/%d %T : %h:%m:%s

Level used to filter log message by the Logger.

const ( PanicLevel Level = iota FatalLevel ErrorLevel WarnLevel InfoLevel DebugLevel )

logging levels.

ParseLevel used to parse string to Level value. It will return (ParsedLevel, true) if parse successed, otherwise will return (InfoLevel, false).

A Listener simple typed of io.Writer

A Logger represents an active logging object that generates lines of output to log listeners. A Logger can be used simultaneously from multiple goroutines; it guarantees to serialize access to the Writer.

New creates a new Logger.

func (l *Logger) AddListener(lis Listener) bool

AddListener add a listener to the Logger, return false if the listener existed already, otherwise return true.

func (l *Logger) Debug(v ...interface{})

Debug print a DebugLevel message to the logger. Arguments are handled in the manner of fmt.Print.

func (l *Logger) Debugf(format string, v ...interface{})

Debugf print a DebugLevel message to the logger. Arguments are handled in the manner of fmt.Printf.

func (l *Logger) Error(v ...interface{})

Error print a ErrorLevel message to the logger. Arguments are handled in the manner of fmt.Print.

func (l *Logger) Errorf(format string, v ...interface{})

Errorf print a ErrorLevel message to the logger. Arguments are handled in the manner of fmt.Printf.

func (l *Logger) Fatal(v ...interface{})

Fatal print a FatalLevel message to the logger followed by a call to os.Exit(1). Arguments are handled in the manner of fmt.Print.

func (l *Logger) Fatalf(format string, v ...interface{})

Fatalf print a FatalLevel message to the logger followed by a call to os.Exit(1). Arguments are handled in the manner of fmt.Printf.

func (l *Logger) Info(v ...interface{})

Info print a InfoLevel message to the logger. Arguments are handled in the manner of fmt.Print.

func (l *Logger) Infof(format string, v ...interface{})

Infof print a InfoLevel message to the logger. Arguments are handled in the manner of fmt.Printf.

Log print a leveled message to the logger. Arguments are handled in the manner of fmt.Print.

func (l *Logger) Panic(v ...interface{})

Panic print a PanicLevel message to the logger followed by a call to panic(). Arguments are handled in the manner of fmt.Print.

func (l *Logger) Panicf(format string, v ...interface{})

Panicf print a PanicLevel message to the logger followed by a call to panic(). Arguments are handled in the manner of fmt.Printf.

func (l *Logger) RemoveAllListeners()

RemoveAllListeners remove all listeners from the logger.

func (l *Logger) RemoveListener(lis Listener) bool

RemoveListener remove a listener from the Logger, return true if remove success, otherwise return false.

func (l *Logger) SetLayout(layout string)

SetLayout set the layout of log message. will use DefaultLoggerLayout by default if layout parameter if empty. see Layouter for details.

func (l *Logger) SetLevel(lev Level)

SetLevel set the log level for Logger.

func (l *Logger) Warn(v ...interface{})

Warn print a WarnLevel message to the logger. Arguments are handled in the manner of fmt.Print.

func (l *Logger) Warnf(format string, v ...interface{})

Warnf print a WarnLevel message to the logger. Arguments are handled in the manner of fmt.Printf.

type W2FileListener struct {

}

W2FileListener use to output log to file.

NewW2FileListener creates a new W2FileListener. If filePath is empty, then will create file at appPath/Log/

Close is equivalent to os.File.Close.

Write is equivalent to os.File.Write.