log

AwesomeLog

AwesomeLog is a fully compatible drop-in replacement for the standard library logger with some awesome features.

AwesomeLog let you define log levels for each logged messages as well as a PrettyPrint function to print out objects in a pretty readable format. It also adds the option to show details of the caller like file path, function name and line number.

AwesomeLog now also provides the functionality to add custom handlers for each LogLevel.

Documentation

Documentation

Quick start

The simplest way to use AwesomeLog is to just replace the standard library log with AwesomeLog:

package main

import (
log "github.com/chris-dot-exe/AwesomeLog"
)

func main() {
log.Println("Hello World!")
}

Output: 2022/02/14 09:32:44 [INFO] Hello World!

Examples

package main
import (
    log "github.com/chris-dot-exe/AwesomeLog"
)

func main() {
    log.SetLogLevel(log.VERBOSE)

    log.Print("foobar")
}

package main
import (
    log "github.com/chris-dot-exe/AwesomeLog"
)

func main() {
    log.SetLogLevel(log.VERBOSE)

    log.Println("Foobar")
}

package main
import (
    log "github.com/chris-dot-exe/AwesomeLog"
)

func main() {
    log.SetLogLevel(log.VERBOSE)

    log.Printf("Foo%s", "Bar")
}

package main
import (
    log "github.com/chris-dot-exe/AwesomeLog"
)

type foo struct {
	Foo string
	Bar string
	Foobar struct {
		Meeps []string
	}
}

func main() {
    log.SetLogLevel(log.VERBOSE)

    foo := foo{
		Foo: "Test",
		Bar: "Test",
		Foobar: struct {
    	Meeps []string
		}{[]string{"Meep", "Meep2", "Meep2.1"}},
	}

    log.PrettyPrint(foo)
}

Output:

Examples with Loglevel

Now the interesting part:

package main
import (
    log "github.com/chris-dot-exe/AwesomeLog"
)

func main() {
    log.SetLogLevel(log.VERBOSE)

    log.Println(log.VERBOSE, "Foobar Verbose")
    log.Println(log.DEBUG, "Foobar Debug")
    log.Println(log.INFO, "Foobar Info")
    log.Println(log.WARN, "Foobar Warning")
    log.Println(log.ERROR, "Foobar Error")
    log.Println(log.CRITICAL, "Foobar PANIC MODE! aka critical")
}

Output:

Show only messages to a specific level:

The priority of the log levels is as following (highest to lowest):

NONE
CRITICAL
ERROR
WARN
INFO
DEBUG
VERBOSE

If you set the log-level to info:

package main
import (
    log "github.com/chris-dot-exe/AwesomeLog"
)

func main() {
    log.SetLogLevel(log.INFO)

    log.Println(log.VERBOSE, "Foobar Verbose")
    log.Println(log.DEBUG, "Foobar Debug")
    log.Println(log.INFO, "Foobar Info")
    log.Println(log.WARN, "Foobar Warning")
    log.Println(log.ERROR, "Foobar Error")
    log.Println(log.CRITICAL, "Foobar Critical")
}

The output is reduced to the following messages:

Config Example

package main
import (
	log "github.com/chris-dot-exe/AwesomeLog"
)

func main() {
	cfg := log.DefaultLevelConfig()

    cfg.Debug.ShowLineNumber = false
    cfg.Debug.ShowFunctionName = true
    cfg.Debug.ShowFilePath = false

	log.SetLevelConfig(cfg)
}

Custom Handler

It is possible to add custom handler for each LogLevel.
The example below shows how a custom handler for GlitchTip/Sentry can be defined:

package main

import (
  log "github.com/chris-dot-exe/AwesomeLog"
  "github.com/getsentry/sentry-go"
  "time"
)

func main() {
  // Setup GlitchTip
  sentry.Init(sentry.ClientOptions{
    Dsn: "http://0d985cf763a34732a4839eea121c2f25@localhost:8000/1",
  })
  defer sentry.Flush(time.Second * 5)
  // Setup AwesomeLog
  log.SetDefaultLevel(log.INFO)

  // Get Default Level Config
  lvlConfig := log.DefaultLevelConfig()
  // Add custom Handler
  lvlConfig.Warn.AddHandler(GlitchContextLogger)
  lvlConfig.Debug.AddHandler(GlitchContextLogger)
  lvlConfig.Info.AddHandler(GlitchMessage)
  // Set new Level Config
  log.SetLevelConfig(lvlConfig)

  logTest()
}

func GlitchContextLogger(message log.Message) {
  sentry.ConfigureScope(func(scope *sentry.Scope) {
    scope.SetContext("caller", message.Caller)
    scope.SetTag("level", message.Level.String())
  })
  sentry.CaptureMessage(message.Message)
}

func GlitchMessage(message log.Message) {
  sentry.CaptureMessage(message.Message)
}

func logTest() {
  log.Println(log.DEBUG, "some debug message")
  log.Println(log.INFO, "some info message")
  log.Println(log.WARN, "something went wrong")
  log.Println(log.VERBOSE, "verbose message, not sent to GlitchTip")
}

In GlitchTip: