log

Documentation

Index

• Constants
• Variables
• func LogDebug(v ...interface{})
• func LogDebugf(format string, v ...interface{})
• func LogError(v ...interface{})
• func LogErrorf(format string, v ...interface{})
• func LogFatal(v ...interface{})
• func LogFatalf(format string, v ...interface{})
• func LogFlush()
• func LogInfo(v ...interface{})
• func LogInfof(format string, v ...interface{})
• func LogRead(v ...interface{})
• func LogReadf(format string, v ...interface{})
• func LogWarn(v ...interface{})
• func LogWarnf(format string, v ...interface{})
• func LogWrite(v ...interface{})
• func LogWritef(format string, v ...interface{})
• type Level
• type Log
  • func InitLog(dir, module string, level Level, rotate *LogRotate) (*Log, error)
  • func (l *Log) Flush()
  • func (l *Log) SetPrefix(s, level string) string
• type LogObject
  • func (ob *LogObject) Flush()
  • func (ob *LogObject) SetRotation()
• type LogRotate
  • func NewLogRotate() *LogRotate
  • func (r *LogRotate) SetHeadRoomMb(size int64)
  • func (r *LogRotate) SetRollingSizeMb(size int64)
• type RolledFile
  • func (f RolledFile) Len() int
  • func (f RolledFile) Less(i, j int) bool
  • func (f RolledFile) Swap(i, j int)

Constants

const (
	DebugLevel  Level = 1
	InfoLevel         = DebugLevel<<1 + 1
	WarnLevel         = InfoLevel<<1 + 1
	ErrorLevel        = WarnLevel<<1 + 1
	FatalLevel        = ErrorLevel<<1 + 1
	ReadLevel         = InfoLevel
	UpdateLevel       = InfoLevel
)

const (
	FileNameDateFormat     = "20060102150405"
	FileOpt                = os.O_RDWR | os.O_CREATE | os.O_APPEND
	WriterBufferInitSize   = 4 * 1024 * 1024
	WriterBufferLenLimit   = 4 * 1024 * 1024
	DefaultRollingInterval = 5 * time.Minute
	RolledExtension        = ".old"
)

const (
	// DefaultRollingSize Specifies at what size to roll the output log at
	// Units: MB
	DefaultRollingSize = 10 * 1024
	// DefaultHeadRoom The tolerance for the log space limit (in megabytes)
	DefaultHeadRoom = 50 * 1024
	// DefaultHeadRatio The disk reserve space ratio
	DefaultHeadRatio = 0.2
)

Variables

var (
	ErrLogFileName    = "_error.log"
	WarnLogFileName   = "_warn.log"
	InfoLogFileName   = "_info.log"
	DebugLogFileName  = "_debug.log"
	ReadLogFileName   = "_read.log"
	UpdateLogFileName = "_write.log"
)

Functions

func LogDebug

func LogDebug(v ...interface{})

LogDebug logs the debug information.

func LogDebugf

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

LogDebugf logs the debug information with specified format.

func LogError

func LogError(v ...interface{})

LogError logs the errors.

func LogErrorf

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

LogErrorf logs the errors with the specified format.

func LogFatal

func LogFatal(v ...interface{})

LogFatal logs the fatal errors.

func LogFatalf

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

LogFatalf logs the fatal errors with specified format.

func LogFlush

func LogFlush()

LogFlush flushes the log.

func LogInfo

func LogInfo(v ...interface{})

LogInfo indicates log the information. TODO explain

func LogInfof

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

LogInfo indicates log the information with specific format. TODO explain

func LogRead

func LogRead(v ...interface{})

LogRead

func LogReadf

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

TODO not used?

func LogWarn

func LogWarn(v ...interface{})

LogWarn indicates the warnings.

func LogWarnf

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

LogWarnf indicates the warnings with specific format.

func LogWrite

func LogWrite(v ...interface{})

LogWrite

func LogWritef

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

LogWritef TODO not used

Types

type Level

type Level uint8

type Log

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

Log defines the log struct.

func InitLog

func InitLog(dir, module string, level Level, rotate *LogRotate) (*Log, error)

InitLog initializes the log.

func (*Log) Flush

func (l *Log) Flush()

Flush flushes the log.

func (*Log) SetPrefix

func (l *Log) SetPrefix(s, level string) string

SetPrefix sets the log prefix.

type LogObject

type LogObject struct {
	*log.Logger
	// contains filtered or unexported fields
}

LogObject defines the log object.

func (*LogObject) Flush

func (ob *LogObject) Flush()

Flush flushes the log object.

func (*LogObject) SetRotation

func (ob *LogObject) SetRotation()

type LogRotate

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

A log can be rotated by the size or time.

func NewLogRotate

func NewLogRotate() *LogRotate

NewLogRotate returns a new LogRotate instance.

func (*LogRotate) SetHeadRoomMb

func (r *LogRotate) SetHeadRoomMb(size int64)

SetHeadRoomMb sets the headroom in terms of MB.

func (*LogRotate) SetRollingSizeMb

func (r *LogRotate) SetRollingSizeMb(size int64)

SetRollingSizeMb sets the rolling size in terms of MB.

type RolledFile

type RolledFile []os.FileInfo

func (RolledFile) Len

func (f RolledFile) Len() int

func (RolledFile) Less

func (f RolledFile) Less(i, j int) bool

func (RolledFile) Swap

func (f RolledFile) Swap(i, j int)