logger

README

go-logger

Logging package

Documentation

Index

• Constants
• type Event
  • func NewEvent(msg string, component string, logLevel VerbosityLevel) Event
  • func (e Event) EventString() (string, VerbosityLevel)
  • func (e Event) Write(l *Logger)
• type LevelType
  • func GetDefaultLevelTypes() []LevelType
  • func RetrieveLevel(levelType []LevelType, level VerbosityLevel) LevelType
• type Logger
  • func NewLogger() *Logger
  • func (l *Logger) Init()
  • func (l *Logger) NewEvent(e Event)
  • func (l *Logger) SetLevels(levelType []LevelType)
  • func (l *Logger) WriteLogFile() error
• type VerbosityLevel

Constants

const ChanBuffSize = 10

ChanBuffSize defines the size of channel buffers

Types

type Event

type Event struct {
	Message   string         `json:"message"`
	Component string         `json:"component"`
	Time      time.Time      `json:"time"`
	Level     VerbosityLevel `json:"level"`
}

Event contains log message and metadata

func NewEvent

func NewEvent(msg string, component string, logLevel VerbosityLevel) Event

NewEvent creates an event

func (Event) EventString

func (e Event) EventString() (string, VerbosityLevel)

EventString return a formatted string and the VerbosityLevel

func (Event) Write

func (e Event) Write(l *Logger)

Write commits the event to the logger

type LevelType

type LevelType struct {
	Name  string
	Level VerbosityLevel
}

LevelType defines level types

func GetDefaultLevelTypes

func GetDefaultLevelTypes() []LevelType

GetDefaultLevelTypes returns default level type schema

func RetrieveLevel

func RetrieveLevel(levelType []LevelType, level VerbosityLevel) LevelType

RetrieveLevel return the LevelType that matches VerbosityLevel

type Logger

type Logger struct {
	In chan Event

	// RotationLen defines how many log entries to keep in memory/log to file
	RotationLen int
	// RetainLogs should be set to true to save logs to a file
	RetainLogs bool

	LogPrefix   string
	LogFileDir  string
	LogFilePerm os.FileMode
	// contains filtered or unexported fields
}

Logger should be initialized if created manually and Handle() method should be called to start logging

func NewLogger

func NewLogger() *Logger

NewLogger creates and initialites a logger

func (*Logger) Init

func (l *Logger) Init()

Init intializes the logger (makes channels, maps)

func (*Logger) NewEvent

func (l *Logger) NewEvent(e Event)

NewEvent pushes a new event into the channel In

func (*Logger) SetLevels

func (l *Logger) SetLevels(levelType []LevelType)

SetLevels sets internal levels to new - user provided levels

func (*Logger) WriteLogFile

func (l *Logger) WriteLogFile() error

WriteLogFile writes the log to a file on the disk

type VerbosityLevel

type VerbosityLevel int

VerbosityLevel contains the log verbosity level (WARNING, ERROR, FATAL, ...)