logger

package
v1.3.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 16, 2023 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Overview

The logger package is a decorator over Go's log package.

The LoggerDefault implementation provides a layer over go's log to add Trace, Debug, Info, Warn, Error, Fatal, and Panic levels.

It also implements IsXxxx() functions that can be used as guards (https://en.wikipedia.org/wiki/Guard_(computer_science))

The logger package is a decorator over Go's log package.

For examples of use, see https://github.com/Senzing/go-logging/blob/main/logger/logger_test.go

Index

Constants

View Source 
const (
	LevelDebugName = "DEBUG"
	LevelErrorName = "ERROR"
	LevelFatalName = "FATAL"
	LevelInfoName  = "INFO"
	LevelPanicName = "PANIC"
	LevelTraceName = "TRACE"
	LevelWarnName  = "WARN"
)

Strings representing the supported logging levels.

Variables

View Source 
var LevelToTextMap = map[Level]string{
	LevelTrace: LevelTraceName,
	LevelDebug: LevelDebugName,
	LevelInfo:  LevelInfoName,
	LevelWarn:  LevelWarnName,
	LevelError: LevelErrorName,
	LevelFatal: LevelFatalName,
	LevelPanic: LevelPanicName,
}

Map from Log level as typed integer to string representation.

View Source 
var TextToLevelMap = map[string]Level{
	LevelTraceName: LevelTrace,
	LevelDebugName: LevelDebug,
	LevelInfoName:  LevelInfo,
	LevelWarnName:  LevelWarn,
	LevelErrorName: LevelError,
	LevelFatalName: LevelFatal,
	LevelPanicName: LevelPanic,
}

Map from string representation to Log level as typed integer.

Functions

func GetLogLevelAsString 

func GetLogLevelAsString() string

GetLogLevelAsString() gets the logger instance logging level in string representation.

func IsDebug 

func IsDebug() bool

IsDebug() returns true if the logger instance will log a DEBUG message.

func IsError 

func IsError() bool

IsError() returns true if the logger instance will log a ERROR message.

func IsFatal 

func IsFatal() bool

IsFatal() returns true if the logger instance will log a FATAL message.

func IsInfo 

func IsInfo() bool

IsInfo() returns true if the logger instance will log a INFO message.

func IsPanic 

func IsPanic() bool

IsPanic() returns true if the logger instance will log a PANIC message.

func IsTrace 

func IsTrace() bool

IsTrace() returns true if the logger instance will log a TRACE message.

func IsWarn 

func IsWarn() bool

IsWarn() returns true if the logger instance will log a WARN message.

Types

type Level 

type Level int

The Level type is used to identify the integer is the detail parameters and is used in LevelXxxxx constants. 

const (
	LevelTrace Level = iota
	LevelDebug
	LevelInfo
	LevelWarn
	LevelError
	LevelFatal
	LevelPanic
)

LevelXxxx values are an enumeration of typed integers representing logging levels. Order is important for the LevelXxxx variables.

func GetLogLevel 

func GetLogLevel() Level

GetLogLevel() gets the logger instance logging level.

type LoggerDefault 

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

The LoggerDefault type is for logging messages based on the following levels: TRACE, DEBUG, INFO, WARN, ERROR, FATAL, and PANIC.

func New 

func New() *LoggerDefault

Create a new default instance of the logger.

func (*LoggerDefault) Debug 

func (logger *LoggerDefault) Debug(v ...interface{}) LoggerInterface

Debug() logs a DEBUG message.

func (*LoggerDefault) Debugf 

func (logger *LoggerDefault) Debugf(format string, v ...interface{}) LoggerInterface

Debugf() logs a formatted DEBUG message.

func (*LoggerDefault) Error 

func (logger *LoggerDefault) Error(v ...interface{}) LoggerInterface

Error() logs a ERROR message.

func (*LoggerDefault) Errorf 

func (logger *LoggerDefault) Errorf(format string, v ...interface{}) LoggerInterface

Errorf() logs a formatted ERROR message.

func (*LoggerDefault) Fatal 

func (logger *LoggerDefault) Fatal(v ...interface{}) LoggerInterface

Fatal() logs a FATAL message.

func (*LoggerDefault) Fatalf 

func (logger *LoggerDefault) Fatalf(format string, v ...interface{}) LoggerInterface

Fatalf() logs a formatted FATAL message.

func (*LoggerDefault) GetLogLevel 

func (logger *LoggerDefault) GetLogLevel() Level

GetLogLevel() gets the logger instance logging level.

func (*LoggerDefault) GetLogLevelAsString 

func (logger *LoggerDefault) GetLogLevelAsString() string

GetLogLevelAsString() gets the logger instance logging level in string representation.

func (*LoggerDefault) Info 

func (logger *LoggerDefault) Info(v ...interface{}) LoggerInterface

Info() logs a INFO message.

func (*LoggerDefault) Infof 

func (logger *LoggerDefault) Infof(format string, v ...interface{}) LoggerInterface

Infof() logs a formatted INFO message.

func (*LoggerDefault) IsDebug 

func (logger *LoggerDefault) IsDebug() bool

IsDebug() returns true if the logger instance will log a DEBUG message.

func (*LoggerDefault) IsError 

func (logger *LoggerDefault) IsError() bool

IsError() returns true if the logger instance will log a ERROR message.

func (*LoggerDefault) IsFatal 

func (logger *LoggerDefault) IsFatal() bool

IsFatal() returns true if the logger instance will log a FATAL message.

func (*LoggerDefault) IsInfo 

func (logger *LoggerDefault) IsInfo() bool

IsInfo() returns true if the logger instance will log a INFO message.

func (*LoggerDefault) IsPanic 

func (logger *LoggerDefault) IsPanic() bool

IsPanic() returns true if the logger instance will log a PANIC message.

func (*LoggerDefault) IsTrace 

func (logger *LoggerDefault) IsTrace() bool

IsTrace() returns true if the logger instance will log a TRACE message.

func (*LoggerDefault) IsWarn 

func (logger *LoggerDefault) IsWarn() bool

IsWarn() returns true if the logger instance will log a WARN message.

func (*LoggerDefault) Panic 

func (logger *LoggerDefault) Panic(v ...interface{}) LoggerInterface

Panic() logs a PANIC message.

func (*LoggerDefault) Panicf 

func (logger *LoggerDefault) Panicf(format string, v ...interface{}) LoggerInterface

Panicf() logs a formatted PANIC message.

func (*LoggerDefault) SetLogLevel 

func (logger *LoggerDefault) SetLogLevel(level Level) LoggerInterface

SetLogLevel() sets the logger instance logging level.

func (*LoggerDefault) SetLogLevelFromString 

func (logger *LoggerDefault) SetLogLevelFromString(levelString string) LoggerInterface

SetLogLevelFromString() sets the logger instance logging level using a string representation.

func (*LoggerDefault) Trace 

func (logger *LoggerDefault) Trace(v ...interface{}) LoggerInterface

Trace() logs a TRACE message.

func (*LoggerDefault) Tracef 

func (logger *LoggerDefault) Tracef(format string, v ...interface{}) LoggerInterface

Tracef() logs a formatted TRACE message.

func (*LoggerDefault) Warn 

func (logger *LoggerDefault) Warn(v ...interface{}) LoggerInterface

Warn() logs a WARN message.

func (*LoggerDefault) Warnf 

func (logger *LoggerDefault) Warnf(format string, v ...interface{}) LoggerInterface

Warnf() logs a formatted WARN message.

type LoggerInterface 

type LoggerInterface interface {
	Debug(v ...interface{}) LoggerInterface                   // Log a DEBUG message.
	Debugf(format string, v ...interface{}) LoggerInterface   // Log a formatted DEBUG message.
	Error(v ...interface{}) LoggerInterface                   // Log an ERROR message.
	Errorf(format string, v ...interface{}) LoggerInterface   // Log a formatted ERROR message.
	Fatal(v ...interface{}) LoggerInterface                   // Log a FATAL message.
	Fatalf(format string, v ...interface{}) LoggerInterface   // Log a formatted FATAL message.
	GetLogLevel() Level                                       // Gets the logger instance logging level.
	GetLogLevelAsString() string                              // Gets the logger instance logging level in string representation.
	Info(v ...interface{}) LoggerInterface                    // Log an INFO message.
	Infof(format string, v ...interface{}) LoggerInterface    // Log a formatted INFO message.
	IsDebug() bool                                            // Returns true if a DEBUG message will be logged.
	IsError() bool                                            // Returns true if an ERROR message will be logged.
	IsFatal() bool                                            // Returns true if a FATAL message will be logged.
	IsInfo() bool                                             // Returns true if an INFO message will be logged.
	IsPanic() bool                                            // Returns true if a PANIC message will be logged.
	IsTrace() bool                                            // Returns true if a TRACE message will be logged.
	IsWarn() bool                                             // Returns true if a WARN message will be logged.
	Panic(v ...interface{}) LoggerInterface                   // Log a PANIC message.
	Panicf(format string, v ...interface{}) LoggerInterface   // Log a formatted PANIC message.
	SetLogLevel(level Level) LoggerInterface                  // Sets the logger instance logging level.
	SetLogLevelFromString(levelString string) LoggerInterface // Sets the logger instance logging level using a string representation.
	Trace(v ...interface{}) LoggerInterface                   // Log a TRACE message.
	Tracef(format string, v ...interface{}) LoggerInterface   // Log a formatted TRACE message.
	Warn(v ...interface{}) LoggerInterface                    // Log a WARN message.
	Warnf(format string, v ...interface{}) LoggerInterface    // Log a formatted WARN message.
}

The LoggerInterface type defines guards, logging methods, and get/set of logging level.

func Debug 

func Debug(v ...interface{}) LoggerInterface

Debug() logs a DEBUG message.

func Debugf 

func Debugf(format string, v ...interface{}) LoggerInterface

Debugf() logs a formatted DEBUG message.

func Error 

func Error(v ...interface{}) LoggerInterface

Error() logs a ERROR message.

func Errorf 

func Errorf(format string, v ...interface{}) LoggerInterface

Errorf() logs a formatted ERROR message.

func Fatal 

func Fatal(v ...interface{}) LoggerInterface

Fatal() logs a FATAL message.

func Fatalf 

func Fatalf(format string, v ...interface{}) LoggerInterface

Fatalf() logs a formatted FATAL message.

func Info 

func Info(v ...interface{}) LoggerInterface

Info() logs a INFO message.

func Infof 

func Infof(format string, v ...interface{}) LoggerInterface

Infof() logs a formatted INFO message.

func Panic 

func Panic(v ...interface{}) LoggerInterface

Panic() logs a PANIC message.

func Panicf 

func Panicf(format string, v ...interface{}) LoggerInterface

Panicf() logs a formatted PANIC message.

func SetLogLevel 

func SetLogLevel(level Level) LoggerInterface

SetLogLevel() sets the logger instance logging level.

func SetLogLevelFromString 

func SetLogLevelFromString(levelString string) LoggerInterface

SetLogLevelFromString() sets the logger instance logging level using a string representation.

func Trace 

func Trace(v ...interface{}) LoggerInterface

Trace() logs a TRACE message.

func Tracef 

func Tracef(format string, v ...interface{}) LoggerInterface

Tracef() logs a formatted TRACE message.

func Warn 

func Warn(v ...interface{}) LoggerInterface

Warn() logs a WARN message.

func Warnf 

func Warnf(format string, v ...interface{}) LoggerInterface

Warnf() logs a formatted WARN message.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.