log

README

log

This is an attempt to modify the default golang 'log'. Because the 'gui' toolkit could be either ncurses or something like gtk, 'log' is an attempt to be smart about changing STDOUT on the fly.

• add meaningful shortcuts like log.Info(), log.Warn(), log.Error() etc
• add flags to enable & disable output on a per-gomodule basis
• add http flag to switch stdout to http socket
• compatible with changing import 'log' to import 'go.wit.com/log'
• should also be compatible with changing import 'fmt' to import fmt 'go.wit.com/log'

Notes & Goals:

• be a complete droplet replacement for golang 'log'
• provide an example of how the stdlib 'log' could be changed

Documentation

Index

• func Bool(b bool, a ...any)
• func CaptureMode(w io.Writer)
• func DaemonMode(b bool)
• func DaemonShow() bool
• func Error(err error, a ...any)
• func Exit(a ...any)
• func Fatal(s string, a ...any)
• func Fatalf(s string, a ...any)
• func Fatalln(a ...any)
• func HttpMode(w http.ResponseWriter)
• func Info(a ...any)
• func Infof(s string, a ...any)
• func Log(f *LogFlag, a ...any)
• func Logf(f *LogFlag, s string, a ...any)
• func Printf(s string, a ...any)
• func Println(a ...any)
• func ProcessFlags(callback func(*LogFlag))
• func SetAll(b bool)
• func SetDefaults()
• func SetTmpOLD()
• func Sleep(a ...any)
• func Spew(b any, a ...any)
• func Sprint(a ...any) string
• func Sprintf(s string, a ...any) string
• func Sprintln(a ...any) string
• func UnsetTmp()
• func Verbose(a ...any)
• func Warn(a ...any)
• type LogFlag
  • func NewFlag(name string, b bool, full, short, desc string) *LogFlag
  • func ShowFlags() []*LogFlag
  • func (f *LogFlag) Bool() bool
  • func (f *LogFlag) Get() bool
  • func (f *LogFlag) GetDefault() bool
  • func (f *LogFlag) GetDesc() string
  • func (f *LogFlag) GetName() string
  • func (f *LogFlag) GetSubsystem() string
  • func (f *LogFlag) Ok() bool
  • func (f *LogFlag) SetBool(b bool)
  • func (f *LogFlag) SetDefault()

Functions

func Bool

func Bool(b bool, a ...any)

func CaptureMode

func CaptureMode(w io.Writer)

func DaemonMode

func DaemonMode(b bool)

func DaemonShow

func DaemonShow() bool

func Error

func Error(err error, a ...any)

func Exit

func Exit(a ...any)

exit() # yep. exits. I guess everything must be fine exit(3) # I guess 3 it is then exit("dont like apples") # ok. I'll make a note of that

func Fatal

func Fatal(s string, a ...any)

func Fatalf

func Fatalf(s string, a ...any)

func Fatalln

func Fatalln(a ...any)

func HttpMode

func HttpMode(w http.ResponseWriter)

func Info

func Info(a ...any)

func Infof

func Infof(s string, a ...any)

func Log

func Log(f *LogFlag, a ...any)

func Logf

func Logf(f *LogFlag, s string, a ...any)

func Printf

func Printf(s string, a ...any)

func Println

func Println(a ...any)

func ProcessFlags

func ProcessFlags(callback func(*LogFlag))

TODO, switch to this. maybe.

func SetAll

func SetAll(b bool)

set all the flags

func SetDefaults

func SetDefaults()

set all the flags

func SetTmpOLD

func SetTmpOLD()

start writing all the logging to a tmp file

func Sleep

func Sleep(a ...any)

sleep() # you know what this does? sleeps for 1 second. yep. dump. easy. sleep(.1) # you know what this does? yes, it sleeps for 1/10th of a second

func Spew

func Spew(b any, a ...any)

func Sprint

func Sprint(a ...any) string

func Sprintf

func Sprintf(s string, a ...any) string

func Sprintln

func Sprintln(a ...any) string

func UnsetTmp

func UnsetTmp()

start writing all the logging to a tmp file

func Verbose

func Verbose(a ...any)

func Warn

func Warn(a ...any)

Types

type LogFlag

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

var ERROR *LogFlag // toggles log.Warn() (true by default)

var INFO *LogFlag // toggles log.Info()

var PRINTLN *LogFlag // toggles log.Println() (true by default)

var SPEW *LogFlag // toggles log.Spew()

var VERBOSE *LogFlag // toggles log.Verbose()

var WARN *LogFlag // toggles log.Warn() (true by default)

func NewFlag

func NewFlag(name string, b bool, full, short, desc string) *LogFlag

this is what the current log.SetFlag() function should become

func ShowFlags

func ShowFlags() []*LogFlag

this bypasses all checks and _always_ logs the info to STDOUT is this a bad idea? Probably not.... TODO: returning []*LogFlag is not safe and access must be locked but this is only used by the log debugging window at this time

func (*LogFlag) Bool

func (f *LogFlag) Bool() bool

probably a better name than Get() switch to this

func (*LogFlag) Get

func (f *LogFlag) Get() bool

returns the value of the flag

func (*LogFlag) GetDefault

func (f *LogFlag) GetDefault() bool

returns the description of the flag

func (*LogFlag) GetDesc

func (f *LogFlag) GetDesc() string

returns the description of the flag

func (*LogFlag) GetName

func (f *LogFlag) GetName() string

returns the name of the flag

func (*LogFlag) GetSubsystem

func (f *LogFlag) GetSubsystem() string

returns the subsystem of the flag

func (*LogFlag) Ok

func (f *LogFlag) Ok() bool

simply protects against panic() by making sure it exists.

func (*LogFlag) SetBool

func (f *LogFlag) SetBool(b bool)

func (*LogFlag) SetDefault

func (f *LogFlag) SetDefault()

restores flag to it's default value