logging

Documentation

Index

• Constants
• func InitLogging()
• type Configuration
  • func GetLoggerConfig(DevEnv bool, EnableConsole bool, ConsoleLevel string, ConsoleJSONFormat bool, ...) Configuration
• type Fields
• type Logger
  • func GetLogger() *Logger
  • func (l *Logger) Debug(v ...interface{})
  • func (l *Logger) Debugf(format string, args ...interface{})
  • func (l *Logger) Error(v ...interface{})
  • func (l *Logger) Errorf(format string, args ...interface{})
  • func (l *Logger) Fatal(v ...interface{})
  • func (l *Logger) Fatalf(format string, args ...interface{})
  • func (l *Logger) Info(v ...interface{})
  • func (l *Logger) Infof(format string, args ...interface{})
  • func (l *Logger) Panic(v ...interface{})
  • func (l *Logger) Panicf(format string, args ...interface{})
  • func (l *Logger) Print(v ...interface{})
  • func (l *Logger) Printf(format string, args ...interface{})
  • func (l *Logger) UnSugar()
  • func (l *Logger) Warn(v ...interface{})
  • func (l *Logger) Warnf(format string, args ...interface{})
  • func (l *Logger) WithContext(ctx context.Context)
  • func (l *Logger) WithFields(fields Fields)

Constants

const (
	RequestIDKey string = "requestID"
	SessionIDKey string = "sessionID"
)

const (
	//Debug has verbose message
	Debug = "debug"
	//Info is default log level
	Info = "info"
	//Warn is for logging messages about possible issues
	Warn = "warn"
	//Error is for logging errors
	Error = "error"
	//Fatal is for logging fatal messages. The sytem shutsdown after logging the message.
	Fatal = "fatal"
)

Functions

func InitLogging

func InitLogging()

Types

type Configuration

type Configuration struct {
	DevEnv            bool
	EnableConsole     bool
	ConsoleJSONFormat bool
	ConsoleLevel      string
	EnableFile        bool
	FileJSONFormat    bool
	FileLevel         string
	FileLocation      string
}

Configuration stores the config for the Logger For some loggers there can only be one level across writers, for such the level of Console is picked by default

func GetLoggerConfig

func GetLoggerConfig(DevEnv bool,
	EnableConsole bool,
	ConsoleLevel string,
	ConsoleJSONFormat bool,
	EnableFile bool,
	FileLevel string,
	FileJSONFormat bool,
	FileLocation string) Configuration

type Fields

type Fields map[string]interface{}

Fields Type to pass when we want to call WithFields for structured logging

type Logger

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

func GetLogger

func GetLogger() *Logger

Getter of logger instance

func (*Logger) Debug

func (l *Logger) Debug(v ...interface{})

func (*Logger) Debugf

func (l *Logger) Debugf(format string, args ...interface{})

func (*Logger) Error

func (l *Logger) Error(v ...interface{})

func (*Logger) Errorf

func (l *Logger) Errorf(format string, args ...interface{})

func (*Logger) Fatal

func (l *Logger) Fatal(v ...interface{})

func (*Logger) Fatalf

func (l *Logger) Fatalf(format string, args ...interface{})

func (*Logger) Info

func (l *Logger) Info(v ...interface{})

func (*Logger) Infof

func (l *Logger) Infof(format string, args ...interface{})

func (*Logger) Panic

func (l *Logger) Panic(v ...interface{})

func (*Logger) Panicf

func (l *Logger) Panicf(format string, args ...interface{})

func (*Logger) Print

func (l *Logger) Print(v ...interface{})

func (*Logger) Printf

func (l *Logger) Printf(format string, args ...interface{})

func (*Logger) UnSugar

func (l *Logger) UnSugar()

func (*Logger) Warn

func (l *Logger) Warn(v ...interface{})

func (*Logger) Warnf

func (l *Logger) Warnf(format string, args ...interface{})

func (*Logger) WithContext

func (l *Logger) WithContext(ctx context.Context)

func (*Logger) WithFields

func (l *Logger) WithFields(fields Fields)