lumber

README

🪵 lumber 🪵

A dead simple, pretty, and feature-rich logger for golang

---

• 🚀 Install
• 🌲 Logging Functions
  • lumber.Success()
  • lumber.Info()
  • lumber.Debug()
  • lumber.Warning()
  • lumber.Error()
  • lumber.ErrorMsg()
  • lumber.Fatal()
  • lumber.FatalMsg()
• ⚙️ Customization
• ✨ Examples
• 🙌 Contributing
• 👥 Contributors

🚀 Install

Simply run the following from your project root:

go get -u github.com/gleich/lumber/v2

🌲 Logging Functions

lumber.Success()

Output a success log.

Demo:

package main

import (
    "time"

    "github.com/gleich/lumber/v2"
)

func main() {
    lumber.Success("Loaded up the program!")
    time.Sleep(2 * time.Second)
    lumber.Success("Waited 2 seconds!")
}

Outputs:

lumber.Info()

Output an info log.

Demo:

package main

import (
    "time"

    "github.com/gleich/lumber/v2"
)

func main() {
    lumber.Info("Getting the current year")
    now := time.Now()
    lumber.Info("Current year is", now.Year())
}

Outputs:

lumber.Debug()

Output a debug log.

Demo:

package main

import (
    "os"

    "github.com/gleich/lumber/v2"
)

func main() {
    homeDir, _ := os.UserHomeDir()
    lumber.Debug("User's home dir is", homeDir)
}

Outputs:

lumber.Warning()

Output a warning log.

Demo:

package main

import (
    "time"

    "github.com/gleich/lumber/v2"
)

func main() {
    now := time.Now()
    if now.Year() != 2004 {
        lumber.Warning("Current year isn't 2004")
    }
}

Outputs:

lumber.Error()

Output an error log with a stack trace.

Demo:

package main

import (
    "os"

    "github.com/gleich/lumber/v2"
)

func main() {
    fname := "invisible-file.txt"
    _, err := os.ReadFile(fName)
    if err != nil {
        lumber.Error(err, "Failed to read from", fname)
    }
}

Outputs:

lumber.ErrorMsg()

Output an error message.

Demo:

package main

import "github.com/gleich/lumber/v2"

func main() {
    lumber.ErrorMsg("Ahhh stuff broke")
}

Outputs:

lumber.Fatal()

Output a fatal log with a stack trace.

Demo:

package main

import (
    "os"

    "github.com/gleich/lumber/v2"
)

func main() {
    fName := "invisible-file.txt"
    _, err := os.ReadFile(fName)
    if err != nil {
        lumber.Fatal(err, "Failed to read from", fName)
    }
}

Outputs:

lumber.FatalMsg()

Output a fatal message.

Demo:

package main

import "github.com/gleich/lumber/v2"

func main() {
    lumber.FatalMsg("Ahhh stuff broke")
}

Outputs:

⚙️ Customization

You can customize lumber by creating a custom logger and changing values on it. You then call the log functions on the custom logger. Below is an example of this.

package main

import "github.com/gleich/lumber/v2"

func main() {
    log := lumber.NewCustomLogger()
    log.ColoredOutput = false
    log.ExitCode = 2

    log.Success("Calling from custom logger!")
}

Here are all the variables that can be changed:

Variable Name	Description	Default Value	Type
NormalOut	The output file for Debug, Success, Warning, and Info	os.Stdout	*os.File
ErrOut	The output file for Fatal and Error	os.Stderr	*os.File
ExtraNormalOuts	Extra normal output destinations (e.g. outputting to a file as well as stdout)	[]io.Writer{}	[]io.Writer
ExtraErrOuts	Extra error output destinations (e.g. outputting to a file as well as stderr)	[]io.Writer{}	[]io.Writer
ExitCode	Fatal exit code	1	int
Padding	If the log should have an extra new line at the bottom	false	bool
ColoredOutput	If the output should have color	true	bool
TrueColor	If the output colors should be true colors. Default is true if terminal supports it.	has256ColorSupport()	bool
ShowStack	If stack traces should be shown	true	bool
Multiline	If the should should be spread out to more than one line	false	bool
Timezone	Timezone you want the times to be logged in	time.UTC	*time.Location

