logging

Documentation

Overview

Package logging - common package, used for logging purposes. Is a wrapper around 3-rd party logging framework.

Example (GetLogTarget)

conf := viper.New()
conf.Set("LOG_TARGET", "FILE")
conf.Set("LOG_DIR", ".")
conf.Set("LOG_FILE", "test.out")
v := getLogTarget(conf)
conf.Set("LOG_TARGET", "stdout")
v = getLogTarget(conf)
fmt.Printf("%T\n", v)

Output:

*os.File

Example (NewLogTargetFile)

conf := viper.New()
conf.Set("LOG_DIR", "")
newLogTargetFile(conf)

conf.Set("LOG_TARGET", "FILE")
conf.Set("LOG_DIR", ".")
conf.Set("LOG_FILE", "test.out")
newLogTargetFile(conf)

conf.Set("LOG_TARGET", "stdout")
newLogTargetFile(conf)

Example (SetTimeFormat_RFC)

conf := viper.New()
conf.Set("LOG_TIME_FORMAT", "RFC3339")
setTimeFormat(conf)
fmt.Println(zerolog.TimeFieldFormat)

Output:

2006-01-02T15:04:05Z07:00

Example (SetTimeFormat_Unix)

conf := viper.New()
conf.Set("LOG_TIME_FORMAT", "Unix")
setTimeFormat(conf)
fmt.Println(zerolog.TimeFieldFormat)

Index

• func Debug(msg string, args ...interface{})
• func Error(msg string, args ...interface{})
• func Fatal(msg string, args ...interface{})
• func Info(msg string, args ...interface{})
• func Init(conf *viper.Viper) zerolog.Logger
• func InitWithoutConfig(logLevel string, logTarget string, logServiceName string, timeFormat string) zerolog.Logger
• func Panic(msg string, args ...interface{})
• func SetLogLevel(logLevel string) error
• func Trace(msg string, args ...interface{})
• func Warn(msg string, args ...interface{})

Examples

• Package (GetLogTarget)
• Package (NewLogTargetFile)
• Package (SetTimeFormat_RFC)
• Package (SetTimeFormat_Unix)
• Info
• Init
• InitWithoutConfig
• Panic

Functions

func Debug

func Debug(msg string, args ...interface{})

Debug is wrapper over logger's debug.

func Error

func Error(msg string, args ...interface{})

Error is wrapper over logger's error.

func Fatal

func Fatal(msg string, args ...interface{})

Fatal is wrapper over logger's fatal.

func Info

func Info(msg string, args ...interface{})

Info is wrapper over logger's info.

Example

Trace("trace")
Debug("debug")
Info("info")
Warn("warn")
Error("error")

func Init

func Init(conf *viper.Viper) zerolog.Logger

Init initialises the logger with a Viper object.

Example

conf := viper.New()
l := Init(conf)
fmt.Printf("%T\n", l)

Output:

zerolog.Logger

func InitWithoutConfig

func InitWithoutConfig(logLevel string, logTarget string, logServiceName string, timeFormat string) zerolog.Logger

InitWithoutConfig initialises the logger without a Viper object.

Example

l := InitWithoutConfig("logLevel", "init1.out", "logServiceName", "timeFormat")
fmt.Printf("%T\n", l)

Output:

zerolog.Logger

func Panic

func Panic(msg string, args ...interface{})

Panic is wrapper over logger's panic.

Example

SetLogLevel("error")
defer func() {
	if err := recover(); err != nil {
		fmt.Println(err)
	}
}()
Panic("test Panic message")

Output:

test Panic message

func SetLogLevel

func SetLogLevel(logLevel string) error

SetLogLevel sets the logging level.

func Trace

func Trace(msg string, args ...interface{})

Trace is wrapper over logger's trace.

func Warn

func Warn(msg string, args ...interface{})

Warn is wrapper over logger's warn.