slug

README

🐌 slug

a simple object-oriented pretty-logging library for go.
slug is designed as a drop-in for the log functions I use the most and also adds some utility functions to make life easier.

examples

examples can be found in demo

Documentation

Index

• Variables
• func Debug(v ...any)
• func Error(v ...any)
• func Fatal(v ...any)
• func Info(v ...any)
• func Panic(v ...any)
• func Println(v ...any)
• func Warning(v ...any)
• type Logger
  • func NewLogger() *Logger
  • func (l *Logger) Close() error
  • func (l *Logger) Debug(v ...any)
  • func (l *Logger) DisableColor()
  • func (l *Logger) EnableColor()
  • func (l *Logger) Error(v ...any)
  • func (l *Logger) Fatal(v ...any)
  • func (l *Logger) Info(v ...any)
  • func (l *Logger) Panic(v ...any)
  • func (l *Logger) Println(v ...any)
  • func (l *Logger) Sdebug(v ...any) string
  • func (l *Logger) Sdebugf(format string, v ...any) string
  • func (l *Logger) Serror(v ...any) string
  • func (l *Logger) Serrorf(format string, v ...any) string
  • func (l *Logger) SetErrOutput(w io.Writer)
  • func (l *Logger) SetErrOutputFile(path string) error
  • func (l *Logger) SetLevel(lvl int)
  • func (l *Logger) SetOutput(w io.Writer)
  • func (l *Logger) SetOutputFile(path string) error
  • func (l *Logger) Sinfo(v ...any) string
  • func (l *Logger) Sinfof(format string, v ...any) string
  • func (l *Logger) Sprint(v ...any) string
  • func (l *Logger) Sprintf(format string, v ...any) string
  • func (l *Logger) Swarning(v ...any) string
  • func (l *Logger) Swarningf(format string, v ...any) string
  • func (l *Logger) Warning(v ...any)
  • func (l *Logger) Write(b []byte)
  • func (l *Logger) WriteErr(b []byte)

Variables

var (
	NoLevel      = -2 // log without level, level-less logs will always be printed regardless of logger level
	DebugLevel   = -1 // log at >= debug level
	InfoLevel    = 0  // log at >= info level
	WarningLevel = 1  // log at >= warning level
	ErrorLevel   = 2  // log at >= error level
	Disabled     = 3  // log at > error level (disable the logger)
)

Functions

func Debug

func Debug(v ...any)

Debug prints a log-entry at debug level to the default writer

func Error

func Error(v ...any)

Error prints a log-entry at error level to the default writer

func Fatal

func Fatal(v ...any)

Fatal prints a log-entry at the default error level and exits with 1

func Info

func Info(v ...any)

Info prints a log-entry at info level to the default writer

func Panic

func Panic(v ...any)

Panic prints a log-entry at the default error level and panics

func Println

func Println(v ...any)

Println prints a level-less log-entry to the default writer

func Warning

func Warning(v ...any)

Warning prints a log-entry at warning level to the default writer

Types

type Logger

type Logger struct {
	Level         int       // the minimum log level the logger will output
	Output        io.Writer // default output of the logger
	ErrOutput     io.Writer // default output for warning and error level logs
	DefaultFormat string    // formatstring for level-less logs
	DefaultPrefix string    // message prefix for level-less logs
	DefaultSuffix string    // message suffix for level-less logs
	DebugFormat   string    // formatstring for debug level logs
	DebugPrefix   string    // message prefix for debug level logs
	DebugSuffix   string    // message suffix for debug level logs
	InfoFormat    string    // formatstring for info level logs
	InfoPrefix    string    // message prefix for info level logs
	InfoSuffix    string    // message suffix for info level logs
	WarningFormat string    // formatstring for warning level logs
	WarningPrefix string    // message prefix for warning level logs
	WarningSuffix string    // message suffix for warning level logs
	ErrorFormat   string    // formatstring for error level logs
	ErrorPrefix   string    // message prefix for error level logs
	ErrorSuffix   string    // message suffix for error level logs
}

