bragi

README

Bragi

Bragi is a simple log lib that is designed to be a dropin repleasement for go's std log lib. But with log output that reflect the output given with java logback. This lib is also going to rotate log files and remove old logs.

Contents

• Bragi
  • Contents
  • How to use
  • Extra functions

How to use

This is a dropin replace ment, so just add the dependencie and use it as you would do go log. To log to file add the following

log.SetPrefix("vili")
cloaser := log.SetOutputFolder(logDir)
if cloaser == nil {
	log.Fatal("Unable to sett logdir")
}
defer cloaser()

SetPrefix sets the prefix name of the logs. When they rotate the one without any time data in the name is the current and the rest will have the date appended.

SetOutputFolder creates and sets the output folder for bouth human and json logs and returns a function to cloase the files if the process was successfull.

To use the rotating feature add a call to log.StartRotate(done chan func()) after the code example above. Full example below

log.SetPrefix("vili")
cloaser := log.SetOutputFolder(logDir)
if cloaser == nil {
	log.Fatal("Unable to sett logdir")
}
defer cloaser()
log.StartRoute(nil)

Extra functions

If you want to add an error to debug, info, notice, error, crit, fatal with the following pattern

 log.AddError(err).Debug("Information about the error") 

With that pattern you will get bouth the error and the information text in the same log object

Documentation

Index

• Constants
• func AddError(e error) logData
• func Closer()
• func Crit(a ...interface{})
• func Debug(a ...interface{})
• func Error(a ...interface{})
• func Fatal(a ...interface{})
• func Fatalf(format string, a ...interface{})
• func FileExists(path string) bool
• func Info(a ...interface{})
• func NewLogFiles(path, jsonPath string) (hf *os.File, jf *os.File, err error)
• func Notice(a ...interface{})
• func Printf(format string, a ...interface{})
• func Println(a ...interface{})
• func Rotate(path, jsonPath string) (hf *os.File, jf *os.File, err error)
• func SetLevel(l Level)
• func SetOutputFolder(path string) func()
• func SetPrefix(p string)
• func StartRotate(done <-chan func())
• func TruncateTale(path string)
• func Warning(a ...interface{})
• type Level
  • func (l Level) String() string
• type Stringer

Constants

const (
	B int64 = 1 << (10 * iota)
	KB
	MB
	GB
	TB
	PB
	EB
)

Functions

func AddError

func AddError(e error) logData

func Closer

func Closer()

func Crit

func Crit(a ...interface{})

func Debug

func Debug(a ...interface{})

func Error

func Error(a ...interface{})

func Fatal

func Fatal(a ...interface{})

func Fatalf

func Fatalf(format string, a ...interface{})

func FileExists

func FileExists(path string) bool

func Info

func Info(a ...interface{})

func NewLogFiles

func NewLogFiles(path, jsonPath string) (hf *os.File, jf *os.File, err error)

func Notice

func Notice(a ...interface{})

func Printf

func Printf(format string, a ...interface{})

func Println

func Println(a ...interface{})

func Rotate

func Rotate(path, jsonPath string) (hf *os.File, jf *os.File, err error)

func SetLevel

func SetLevel(l Level)

func SetOutputFolder

func SetOutputFolder(path string) func()

func SetPrefix

func SetPrefix(p string)

func StartRotate

func StartRotate(done <-chan func())

func TruncateTale

func TruncateTale(path string)

func Warning

func Warning(a ...interface{})

Types

type Level

type Level int

const (
	DEBUG Level = iota
	INFO
	NOTICE
	WARNING
	ERROR
	CRIT
)

func (Level) String

func (l Level) String() string

type Stringer

type Stringer interface {
	String() string
}