logutils

Documentation

Index

• Variables
• func HaveDebugTag(tag string) bool
• func SetupVerboseLog(log Log, isVerbose bool)
• type DebugFunc
  • func Debug(tag string) DebugFunc
• type Log
• type LogLevel
• type MockLog
  • func NewMockLog() *MockLog
  • func (m *MockLog) Child(name string) Log
  • func (m *MockLog) Errorf(format string, args ...interface{})
  • func (m *MockLog) Fatalf(format string, args ...interface{})
  • func (m *MockLog) Infof(format string, args ...interface{})
  • func (m *MockLog) Panicf(format string, args ...interface{})
  • func (m *MockLog) SetLevel(level LogLevel)
  • func (m *MockLog) Warnf(format string, args ...interface{})
• type StderrLog
  • func NewStderrLog(name string) *StderrLog
  • func (sl StderrLog) Child(name string) Log
  • func (sl StderrLog) Debugf(format string, args ...interface{})
  • func (sl StderrLog) Errorf(format string, args ...interface{})
  • func (sl StderrLog) Fatalf(format string, args ...interface{})
  • func (sl StderrLog) Infof(format string, args ...interface{})
  • func (sl StderrLog) Panicf(format string, args ...interface{})
  • func (sl *StderrLog) SetLevel(level LogLevel)
  • func (sl StderrLog) Warnf(format string, args ...interface{})

Variables

var StdErr = colorable.NewColorableStderr()

var StdOut = color.Output // https://github.com/golangci/golangci-lint/issues/14

Functions

func HaveDebugTag

func HaveDebugTag(tag string) bool

func SetupVerboseLog

func SetupVerboseLog(log Log, isVerbose bool)

Types

type DebugFunc

type DebugFunc func(format string, args ...interface{})

func Debug

func Debug(tag string) DebugFunc

type Log

type Log interface {
	Fatalf(format string, args ...interface{})
	Panicf(format string, args ...interface{})
	Errorf(format string, args ...interface{})
	Warnf(format string, args ...interface{})
	Infof(format string, args ...interface{})

	Child(name string) Log
	SetLevel(level LogLevel)
}

type LogLevel

type LogLevel int

const (
	// Debug messages, write to debug logs only by logutils.Debug.
	LogLevelDebug LogLevel = 0

	// Information messages, don't write too many messages,
	// only useful ones: they are shown when running with -v.
	LogLevelInfo LogLevel = 1

	// Hidden errors: non-critical errors: work can be continued, no need to fail whole program;
	// tests will crash if any warning occurred.
	LogLevelWarn LogLevel = 2

	// Only not hidden from user errors: whole program failing, usually
	// error logging happens in 1-2 places: in the "main" function.
	LogLevelError LogLevel = 3
)

type MockLog

type MockLog struct {
	mock.Mock
}

func NewMockLog

func NewMockLog() *MockLog

func (*MockLog) Child

func (m *MockLog) Child(name string) Log

func (*MockLog) Errorf

func (m *MockLog) Errorf(format string, args ...interface{})

func (*MockLog) Fatalf

func (m *MockLog) Fatalf(format string, args ...interface{})

func (*MockLog) Infof

func (m *MockLog) Infof(format string, args ...interface{})

func (*MockLog) Panicf

func (m *MockLog) Panicf(format string, args ...interface{})

func (*MockLog) SetLevel

func (m *MockLog) SetLevel(level LogLevel)

func (*MockLog) Warnf

func (m *MockLog) Warnf(format string, args ...interface{})

type StderrLog

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

func NewStderrLog

func NewStderrLog(name string) *StderrLog

func (StderrLog) Child

func (sl StderrLog) Child(name string) Log

func (StderrLog) Debugf

func (sl StderrLog) Debugf(format string, args ...interface{})

func (StderrLog) Errorf

func (sl StderrLog) Errorf(format string, args ...interface{})

func (StderrLog) Fatalf

func (sl StderrLog) Fatalf(format string, args ...interface{})

func (StderrLog) Infof

func (sl StderrLog) Infof(format string, args ...interface{})

func (StderrLog) Panicf

func (sl StderrLog) Panicf(format string, args ...interface{})

func (*StderrLog) SetLevel

func (sl *StderrLog) SetLevel(level LogLevel)

func (StderrLog) Warnf

func (sl StderrLog) Warnf(format string, args ...interface{})