logger

Documentation

Index

• Constants
• Variables
• type ColourMap
• type LogDispatcher
  • func NewLogDispatcher(backends map[string]Logger) LogDispatcher
• type LogFormatter
• type LogLevel
• type LogWriter
• type Logger
  • func NewConsoleLogger(coloured bool, colourMap *ColourMap) Logger
  • func NewFileLogger(f *os.File) Logger

Constants

const (
	// LevelCritical represents the Critical Log Level
	LevelCritical = 100
	// LevelError represents the Error log level
	LevelError = 200
	// LevelWarning represents the Warning log level
	LevelWarning = 300
	// LevelInfo represents the Informational logging level
	LevelInfo = 400
	// LevelDebug represents the Debug log level
	LevelDebug = 500
	// LevelStderr represents the Stderr log level
	LevelStderr = LevelWarning + 6
	// LevelStdout represents the Stdout log level
	LevelStdout = LevelWarning + 7
	// LevelSkip represents the Skip log level
	LevelSkip = LevelWarning + 1
	// LevelPass represents the Pass log level
	LevelPass = LevelWarning + 2
	// LevelCancel represents the Cancel log level
	LevelCancel = LevelWarning + 3
	// LevelFail represents the Fail log level
	LevelFail = LevelWarning + 4
	// LevelSummary represents the Summary log level
	LevelSummary = LevelWarning + 5
)

Variables

var LevelNames = map[LogLevel]string{
	LevelCritical: "CRITICAL",
	LevelError:    "ERROR",
	LevelWarning:  "WARNING",
	LevelInfo:     "INFO",
	LevelDebug:    "DEBUG",
	LevelStderr:   "STDERR",
	LevelStdout:   "STDOUT",
	LevelSkip:     "SKIP",
	LevelPass:     "PASS",
	LevelCancel:   "CANCEL",
	LevelFail:     "FAIL",
	LevelSummary:  "SUMMARY",
}

LevelNames maps LogLevels to a string representation of their names

Types

type ColourMap

type ColourMap map[LogLevel]func(...interface{}) string

ColourMap maps logLevels to colorizing functions

type LogDispatcher

type LogDispatcher interface {
	Log(level LogLevel, msg string)
	Register(name string, backend Logger)
	Unregister(name string)
}

LogDispatcher dispatches logs to multiple Loggers

func NewLogDispatcher

func NewLogDispatcher(backends map[string]Logger) LogDispatcher

NewLogDispatcher returns a new LogDispatcher with the provided backend Loggers

type LogFormatter

type LogFormatter interface {
	Format(timestamp time.Time, level LogLevel, msg string) string
}

LogFormatter formats log entries in to a string

type LogLevel

type LogLevel int

LogLevel is The severity level of the logs 0 is the lowest severity

type LogWriter

type LogWriter interface {
	Write(entry string)
}

LogWriter writes log entries somewhere

type Logger

type Logger interface {
	LogFormatter
	LogWriter
	Log(timestamp time.Time, level LogLevel, msg string)
	SetLevel(level LogLevel)
}

A Logger formats and writes log entries

func NewConsoleLogger

func NewConsoleLogger(coloured bool, colourMap *ColourMap) Logger

NewConsoleLogger returns a new logger that logs to stderr in console log format

func NewFileLogger

func NewFileLogger(f *os.File) Logger

NewFileLogger returns a new logger that logs to file in a console log format