log

Documentation

Index

• func GetLevel(module string) spilog.Level
• func HideCallerInfo(module string, level spilog.Level)
• func Initialize(l spilog.LoggerProvider)
• func IsCallerInfoEnabled(module string, level spilog.Level) bool
• func IsEnabledFor(module string, level spilog.Level) bool
• func ParseLevel(level string) (spilog.Level, error)
• func SetLevel(module string, level spilog.Level)
• func ShowCallerInfo(module string, level spilog.Level)
• type Log
  • func New(module string) *Log

Functions

func GetLevel

func GetLevel(module string) spilog.Level

GetLevel - getting log level for given module

Parameters:
module is module name

Returns:
logging level

If not set default logging level is info.

func HideCallerInfo

func HideCallerInfo(module string, level spilog.Level)

HideCallerInfo - Do not show caller info in log lines for given log level and module

Parameters:
module is module name
level is logging level

note: based on implementation of custom logger, callerinfo info may not be available for custom logging provider

func Initialize

func Initialize(l spilog.LoggerProvider)

Initialize sets new custom logging provider which takes over logging operations. It is required to call this function before making any loggings for using custom loggers.

func IsCallerInfoEnabled

func IsCallerInfoEnabled(module string, level spilog.Level) bool

IsCallerInfoEnabled - returns if caller info enabled for given log level and module

Parameters:
module is module name
level is logging level

Returns:
is caller info enabled for this module and level

note: based on implementation of custom logger, callerinfo info may not be available for custom logging provider

func IsEnabledFor

func IsEnabledFor(module string, level spilog.Level) bool

IsEnabledFor - Check if given log level is enabled for given module

Parameters:
module is module name
level is logging level

Returns:
is logging enabled for this module and level

If not set default logging level is info.

func ParseLevel

func ParseLevel(level string) (spilog.Level, error)

ParseLevel returns the log level from a string representation.

Parameters:
level is logging level in string representation

Returns:
logging level

func SetLevel

func SetLevel(module string, level spilog.Level)

SetLevel - setting log level for given module

Parameters:
module is module name
level is logging level

If not set default logging level is info.

func ShowCallerInfo

func ShowCallerInfo(module string, level spilog.Level)

ShowCallerInfo - Show caller info in log lines for given log level and module

Parameters:
module is module name
level is logging level

note: based on implementation of custom logger, callerinfo info may not be available for custom logging provider

Types

type Log

type Log = log.Log

Log is an implementation of Logger interface. It encapsulates default or custom logger to provide module and level based logging.

func New

func New(module string) *Log

New creates and returns a Logger implementation based on given module name. note: the underlying logger instance is lazy initialized on first use. To use your own logger implementation provide logger provider in 'Initialize()' before logging any line. If 'Initialize()' is not called before logging any line then default logging implementation will be used.