log

Documentation

Index

• Variables
• type Auditor
  • func NewAuditor(log *ScdoLog) *Auditor
  • func (a *Auditor) Audit(format string, args ...interface{})
  • func (a *Auditor) AuditEnter(method string)
  • func (a *Auditor) AuditLeave()
• type CallerHook
  • func (hook *CallerHook) Fire(entry *logrus.Entry) error
  • func (hook *CallerHook) Levels() []logrus.Level
• type ScdoLog
  • func GetLogger(module string) *ScdoLog
  • func (p *ScdoLog) Debug(format string, args ...interface{})
  • func (p *ScdoLog) Error(format string, args ...interface{})
  • func (p *ScdoLog) Fatal(format string, args ...interface{})
  • func (p *ScdoLog) GetLevel() logrus.Level
  • func (p *ScdoLog) Info(format string, args ...interface{})
  • func (p *ScdoLog) Panic(format string, args ...interface{})
  • func (p *ScdoLog) SetLevel(level logrus.Level)
  • func (p *ScdoLog) Warn(format string, args ...interface{})

Variables

var (
	// LogFolder the default folder to write logs
	LogFolder = filepath.Join(common.GetTempFolder(), "log")
)

Types

type Auditor

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

Auditor is used for auditing step by step via log.

func NewAuditor

func NewAuditor(log *ScdoLog) *Auditor

NewAuditor returns a new auditor instance with specified log and an optional last time.

func (*Auditor) Audit

func (a *Auditor) Audit(format string, args ...interface{})

Audit adds log for the specified parameterized message.

func (*Auditor) AuditEnter

func (a *Auditor) AuditEnter(method string)

AuditEnter adds log for method enter.

func (*Auditor) AuditLeave

func (a *Auditor) AuditLeave()

AuditLeave adds log for method leave.

type CallerHook

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

CallerHook a caller hook of logrus

func (*CallerHook) Fire

func (hook *CallerHook) Fire(entry *logrus.Entry) error

Fire adds a caller field in logger instance

func (*CallerHook) Levels

func (hook *CallerHook) Levels() []logrus.Level

Levels returns supported levels

type ScdoLog

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

ScdoLog wraps log class

func GetLogger

func GetLogger(module string) *ScdoLog

GetLogger gets logrus.Logger object according to module name each module can have its own logger

func (*ScdoLog) Debug

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

Debug Level. Usually only enabled when debugging. Very verbose logging.

func (*ScdoLog) Error

func (p *ScdoLog) Error(format string, args ...interface{})

Error Level. Error logs and is used for errors that should be definitely noted. Commonly used for hooks to send errors to an error tracking service.

func (*ScdoLog) Fatal

func (p *ScdoLog) Fatal(format string, args ...interface{})

Fatal Level. Fatal logs and then calls `os.Exit(1)`. It will exit even if the logging level is set to Panic.

func (*ScdoLog) GetLevel

func (p *ScdoLog) GetLevel() logrus.Level

GetLevel get the log level

func (*ScdoLog) Info

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

Info Level. General operational entries about what's going on inside the application.

func (*ScdoLog) Panic

func (p *ScdoLog) Panic(format string, args ...interface{})

Panic Level, highest level of severity. Panic logs and then calls panic with the message passed to Debug, Info, ...

func (*ScdoLog) SetLevel

func (p *ScdoLog) SetLevel(level logrus.Level)

SetLevel set the log level

func (*ScdoLog) Warn

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

Warn Level. Non-critical entries that deserve eyes.