Package: github.com/spf13/jwalterweatherman

package jwalterweatherman Import Path github.com/spf13/jwalterweatherman (on go.dev) Dependency Relation imports 6 packages, and imported by one package

Involved Source Files default_notepad.go log_counter.go notepad.go

Package-Level Type Names (total 5, all are exported)

/* sort exporteds by: alphabet | popularity */

type Counter (struct) Counter is an io.Writer that increments a counter on Write. Fields (only one, which is unexported) /* one unexported ... *//* one unexported: */ count uint64 Methods (total 4, in which 3 are exported) (*T) Count() uint64 Count returns the current count. (*T) Reset() Reset resets the counter. (*T) Write(p []byte) (n int, err error) /* one unexported ... *//* one unexported: */ (*T) incr() Implements (at least one exported) *T : io.Writer As Inputs Of (at least one exported) func LogCounter(counter *Counter, t1 Threshold) LogListener

type Feedback (struct) Feedback writes plainly to the outHandle while logging with the standard extra information (date, file, etc). Fields (total 2, neither is exported) /* 2 unexporteds ... *//* 2 unexporteds: */ log *log.Logger out *log.Logger Methods (total 4, in which 3 are exported) (*T) Print(v ...interface{}) (*T) Printf(format string, v ...interface{}) (*T) Println(v ...interface{}) /* one unexported ... *//* one unexported: */ (*T) output(s string) As Types Of (only one, which is exported) var FEEDBACK *Feedback

type LogListener (func) A LogListener can ble supplied to a Notepad to listen on log writes for a given threshold. This can be used to capture log events in unit tests and similar. Note that this function will be invoked once for each log threshold. If the given threshold is not of interest to you, return nil. Note that these listeners will receive log events for a given threshold, even if the current configuration says not to log it. That way you can count ERRORs even if you don't print them to the console. As Outputs Of (at least one exported) func LogCounter(counter *Counter, t1 Threshold) LogListener As Inputs Of (at least 2, both are exported) func NewNotepad(outThreshold Threshold, logThreshold Threshold, outHandle, logHandle io.Writer, prefix string, flags int, logListeners ...LogListener) *Notepad func SetLogListeners(l ...LogListener)

type Notepad (struct) Notepad is where you leave a note! Fields (total 17, in which 9 are exported) CRITICAL *log.Logger DEBUG *log.Logger ERROR *log.Logger FATAL *log.Logger FEEDBACK *Feedback INFO *log.Logger LOG *log.Logger TRACE *log.Logger WARN *log.Logger /* 8 unexporteds ... *//* 8 unexporteds: */ flags int logHandle io.Writer logListeners []LogListener logThreshold Threshold loggers [7]**log.Logger outHandle io.Writer prefix string stdoutThreshold Threshold Methods (total 9, in which 7 are exported) (*T) GetLogThreshold() Threshold GetStdoutThreshold returns the defined Treshold for the log logger. (*T) GetStdoutThreshold() Threshold GetStdoutThreshold returns the Treshold for the stdout logger. (*T) SetFlags(flags int) SetFlags choose which flags the logger will display (after prefix and message level). See the package log for more informations on this. (*T) SetLogOutput(handle io.Writer) SetLogOutput changes the file where log messages are written. (*T) SetLogThreshold(threshold Threshold) SetLogThreshold changes the threshold above which messages are written to the log file. (*T) SetPrefix(prefix string) SetPrefix changes the prefix used by the notepad. Prefixes are displayed between brackets at the beginning of the line. An empty prefix won't be displayed at all. (*T) SetStdoutThreshold(threshold Threshold) SetStdoutThreshold changes the threshold above which messages are written to the standard output. /* 2 unexporteds ... *//* 2 unexporteds: */ (*T) createLogWriters(t Threshold, handle io.Writer) io.Writer (*T) init() init creates the loggers for each level depending on the notepad thresholds. As Outputs Of (at least one exported) func NewNotepad(outThreshold Threshold, logThreshold Threshold, outHandle, logHandle io.Writer, prefix string, flags int, logListeners ...LogListener) *Notepad As Types Of (only one, which is unexported) /* one unexported ... *//* one unexported: */ var defaultNotepad *Notepad

