logger

Documentation

Index

• Variables
• func FormatDetails(details []string) string
• func FormatErrors(errors []error) string
• func FormatStatus(status Status) string
• type DefaultLogger
  • func NewDefaultLogger(name string) *DefaultLogger
  • func (d *DefaultLogger) FormatLogError(logError *LogError) string
  • func (d *DefaultLogger) FormatLogMessage(logMessage *LogMessage) string
  • func (d *DefaultLogger) LogError(logError *LogError)
  • func (d *DefaultLogger) LogMessage(logMessage *LogMessage)
• type Log
• type LogError
  • func NewLogError(title string, errors ...error) *LogError
  • func (l *LogError) String() string
• type LogMessage
  • func NewLogMessage(title string, status Status, details ...string) *LogMessage
  • func (l *LogMessage) String() string
• type Logger
• type Status
  • func (s Status) String() string

Variables

var (
	NilLoggerError = errors.New("logger is nil")
)

Functions

func FormatDetails

func FormatDetails(details []string) string

FormatDetails gets the formatted details

func FormatErrors

func FormatErrors(errors []error) string

FormatErrors gets the formatted errors

func FormatStatus

func FormatStatus(status Status) string

FormatStatus gets the formatted status

Types

type DefaultLogger

type DefaultLogger struct {
	Name          string
	FormattedName string
}

DefaultLogger is a logger that logs messages

func NewDefaultLogger

func NewDefaultLogger(name string) *DefaultLogger

NewDefaultLogger creates a new logger

func (*DefaultLogger) FormatLogError

func (d *DefaultLogger) FormatLogError(logError *LogError) string

FormatLogError formats a log error

func (*DefaultLogger) FormatLogMessage

func (d *DefaultLogger) FormatLogMessage(logMessage *LogMessage) string

FormatLogMessage formats a log message

func (*DefaultLogger) LogError

func (d *DefaultLogger) LogError(logError *LogError)

LogError logs an error

func (*DefaultLogger) LogMessage

func (d *DefaultLogger) LogMessage(logMessage *LogMessage)

LogMessage logs a message

type Log

type Log interface {
	String() string
}

Log interface

type LogError

type LogError struct {
	Title  string
	Errors []error
}

LogError struct

func NewLogError

func NewLogError(title string, errors ...error) *LogError

NewLogError creates a new log error

func (*LogError) String

func (l *LogError) String() string

String gets the string representation of a log error

type LogMessage

type LogMessage struct {
	Title   string
	Details []string
	Status  Status
}

LogMessage struct

func NewLogMessage

func NewLogMessage(title string, status Status, details ...string) *LogMessage

NewLogMessage creates a new log message

func (*LogMessage) String

func (l *LogMessage) String() string

String gets the string representation of a log message

type Logger

type Logger interface {
	LogMessage(logMessage *LogMessage)
	LogError(logError *LogError)
}

Logger is an interface for logging messages

type Status

type Status int

Status is the status of the logger

const (
	StatusSuccess Status = iota
	StatusFailed
	StatusError
	StatusWarning
	StatusInfo
	StatusDebug
	StatusTrace
	StatusNone
	StatusUnknown
)

func (Status) String

func (s Status) String() string

String returns the string representation of the status