✨ Examples

See some examples in the examples/ folder! Just run them using go run main.go.

🙌 Contributing

Before contributing please read the CONTRIBUTING.md file.

👥 Contributors

• @gleich

• @ImgBotApp

Documentation

Index

• func Debug(ctx ...interface{})
• func Error(err error, ctx ...interface{})
• func ErrorMsg(ctx ...interface{})
• func Fatal(err error, ctx ...interface{})
• func FatalMsg(ctx ...interface{})
• func Info(ctx ...interface{})
• func Success(ctx ...interface{})
• func Warning(ctx ...interface{})
• type Logger
  • func NewCustomLogger() Logger
  • func (config Logger) Debug(ctx ...interface{})
  • func (config Logger) Error(err error, ctx ...interface{})
  • func (config Logger) ErrorMsg(ctx ...interface{})
  • func (config Logger) Fatal(err error, ctx ...interface{})
  • func (config Logger) FatalMsg(ctx ...interface{})
  • func (config Logger) Info(ctx ...interface{})
  • func (config Logger) Success(ctx ...interface{})
  • func (config Logger) Warning(ctx ...interface{})

Functions

func Debug

func Debug(ctx ...interface{})

Output a debug log

func Error

func Error(err error, ctx ...interface{})

Output an error log

func ErrorMsg

func ErrorMsg(ctx ...interface{})

Output an error log with no actual error value

func Fatal

func Fatal(err error, ctx ...interface{})

Output a fatal log

func FatalMsg

func FatalMsg(ctx ...interface{})

Output a fatal log with no actual error value

func Info

func Info(ctx ...interface{})

Output an info log

func Success

func Success(ctx ...interface{})

Output a success log

func Warning

func Warning(ctx ...interface{})

Output a warning log

Types

type Logger

type Logger struct {
	NormalOut       *os.File       // The output file for Debug, Success, Warning, and Info. Default is os.Stdout
	ErrOut          *os.File       // The output file for Fatal, FatalMsg, Error, and ErrorMsg. Default is os.Stderr
	ExtraNormalOuts []io.Writer    // Extra normal output destinations (e.g. outputting to a file as well)
	ExtraErrOuts    []io.Writer    // Extra error output destinations (e.g. outputting to a file as well)
	ExitCode        int            // Fatal exit code. Default is 1
	ShowStack       bool           // If stack trades should be included. Default is true
	Timezone        *time.Location // Timezone for the time to be outputted in. Default is time.UTC
	Padding         bool           // If the log should have an extra new line at the bottom. Default is true
	Multiline       bool           // If the log should span multiple lines. Default is false
	ColoredOutput   bool           // If the output should have color. Default is true
	TrueColor       bool           // If the output should be true color or basic colors. Default is true if the terminal supports it
}

Custom logger for lumber to use

func NewCustomLogger

func NewCustomLogger() Logger

func (Logger) Debug

func (config Logger) Debug(ctx ...interface{})

Output a debug log using a custom logger

func (Logger) Error

func (config Logger) Error(err error, ctx ...interface{})

Output an error log using a custom logger

func (Logger) ErrorMsg

func (config Logger) ErrorMsg(ctx ...interface{})

Output an error log with no actual error value using a custom logger

func (Logger) Fatal

func (config Logger) Fatal(err error, ctx ...interface{})

Output a fatal log using a custom logger

func (Logger) FatalMsg

func (config Logger) FatalMsg(ctx ...interface{})

Output a fatal log with no actual error value using a custom logger

func (Logger) Info

func (config Logger) Info(ctx ...interface{})

Output an info log using a custom logger

func (Logger) Success

func (config Logger) Success(ctx ...interface{})

Output a success log using a custom logger

func (Logger) Warning

func (config Logger) Warning(ctx ...interface{})

Output a warning log using a custom logger