logger

Documentation

Index

• Constants
• func Debugf(format string, args ...interface{})
• func Errorf(format string, args ...interface{})
• func Fatalf(format string, args ...interface{})
• func Infof(format string, args ...interface{})
• func NewLogger(config Configuration, loggerInstance int) error
• func Panicf(format string, args ...interface{})
• func Warnf(format string, args ...interface{})
• type Configuration
• type Fields
• type Logger
  • func WithFields(keyValues Fields) Logger

Constants

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"
)

const (
	// InstanceZapLogger instance for zap logger
	InstanceZapLogger int = iota
)

Functions

func Debugf

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

Debugf logs a debug message

func Errorf

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

Errorf logs error message

func Fatalf

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

Fatalf logs fatal errors and exits

func Infof

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

Infof logs informative message

func NewLogger

func NewLogger(config Configuration, loggerInstance int) error

NewLogger returns an instance of logger

func Panicf

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

Panicf create a panic log

func Warnf

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

Warnf logs warning message

Types

type Configuration

type Configuration struct {
	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

type Fields

type Fields map[string]interface{}

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

type Logger

type Logger interface {
	Debugf(format string, args ...interface{})

	Infof(format string, args ...interface{})

	Warnf(format string, args ...interface{})

	Errorf(format string, args ...interface{})

	Fatalf(format string, args ...interface{})

	Panicf(format string, args ...interface{})

	WithFields(keyValues Fields) Logger
}

Logger is our contract for the logger

func WithFields

func WithFields(keyValues Fields) Logger

WithFields returns logger with fields