var DefaultLogger *Logger // logger using default configuration

func NewLogger

func NewLogger() *Logger

NewLogger returns a new default Logger and should be used in most cases

func (*Logger) Close

func (l *Logger) Close() error

Close closes the loggers output file if one is set

func (*Logger) Debug

func (l *Logger) Debug(v ...any)

Debug prints a log-entry at debug level to the given writer

func (*Logger) DisableColor

func (l *Logger) DisableColor()

DisableColor removes the coloring from the default level prefixes/suffixes

func (*Logger) EnableColor

func (l *Logger) EnableColor()

EnableColor resets the coloring on the default level prefixes/suffixes

func (*Logger) Error

func (l *Logger) Error(v ...any)

Error prints a log-entry at error level to the given writer

func (*Logger) Fatal

func (l *Logger) Fatal(v ...any)

Fatal prints a log-entry at error level and exits with 1

func (*Logger) Info

func (l *Logger) Info(v ...any)

Info prints a log-entry at info level to the given writer

func (*Logger) Panic

func (l *Logger) Panic(v ...any)

Panic prints a log-entry at error level and panics

func (*Logger) Println

func (l *Logger) Println(v ...any)

Println prints a level-less log-entry to the given writer

func (*Logger) Sdebug

func (l *Logger) Sdebug(v ...any) string

Sdebug returns a log-entry at debug level

func (*Logger) Sdebugf

func (l *Logger) Sdebugf(format string, v ...any) string

Sdebugf returns a log-entry at debug level following the format

func (*Logger) Serror

func (l *Logger) Serror(v ...any) string

Serror returns a log-entry at error level

func (*Logger) Serrorf

func (l *Logger) Serrorf(format string, v ...any) string

Serrorf returns a log-entry at error level following the format

func (*Logger) SetErrOutput

func (l *Logger) SetErrOutput(w io.Writer)

SetErrOutput sets the loggers output for error and warning level logs to the given writer

func (*Logger) SetErrOutputFile

func (l *Logger) SetErrOutputFile(path string) error

SetErrOutputFile sets the loggers output for error and warning level logs to a file, it should be closed with Close() the given path will be appended to

func (*Logger) SetLevel

func (l *Logger) SetLevel(lvl int)

SetLevel sets the loggers level

func (*Logger) SetOutput

func (l *Logger) SetOutput(w io.Writer)

SetOutput sets the loggers default output to the given writer

func (*Logger) SetOutputFile

func (l *Logger) SetOutputFile(path string) error

SetOutputFile sets the default loggers output to a file, it should be closed with Close() the given path will be appended to

func (*Logger) Sinfo

func (l *Logger) Sinfo(v ...any) string

Sinfo returns a log-entry at info level

func (*Logger) Sinfof

func (l *Logger) Sinfof(format string, v ...any) string

Sinfof returns a log-entry at info level following the format

func (*Logger) Sprint

func (l *Logger) Sprint(v ...any) string

Sprint returns a level-less log-entry

func (*Logger) Sprintf

func (l *Logger) Sprintf(format string, v ...any) string

Sprintf returns a level-less log-entry following the format

func (*Logger) Swarning

func (l *Logger) Swarning(v ...any) string

Swarning returns a log-entry at warning level

func (*Logger) Swarningf

func (l *Logger) Swarningf(format string, v ...any) string

Swarningf returns a log-entry at warning level following the format

func (*Logger) Warning

func (l *Logger) Warning(v ...any)

Warning prints a log-entry at warning level to the given writer

func (*Logger) Write

func (l *Logger) Write(b []byte)

Write writes bytes to the logger's writer, falls back to stdout if error and panics if even that fails

func (*Logger) WriteErr

func (l *Logger) WriteErr(b []byte)

WriteErr writes bytes to the logger's writer, falls back to Write() if error and panics if even that fails