PL - Simple Pretty Logger

PL is a simple, easy to use pretty logger made in go.

Note

The latest version produces the same logging output as elog along with the same available config/string options.

• PL - Simple Pretty Logger
  • Installation
  • Usage (latest)
    • All available log types/methods/funcs
  • Usage (old)
  • All Logging Functions

Installation

Below are the instructions for v0.1.2 and v0.1.4. v0.1.4 is recommended.

Latest V3 Documentation

Use `go get` to install with the latest tag `v0.1.4` (recommended)

go get -u github.com/fluffysnowman/prettylogger@v0.1.4

Import:

import pl "github.com/fluffysnowman/prettylogger"

Usage (latest)

Specify options on init seperated by commas.

All available config/string options (taken from ./pl.go package doc comment):

• TEA : british time format (dd-mm-yy hh:mm:ss.mmm)
• BURGER : american time format (mm-dd-yy hh:mm:ss.mmm)
• READABLE : readable time format (ddmonyyyy hh:mm ss.mmm s)
• FILECOLOR : write colour logs to file
• FILEONLY : write logs only to file, no stdout output etc. ..
• FILE= : write logs to specified file path, if exists, if not- created

Example usage:

pl.InitPrettyLogger("V3")                                       // original (just times, no dates) time format
pl.InitPrettyLogger("V3,TEA")                                   // TEA (bri'ish) time format
pl.InitPrettyLogger("V3,BURGER,FILECOLOR")                      // BURGER (american) time + colored file
pl.InitPrettyLogger("V3,READABLE,FILEONLY,FILE=logfile.log")    // readable time w/ month names etc, file-only written to logfile.log

All available log types/methods/funcs

pl.Log("info message")
pl.LogDebug("debug message")
pl.LogWarn("warning message")
pl.LogError("error message")
pl.LogFatal("some fatal msg")

Older documentation (copy pasted, not updated)

## Installation

Use go get to install with the latest tag v0.1.2 (recommended)

go get -u github.com/fluffysnowman/prettylogger@v0.1.2

or

Go's module suppert automatically fetches all the dependencies needed when you import it in your code so go get isn't required, however for this project, the go get installation is recommended with a specified tag (see the code block above for instructions).

// Importing and setting an alias to `pl` 
import pl "github.com/fluffysnowman/prettylogger"

Usage (old)

Initialise the pretty logger with a config (can be SIMPLE, SIMPLE2 or TIMEBASED) which is automatically used everywhere once set.

Basic example:

package main

import (
  pl "github.com/fluffysnowman/prettylogger"
)

func main() {
  pl.InitPrettyLogger("SIMPLE")       // basic 
  pl.LogInfo("Hello World")
}

Using timestamps:

package main

import (
  pl "github.com/fluffysnowman/prettylogger"
)

func main() {
  pl.InitPrettyLogger("TIMEBASED")    // shows timestamps
  pl.Log("Hello World")
}

Using the new SIMPLE2 format:

package main

import (
  pl "github.com/fluffysnowman/prettylogger"
)

func main() {
  pl.InitPrettyLogger("SIMPLE2")    // detailed and concise format (new)
  pl.Log("Hello World")
}

[!IMPORTANT]
Note that SIMPLE, SIMPLE2 and TIMEBASED cannot be used together. Changing or setting the InitPrettyLogger() multiple times may cause problems.

Multiple arguments:

pl.LogDebug("this is a debug log %v", "foo bar")

All Logging Functions

Below is a list of all the available functions.

pl.InitPrettyLogger(opts)  // Accepts "SIMPLE", "SIMPLE2" or "TIMEBASED"

pl.Log()          // green
pl.LogDebug()     // cyan 
pl.LogError()     // red
pl.LogInfo()      // cyan
pl.LogWarn()      // yellow
pl.LogFatal()     // red
pl.LogSuccess()   // green
pl.LogFailure()   // yellow
pl.LogOK()        // green
pl.LogErrorBG()   // red background, white text
pl.LogFailureBG() // yellow background, white text