pieterclaerhout / go-log

A logging library with strack traces, object dumping and optional timestamps

go-log

This is a Golang library with logging related functions which I use in my different projects.

Usage

package main

import (
    "github.com/pieterclaerhout/go-log"
)

func main() {

    log.DebugMode = true
    log.PrintTimestamp = true
    log.PrintColors = true
    log.TimeFormat = "2006-01-02 15:04:05.000"

    myVar := map[string]string{"hello": "world"}

    log.Debug("arg1", "arg2")
    log.Debugf("arg1 %d", 1)
    log.DebugDump(myVar, "prefix")
    log.DebugSeparator("title")

    log.Info("arg1", "arg2")
    log.Infof("arg1 %d", 1)
    log.InfoDump(myVar, "prefix")
    log.InfoSeparator("title")

    log.Warn("arg1", "arg2")
    log.Warnf("arg1 %d", 1)
    log.WarnDump(myVar, "prefix")
    log.WarnSeparator("title")

    log.Error("arg1", "arg2")
    log.Errorf("arg1 %d", 1)
    log.ErrorDump(myVar, "prefix")
    log.ErrorSeparator("title")

    log.Fatal("arg1", "arg2")
    log.Fatalf("arg1 %d", 1)

    err1 := funcWithError()
    log.StackTrace(err1)

    err2 := funcWithError()
    log.CheckError(err2)

}

Environment variables

The defaults are taken from the environment variables:

• DEBUG: log.DebugMode
• PRINT_TIMESTAMP: log.PrintTimestamp

go-log's Issues

Race condition during writing

==================
WARNING: DATA RACE
Write at 0x00c0001364d8 by goroutine 7:
  github.com/fatih/color.(*Color).EnableColor()
      github.com/fatih/[email protected]/color.go:386 +0x173
  github.com/pieterclaerhout/go-log.printColoredMessage()
      github.com/pieterclaerhout/[email protected]/logger_internal.go:76 +0x12f
  github.com/pieterclaerhout/go-log.printMessage()
      github.com/pieterclaerhout/[email protected]/logger_internal.go:61 +0xd0
  github.com/pieterclaerhout/go-log.Info()
      github.com/pieterclaerhout/[email protected]/logger.go:109 +0x79
  github.com/pieterclaerhout/go-geoip/v2/serverapp.dbUpdaterJob.run()
      github.com/pieterclaerhout/go-geoip/v2/serverapp/job_download.go:17 +0x9a

Previous write at 0x00c0001364d8 by main goroutine:
  github.com/fatih/color.(*Color).EnableColor()
      github.com/fatih/[email protected]/color.go:386 +0x173
  github.com/pieterclaerhout/go-log.printColoredMessage()
      github.com/pieterclaerhout/[email protected]/logger_internal.go:76 +0x12f
  github.com/pieterclaerhout/go-log.printMessage()
      github.com/pieterclaerhout/[email protected]/logger_internal.go:61 +0xd0
  github.com/pieterclaerhout/go-log.Info()
      github.com/pieterclaerhout/[email protected]/logger.go:109 +0x79
  github.com/pieterclaerhout/go-webserver/v2.(*Server).RunWithApps()
      github.com/pieterclaerhout/go-webserver/[email protected]/server.go:44 +0x6c2
  main.main()
      github.com/pieterclaerhout/go-geoip/v2/cmd/geoip-server/main.go:26 +0x25f

Goroutine 7 (running) created at:
  github.com/pieterclaerhout/go-geoip/v2/serverapp.New()
      github.com/pieterclaerhout/go-geoip/v2/serverapp/serverapp.go:39 +0x4f5
  main.main()
      github.com/pieterclaerhout/go-geoip/v2/cmd/geoip-server/main.go:27 +0x21a
==================

Allow configuration via environment variables

So that you can choose to either use the config settings or environment variables for the configuration.

Colored output seems to be broken on Windows Command Prompt

Not sure if it's even supposed to be working anyway, but it would be nice if we could get it to work.

Log output coloring doesn't always work correctly

E.g. when using it in the Lens Kubernetes client, it doesn't color the output…

Add support for printing log messages in color

Or add support for colors again…

Crash on Windows because of timezone

your example in readme fails to compile

undefined: log.WarnSeparator
undefined: log.ErrorSeparator

Add log function variants which can use formatting

In the same way as you have with fmt.Sprintf

Tests are broken because of Windows fix

411f652

Use eris for error formatting?

https://github.com/rotisserie/eris