log

Documentation

Overview

Package log defines the log interface for logging data.

Instances of Logger is used throughout the framework to log information, errors and debug messages. The package also instantiates DefaultLogger that can be used to log impromptu within the framework.

Index

• func Debug(s string)
• func Destroy()
• func Error(s string)
• func Fatal(s string)
• func Info(s string)
• func Init(c config.LogConfig)
• func SetLevel(l string)
• func Warn(s string)
• type LogParams
• type Logger
  • func NewLogger(c config.LogConfig) *Logger
  • func With(params LogParams) *Logger
  • func (l *Logger) Debug(s string)
  • func (l *Logger) Destroy()
  • func (l *Logger) Error(s string)
  • func (l *Logger) Fatal(s string)
  • func (l *Logger) Info(s string)
  • func (l *Logger) SetLevel(level string)
  • func (l *Logger) Warn(s string)
  • func (l *Logger) With(params LogParams) *Logger

Functions

func Debug

func Debug(s string)

Debug logs a debug message with the default logger

func Destroy

func Destroy()

Destroy closes the log file

func Error

func Error(s string)

Errors logs a message with level `error` with the default logger

func Fatal

func Fatal(s string)

Fatal logs the message and exits with non-zero exit code with the default logger

func Info

func Info(s string)

Info logs a message with level `info` with the default logger

func Init

func Init(c config.LogConfig)

Init initializes the default logger with a log path if specified

func SetLevel

func SetLevel(l string)

SetLevel sets the level of the default logger

func Warn

func Warn(s string)

Warn logs a message with level `warning` with the default logger

Types

type LogParams

type LogParams map[string]interface{}

LogParams wrapper around key values used for logging

type Logger

type Logger struct {
	// contains filtered or unexported fields
}

Logger for logging

var DefaultLogger *Logger

DefaultLogger stores the instance of the DefaultLogger

func NewLogger

func NewLogger(c config.LogConfig) *Logger

NewLogger instantiates logger based on the config

func With

func With(params LogParams) *Logger

With returns a logger with the specified parameters

func (*Logger) Debug

func (l *Logger) Debug(s string)

Debug logs a debug message

func (*Logger) Destroy

func (l *Logger) Destroy()

Destroy should be called when exiting to close the log file

func (*Logger) Error

func (l *Logger) Error(s string)

Error logs a message with level `error`

func (*Logger) Fatal

func (l *Logger) Fatal(s string)

Fatal logs the message and exits with non-zero exit code

func (*Logger) Info

func (l *Logger) Info(s string)

Info logs a message with level `info`

func (*Logger) SetLevel

func (l *Logger) SetLevel(level string)

SetLevel sets the level of the logger

func (*Logger) Warn

func (l *Logger) Warn(s string)

Warn logs a message with level `warning`

func (*Logger) With

func (l *Logger) With(params LogParams) *Logger

With returns a logger initialized with the parameters