loggers

Documentation

Index

• Variables
• func InitGlobalLogger(stdoutThreshold, logThreshold jww.Threshold, outHandle, logHandle io.Writer)
• func LoggerToWriterWithPrefix(logger *log.Logger, prefix string) io.Writer
• func RemoveANSIColours(s string) string
• type IgnorableLogger
  • func NewIgnorableLogger(logger Logger, statements ...string) IgnorableLogger
• type LogCounters
• type Logger
  • func NewBasicLogger(t jww.Threshold) Logger
  • func NewBasicLoggerForWriter(t jww.Threshold, w io.Writer) Logger
  • func NewDebugLogger() Logger
  • func NewErrorLogger() Logger
  • func NewInfoLogger() Logger
  • func NewLogger(stdoutThreshold, logThreshold jww.Threshold, outHandle, logHandle io.Writer, ...) Logger
  • func NewWarningLogger() Logger

Variables

var (
	// Counts ERROR logs to the global jww logger.
	GlobalErrorCounter *jww.Counter
	PanicOnWarning     bool
)

Functions

func InitGlobalLogger

func InitGlobalLogger(stdoutThreshold, logThreshold jww.Threshold, outHandle, logHandle io.Writer)

InitGlobalLogger initializes the global logger, used in some rare cases.

func LoggerToWriterWithPrefix

func LoggerToWriterWithPrefix(logger *log.Logger, prefix string) io.Writer

func RemoveANSIColours

func RemoveANSIColours(s string) string

RemoveANSIColours removes all ANSI colours from the given string.

Types

type IgnorableLogger

type IgnorableLogger interface {
	Logger
	Errorsf(statementID, format string, v ...any)
	Apply(logger Logger) IgnorableLogger
}

IgnorableLogger is a logger that ignores certain log statements.

func NewIgnorableLogger

func NewIgnorableLogger(logger Logger, statements ...string) IgnorableLogger

NewIgnorableLogger wraps the given logger and ignores the log statement IDs given.

type LogCounters

type LogCounters struct {
	ErrorCounter *jww.Counter
	WarnCounter  *jww.Counter
}

type Logger

type Logger interface {
	Printf(format string, v ...any)
	Println(v ...any)
	PrintTimerIfDelayed(start time.Time, name string)
	Debug() *log.Logger
	Debugf(format string, v ...any)
	Debugln(v ...any)
	Info() *log.Logger
	Infof(format string, v ...any)
	Infoln(v ...any)
	Warn() *log.Logger
	Warnf(format string, v ...any)
	Warnln(v ...any)
	Error() *log.Logger
	Errorf(format string, v ...any)
	Errorln(v ...any)
	Errors() string

	Out() io.Writer

	Reset()

	// Used in tests.
	LogCounters() *LogCounters
}

func NewBasicLogger

func NewBasicLogger(t jww.Threshold) Logger

NewBasicLogger creates a new basic logger writing to Stdout.

func NewBasicLoggerForWriter

func NewBasicLoggerForWriter(t jww.Threshold, w io.Writer) Logger

NewBasicLoggerForWriter creates a new basic logger writing to w.

func NewDebugLogger

func NewDebugLogger() Logger

NewDebugLogger is a convenience function to create a debug logger.

func NewErrorLogger

func NewErrorLogger() Logger

NewErrorLogger is a convenience function to create an error logger.

func NewInfoLogger

func NewInfoLogger() Logger

NewInfoLogger is a convenience function to create a info logger.

func NewLogger

func NewLogger(stdoutThreshold, logThreshold jww.Threshold, outHandle, logHandle io.Writer, saveErrors bool) Logger

NewLogger creates a new Logger for the given thresholds

func NewWarningLogger

func NewWarningLogger() Logger

NewWarningLogger is a convenience function to create a warning logger.