stimlog

Documentation

Index

• type Level
• type Logger
• type StimLogger
  • func GetLogger() StimLogger
  • func GetLoggerWithPrefix(prefix string) StimLogger
• type StimLoggerConfig
  • func GetLoggerConfig() StimLoggerConfig

Types

type Level

type Level int32

Level is the Level of logging set in stim

const (

	//FatalLevel this is used to log an error that will cause fatal problems in the program
	FatalLevel Level = 0
	//WarnLevel is logging for interesting events that need to be known about but are not crazy
	WarnLevel    Level = 20
	InfoLevel    Level = 30
	VerboseLevel Level = 40
	//DebugLevel is used to debugging certain calls in Stim to see what is going on, usually only used for development
	DebugLevel Level = 50
	TraceLevel Level = 60
)

type Logger

type Logger interface {
	Debug(...interface{})
	Warn(...interface{})
	Fatal(...interface{})
}

type StimLogger

type StimLogger interface {
	Trace(...interface{})
	Debug(...interface{})
	Verbose(...interface{})
	Info(...interface{})
	Warn(...interface{})
	Fatal(...interface{})
	GetLogLevel() Level
}

StimLogger this struct is a generic logger used by stim packages

func GetLogger

func GetLogger() StimLogger

GetLogger gets a logger for logging in stim.

func GetLoggerWithPrefix

func GetLoggerWithPrefix(prefix string) StimLogger

GetLoggerWithPrefix gets a logger for logging in stim with a prefix.

type StimLoggerConfig

type StimLoggerConfig interface {
	SetLogger(Logger)
	SetLevel(Level)
	SetDateFormat(string)
	AddLogFile(string, Level) error
	RemoveLogFile(string)
	ForceFlush(bool)
	Flush()
	EnableLevelLogging(bool)
	EnableTimeLogging(bool)
}

func GetLoggerConfig

func GetLoggerConfig() StimLoggerConfig