logging

README

logging

A set of standardized utilities and interfaces in Go for logging.

Documentation

Index

• Constants
• type ConsoleLogLevel
• type ConsoleLogger
  • func NewConsoleLogger() *ConsoleLogger
  • func (c *ConsoleLogger) Debug(msg string)
  • func (c *ConsoleLogger) Debugf(msg string, args ...interface{})
  • func (c *ConsoleLogger) Error(msg string)
  • func (c *ConsoleLogger) Errorf(msg string, args ...interface{})
  • func (c *ConsoleLogger) Fatal(msg string)
  • func (c *ConsoleLogger) Fatalf(msg string, args ...interface{})
  • func (c *ConsoleLogger) Important(msg string)
  • func (c *ConsoleLogger) Importantf(msg string, args ...interface{})
  • func (c *ConsoleLogger) Info(msg string)
  • func (c *ConsoleLogger) Infof(msg string, args ...interface{})
  • func (c *ConsoleLogger) SetLevel(level ConsoleLogLevel)
  • func (c *ConsoleLogger) SetOutput(w io.Writer)
  • func (c *ConsoleLogger) Success(msg string)
  • func (c *ConsoleLogger) Successf(msg string, args ...interface{})
  • func (c *ConsoleLogger) Warn(msg string)
  • func (c *ConsoleLogger) Warnf(msg string, args ...interface{})
• type Logger
• type ZerologAdapter
  • func ConvertZerolog(l *zerolog.Logger) *ZerologAdapter
  • func (z *ZerologAdapter) Debug(msg string)
  • func (z *ZerologAdapter) Debugf(msg string, args ...interface{})
  • func (z *ZerologAdapter) Error(msg string)
  • func (z *ZerologAdapter) Errorf(msg string, args ...interface{})
  • func (z *ZerologAdapter) Fatal(msg string)
  • func (z *ZerologAdapter) Fatalf(msg string, args ...interface{})
  • func (z *ZerologAdapter) Info(msg string)
  • func (z *ZerologAdapter) Infof(msg string, args ...interface{})
  • func (z *ZerologAdapter) Warn(msg string)
  • func (z *ZerologAdapter) Warnf(msg string, args ...interface{})

Constants

const (
	FatalLevel = iota
	ErrorLevel
	WarnLevel
	ImportantLevel
	SuccessLevel
	InfoLevel
	DebugLevel
)

Types

type ConsoleLogLevel

type ConsoleLogLevel int

ConsoleLogLevel is the log level for the ConsoleLogger

type ConsoleLogger

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

ConsoleLogger logs to the console and satisfies the Logger interface

func NewConsoleLogger

func NewConsoleLogger() *ConsoleLogger

NewConsoleLogger creates a new instance of the *ConsoleLogger with a default logging level of FatalLevel

func (*ConsoleLogger) Debug

func (c *ConsoleLogger) Debug(msg string)

Debug logs a Debug level message in Cyan

func (*ConsoleLogger) Debugf

func (c *ConsoleLogger) Debugf(msg string, args ...interface{})

Debugf logs a Debug level message in Cyan

func (*ConsoleLogger) Error

func (c *ConsoleLogger) Error(msg string)

Error logs an Error level message in Red

func (*ConsoleLogger) Errorf

func (c *ConsoleLogger) Errorf(msg string, args ...interface{})

Errorf logs an Error level message in Red

func (*ConsoleLogger) Fatal

func (c *ConsoleLogger) Fatal(msg string)

Fatal logs a Fatal level message in White

func (*ConsoleLogger) Fatalf

func (c *ConsoleLogger) Fatalf(msg string, args ...interface{})

Fatalf logs a Fatal level message in White

func (*ConsoleLogger) Important

func (c *ConsoleLogger) Important(msg string)

Important logs an Important level message in Blue

func (*ConsoleLogger) Importantf

func (c *ConsoleLogger) Importantf(msg string, args ...interface{})

Importantf logs an Important level message in Blue

func (*ConsoleLogger) Info

func (c *ConsoleLogger) Info(msg string)

Info logs an Info level message in Gray

func (*ConsoleLogger) Infof

func (c *ConsoleLogger) Infof(msg string, args ...interface{})

Infof logs an Info level message in Gray

func (*ConsoleLogger) SetLevel

func (c *ConsoleLogger) SetLevel(level ConsoleLogLevel)

SetLevel sets the logging level of the ConsoleLogger to level

func (*ConsoleLogger) SetOutput

func (c *ConsoleLogger) SetOutput(w io.Writer)

SetOutput sets the output of the ConsoleLogger to an io.Writer

func (*ConsoleLogger) Success

func (c *ConsoleLogger) Success(msg string)

Success logs a Success level message in Green

func (*ConsoleLogger) Successf

func (c *ConsoleLogger) Successf(msg string, args ...interface{})

Successf logs a Success level message in Green

func (*ConsoleLogger) Warn

func (c *ConsoleLogger) Warn(msg string)

Warn logs a Warn level message Orange

func (*ConsoleLogger) Warnf

func (c *ConsoleLogger) Warnf(msg string, args ...interface{})

Warnf logs a Warn level message Orange

type Logger

type Logger interface {
	Fatal(msg string)
	Fatalf(msg string, args ...interface{})

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

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

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

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

Logger is a standardized interface for a logger

type ZerologAdapter

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

ZerologAdapter is an adapter to convert a zerolog.Logger into a struct that satisfies the Logger interface

func ConvertZerolog

func ConvertZerolog(l *zerolog.Logger) *ZerologAdapter

ConvertZerolog converts a *zerolog.Logger to a *ZerologAdapter

func (*ZerologAdapter) Debug

func (z *ZerologAdapter) Debug(msg string)

func (*ZerologAdapter) Debugf

func (z *ZerologAdapter) Debugf(msg string, args ...interface{})

func (*ZerologAdapter) Error

func (z *ZerologAdapter) Error(msg string)

func (*ZerologAdapter) Errorf

func (z *ZerologAdapter) Errorf(msg string, args ...interface{})

func (*ZerologAdapter) Fatal

func (z *ZerologAdapter) Fatal(msg string)

func (*ZerologAdapter) Fatalf

func (z *ZerologAdapter) Fatalf(msg string, args ...interface{})

func (*ZerologAdapter) Info

func (z *ZerologAdapter) Info(msg string)

func (*ZerologAdapter) Infof

func (z *ZerologAdapter) Infof(msg string, args ...interface{})

func (*ZerologAdapter) Warn

func (z *ZerologAdapter) Warn(msg string)

func (*ZerologAdapter) Warnf

func (z *ZerologAdapter) Warnf(msg string, args ...interface{})