type Threshold int (basic type) Methods (only one, which is exported) ( T) String() string Implements (at least 4, in which 1 are exported) T : fmt.Stringer /* 3+ unexporteds ... *//* 3+ unexporteds: */ T : context.stringer T : os/signal.stringer T : runtime.stringer As Outputs Of (at least 6, all are exported) func GetLogThreshold() Threshold func GetStdoutThreshold() Threshold func LogThreshold() Threshold func StdoutThreshold() Threshold func (*Notepad).GetLogThreshold() Threshold func (*Notepad).GetStdoutThreshold() Threshold As Inputs Of (at least 8, in which 7 are exported) func LogCounter(counter *Counter, t1 Threshold) LogListener func NewNotepad(outThreshold Threshold, logThreshold Threshold, outHandle, logHandle io.Writer, prefix string, flags int, logListeners ...LogListener) *Notepad func NewNotepad(outThreshold Threshold, logThreshold Threshold, outHandle, logHandle io.Writer, prefix string, flags int, logListeners ...LogListener) *Notepad func SetLogThreshold(threshold Threshold) func SetStdoutThreshold(threshold Threshold) func (*Notepad).SetLogThreshold(threshold Threshold) func (*Notepad).SetStdoutThreshold(threshold Threshold) /* at least one unexported ... *//* at least one unexported: */ func (*Notepad).createLogWriters(t Threshold, handle io.Writer) io.Writer As Types Of (total 7, all are exported) const LevelCritical const LevelDebug const LevelError const LevelFatal const LevelInfo const LevelTrace const LevelWarn

Package-Level Functions (total 15, in which 13 are exported)

func GetLogThreshold() Threshold GetStdoutThreshold returns the defined Treshold for the log logger.

func GetStdoutThreshold() Threshold GetStdoutThreshold returns the Treshold for the stdout logger.

func LogCounter(counter *Counter, t1 Threshold) LogListener LogCounter creates a LogListener that counts log statements >= the given threshold.

func LogThreshold() Threshold Level returns the current global log threshold.

func NewNotepad(outThreshold Threshold, logThreshold Threshold, outHandle, logHandle io.Writer, prefix string, flags int, logListeners ...LogListener) *Notepad NewNotepad creates a new Notepad.

func SetFlags(flags int) SetFlags set the flags for the default logger. "log.Ldate | log.Ltime" by default.

func SetLogListeners(l ...LogListener) SetLogListeners configures the default logger with one or more log listeners.

func SetLogOutput(handle io.Writer) SetLogOutput set the log output for the default notepad. Discarded by default.

func SetLogThreshold(threshold Threshold) SetLogThreshold set the log threshold for the default notepad. Trace by default.

func SetPrefix(prefix string) SetPrefix set the prefix for the default logger. Empty by default.

func SetStdoutOutput(handle io.Writer) SetStdoutOutput set the stdout output for the default notepad. Default is stdout.

func SetStdoutThreshold(threshold Threshold) SetStdoutThreshold set the standard output threshold for the default notepad. Info by default.

func StdoutThreshold() Threshold Level returns the current global output threshold.

/* 2 unexporteds ... *//* 2 unexporteds: */

func init()

func reloadDefaultNotepad()

Package-Level Variables (total 11, in which 9 are exported)

var CRITICAL *log.Logger

var DEBUG *log.Logger

var ERROR *log.Logger

var FATAL *log.Logger

var FEEDBACK *Feedback

var INFO *log.Logger

var LOG *log.Logger

var TRACE *log.Logger

var WARN *log.Logger

/* 2 unexporteds ... *//* 2 unexporteds: */

var defaultNotepad *Notepad

var prefixes map[Threshold]string

Package-Level Constants (total 7, all are exported)

const LevelCritical Threshold = 5

const LevelDebug Threshold = 1

const LevelError Threshold = 4

const LevelFatal Threshold = 6

const LevelInfo Threshold = 2

const LevelTrace Threshold = 0

const LevelWarn Threshold = 3