logger

Documentation

Index

• Constants
• Variables
• func GetLogLevel() logrus.Level
• func GetLogger() logrus.FieldLogger
• func InitializeDefaultLogger() (logger *logrus.Logger)
• func PopulateLogOpts(o LogOptions, level string, format string)
• func ResetLogOutput()
• func SetLogLevel(logLevel logrus.Level)
• func SetupLogging(o LogOptions, debug bool) error
• type DebugLogger
  • func NewDebugLogger(logger logrus.FieldLogger, debugEnabled bool) *DebugLogger
  • func (d *DebugLogger) Debug(args ...interface{})
  • func (d *DebugLogger) DebugLogWithCallers(nCallers int) logrus.FieldLogger
  • func (d *DebugLogger) Debugf(fmt string, args ...interface{})
• type LogFormat
• type LogOptions

Constants

const (
	LevelOpt  = "level"
	FormatOpt = "format"
)

Variables

var (
	// DefaultLogger is the base logrus logger. It is different from the logrus
	// default to avoid external dependencies from writing out unexpectedly
	DefaultLogger = InitializeDefaultLogger()
)

Functions

func GetLogLevel

func GetLogLevel() logrus.Level

func GetLogger

func GetLogger() logrus.FieldLogger

GetLogger returns the DefaultLogger that was previously setup

func InitializeDefaultLogger

func InitializeDefaultLogger() (logger *logrus.Logger)

InitializeDefaultLogger returns a logrus Logger with a custom text formatter.

func PopulateLogOpts

func PopulateLogOpts(o LogOptions, level string, format string)

PopulateLogOpts populates the logger options making sure that passed values are valid.

func ResetLogOutput

func ResetLogOutput()

func SetLogLevel

func SetLogLevel(logLevel logrus.Level)

func SetupLogging

func SetupLogging(o LogOptions, debug bool) error

SetupLogging setup logger options taking into consideration the debug flag.

Types

type DebugLogger

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

func NewDebugLogger

func NewDebugLogger(logger logrus.FieldLogger, debugEnabled bool) *DebugLogger

func (*DebugLogger) Debug

func (d *DebugLogger) Debug(args ...interface{})

func (*DebugLogger) DebugLogWithCallers

func (d *DebugLogger) DebugLogWithCallers(nCallers int) logrus.FieldLogger

func (*DebugLogger) Debugf

func (d *DebugLogger) Debugf(fmt string, args ...interface{})

type LogFormat

type LogFormat string

type LogOptions

type LogOptions map[string]string

LogOptions maps configuration key-value pairs related to logging.