log

Documentation

Overview

log package supplies more advanced features than go orign log package.

It supports log different level: trace, debug, info, warn, error, fatal.

It also supports different log handlers which you can log to stdout, file, socket, etc...

Use

import "github.com/siddontang/go-log/log"

//log with different level
log.Info("hello world")
log.Error("hello world")

//create a logger with specified handler
h := NewStreamHandler(os.Stdout)
l := log.NewDefault(h)
l.Info("hello world")

Index

• Constants
• Variables
• func Debug(format string, v ...interface{})
• func Error(format string, v ...interface{})
• func Fatal(format string, v ...interface{})
• func Info(format string, v ...interface{})
• func SetLevel(level int)
• func Trace(format string, v ...interface{})
• func Warn(format string, v ...interface{})
• type FileHandler
  • func NewFileHandler(fileName string, flag int) (*FileHandler, error)
  • func (h *FileHandler) Close() error
  • func (h *FileHandler) Write(b []byte) (n int, err error)
• type Handler
• type Logger
  • func New(handler Handler, flag int) *Logger
  • func NewDefault(handler Handler) *Logger
  • func (l *Logger) Close()
  • func (l *Logger) Debug(format string, v ...interface{})
  • func (l *Logger) Error(format string, v ...interface{})
  • func (l *Logger) Fatal(format string, v ...interface{})
  • func (l *Logger) Info(format string, v ...interface{})
  • func (l *Logger) Output(callDepth int, level int, format string, v ...interface{})
  • func (l *Logger) SetLevel(level int)
  • func (l *Logger) Trace(format string, v ...interface{})
  • func (l *Logger) Warn(format string, v ...interface{})
• type NullHandler
  • func NewNullHandler() (*NullHandler, error)
  • func (h *NullHandler) Close()
  • func (h *NullHandler) Write(b []byte) (n int, err error)
• type RotatingFileHandler
  • func NewRotatingFileHandler(fileName string, maxBytes int, backupCount int) (*RotatingFileHandler, error)
  • func (h *RotatingFileHandler) Close() error
  • func (h *RotatingFileHandler) Write(p []byte) (n int, err error)
• type SocketHandler
  • func NewSocketHandler(protocol string, addr string) (*SocketHandler, error)
  • func (h *SocketHandler) Close() error
  • func (h *SocketHandler) Write(p []byte) (n int, err error)
• type StreamHandler
  • func NewStreamHandler(w io.Writer) (*StreamHandler, error)
  • func (h *StreamHandler) Close() error
  • func (h *StreamHandler) Write(b []byte) (n int, err error)
• type TimeRotatingFileHandler
  • func NewTimeRotatingFileHandler(baseName string, when int8, interval int) (*TimeRotatingFileHandler, error)
  • func (h *TimeRotatingFileHandler) Close() error
  • func (h *TimeRotatingFileHandler) Write(b []byte) (n int, err error)

Constants

const (
	WhenSecond = iota
	WhenMinute
	WhenHour
	WhenDay
)

const (
	LevelTrace = iota
	LevelDebug
	LevelInfo
	LevelWarn
	LevelError
	LevelFatal
)

log level, from low to high, more high means more serious

const (
	Ltime  = 1 << iota //time format "2006/01/02 15:04:05"
	Lfile              //file.go:123
	Llevel             //[Trace|Debug|Info...]
)

const TimeFormat = "2006/01/02 15:04:05"

Variables

var LevelName [6]string = [6]string{"Trace", "Debug", "Info", "Warn", "Error", "Fatal"}

Functions

func Debug

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

func Error

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

func Fatal

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

func Info

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

func SetLevel

func SetLevel(level int)

func Trace

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

func Warn

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

Types

type FileHandler

type FileHandler struct {
	// contains filtered or unexported fields
}

FileHandler writes log to a file.

func NewFileHandler

func NewFileHandler(fileName string, flag int) (*FileHandler, error)

func (*FileHandler) Close

func (h *FileHandler) Close() error

func (*FileHandler) Write

func (h *FileHandler) Write(b []byte) (n int, err error)

type Handler

type Handler interface {
	Write(p []byte) (n int, err error)
	Close() error
}

Handler writes logs to somewhere

type Logger

type Logger struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func New

func New(handler Handler, flag int) *Logger

new a logger with specified handler and flag

func NewDefault

func NewDefault(handler Handler) *Logger

new a default logger with specified handler and flag: Ltime|Lfile|Llevel

func (*Logger) Close

func (l *Logger) Close()

func (*Logger) Debug

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

log with Debug level

func (*Logger) Error

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

log with error level

func (*Logger) Fatal

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

log with fatal level

func (*Logger) Info

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

log with info level

func (*Logger) Output

func (l *Logger) Output(callDepth int, level int, format string, v ...interface{})

a low interface, maybe you can use it for your special log format but it may be not exported later......

func (*Logger) SetLevel

func (l *Logger) SetLevel(level int)

set log level, any log level less than it will not log

func (*Logger) Trace

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

log with Trace level

func (*Logger) Warn

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

log with warn level

type NullHandler

type NullHandler struct {
}

NullHandler does nothing, it discards anything.

func NewNullHandler

func NewNullHandler() (*NullHandler, error)

func (*NullHandler) Close

func (h *NullHandler) Close()

func (*NullHandler) Write

func (h *NullHandler) Write(b []byte) (n int, err error)

type RotatingFileHandler

type RotatingFileHandler struct {
	// contains filtered or unexported fields
}

RotatingFileHandler writes log a file, if file size exceeds maxBytes, it will backup current file and open a new one.

max backup file number is set by backupCount, it will delete oldest if backups too many.

func NewRotatingFileHandler

func NewRotatingFileHandler(fileName string, maxBytes int, backupCount int) (*RotatingFileHandler, error)

func (*RotatingFileHandler) Close

func (h *RotatingFileHandler) Close() error

func (*RotatingFileHandler) Write

func (h *RotatingFileHandler) Write(p []byte) (n int, err error)

type SocketHandler

type SocketHandler struct {
	// contains filtered or unexported fields
}

SocketHandler writes log to a connectionl. Network protocol is simple: log length + log | log length + log. log length is uint32, bigendian. you must implement your own log server, maybe you can use logd instead simply.

func NewSocketHandler

func NewSocketHandler(protocol string, addr string) (*SocketHandler, error)

func (*SocketHandler) Close

func (h *SocketHandler) Close() error

func (*SocketHandler) Write

func (h *SocketHandler) Write(p []byte) (n int, err error)

type StreamHandler

type StreamHandler struct {
	// contains filtered or unexported fields
}

StreamHandler writes logs to a specified io Writer, maybe stdout, stderr, etc...

func NewStreamHandler

func NewStreamHandler(w io.Writer) (*StreamHandler, error)

func (*StreamHandler) Close

func (h *StreamHandler) Close() error

func (*StreamHandler) Write

func (h *StreamHandler) Write(b []byte) (n int, err error)

type TimeRotatingFileHandler

type TimeRotatingFileHandler struct {
	// contains filtered or unexported fields
}

TimeRotatingFileHandler writes log to a file, it will backup current and open a new one, with a period time you sepecified.

refer: http://docs.python.org/2/library/logging.handlers.html. same like python TimedRotatingFileHandler.

func NewTimeRotatingFileHandler

func NewTimeRotatingFileHandler(baseName string, when int8, interval int) (*TimeRotatingFileHandler, error)

func (*TimeRotatingFileHandler) Close

func (h *TimeRotatingFileHandler) Close() error

func (*TimeRotatingFileHandler) Write

func (h *TimeRotatingFileHandler) Write(b []byte) (n int, err error)