log

README

log

Installation

go get -u github.com/no-src/log

Quick Start

Current support following loggers

• empty logger
• console logger
• file logger
• multi logger

For example, init a file logger, to write logs.

log.InitDefaultLogger(NewFileLogger(DebugLevel,"./logs",""))
log.Debug("%s,test debug log", "hello")
log.Info("%s,test info log", "hello")
log.Warn("%s,test warn log", "hello")
log.Error(errors.New("log err"), "%s,test error log", "hello")
log.Log("%s,test log log", "hello")

Documentation

Index

• func Close() error
• func Debug(format string, args ...interface{})
• func Error(err error, format string, args ...interface{})
• func Info(format string, args ...interface{})
• func InitDefaultLogger(logger Logger)
• func Log(format string, args ...interface{})
• func Warn(format string, args ...interface{})
• type Level
  • func (l Level) String() string
• type Logger
  • func DefaultLogger() Logger
  • func NewConsoleLogger(level Level) Logger
  • func NewEmptyLogger() Logger
  • func NewFileLogger(level Level, logDir string, filePrefix string) (Logger, error)
  • func NewFileLoggerWithAutoFlush(level Level, logDir string, filePrefix string, autoFlush bool, ...) (Logger, error)
  • func NewMultiLogger(loggers ...Logger) Logger
• type Writer

Functions

func Close

func Close() error

Close close the current logger

func Debug

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

Debug write the debug log

func Error

func Error(err error, format string, args ...interface{})

Error write the error log

func Info

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

Info write the info log

func InitDefaultLogger

func InitDefaultLogger(logger Logger)

InitDefaultLogger init a default logger if InitDefaultLogger is not called, default is consoleLogger with InfoLevel

func Log

func Log(format string, args ...interface{})

Log write the log without level

func Warn

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

Warn write the warn log

Types

type Level

type Level int8

Level the log level

const (
	// DebugLevel the debug log level
	DebugLevel Level = iota
	// InfoLevel the info log level
	InfoLevel
	// WarnLevel the warn log level
	WarnLevel
	// ErrorLevel the error log level
	ErrorLevel
	// NoneLevel disable all level log, except for the Writer.Log
	NoneLevel
)

func (Level) String

func (l Level) String() string

String return the description of log level

type Logger

type Logger interface {
	Debug(format string, args ...interface{})
	Info(format string, args ...interface{})
	Warn(format string, args ...interface{})
	Error(err error, format string, args ...interface{})
	Writer
}

Logger define a universal log interface

func DefaultLogger

func DefaultLogger() Logger

DefaultLogger return the global default logger

func NewConsoleLogger

func NewConsoleLogger(level Level) Logger

NewConsoleLogger get a console logger

func NewEmptyLogger

func NewEmptyLogger() Logger

NewEmptyLogger get an empty logger, there is nothing to do

func NewFileLogger

func NewFileLogger(level Level, logDir string, filePrefix string) (Logger, error)

NewFileLogger get a file logger

func NewFileLoggerWithAutoFlush

func NewFileLoggerWithAutoFlush(level Level, logDir string, filePrefix string, autoFlush bool, flushInterval time.Duration) (Logger, error)

NewFileLoggerWithAutoFlush get a file logger

func NewMultiLogger

func NewMultiLogger(loggers ...Logger) Logger

NewMultiLogger get a multi logger, write log to multiple loggers

type Writer

type Writer interface {
	io.Writer
	// Log write log to output
	Log(format string, args ...interface{})
	// Close to close log and release dependencies
	Close() error
}

Writer implement write to log