go_logger

Documentation

Index

• Variables
• type DefaultLogger
  • func NewDefaultLogger() *DefaultLogger
  • func (d *DefaultLogger) BuildAndLog(header, subheader string, details *[]string, status gologgerstatus.Status)
  • func (d *DefaultLogger) Critical(header, subheader string, details *[]string)
  • func (d *DefaultLogger) Debug(header, subheader string, details *[]string)
  • func (d *DefaultLogger) Error(header, subheader string, errors *[]error)
  • func (d *DefaultLogger) Info(header, subheader string, details *[]string)
  • func (d *DefaultLogger) Log(message *Message)
  • func (d *DefaultLogger) Warning(header, subheader string, details *[]string)
• type Logger
• type Message
  • func NewMessage(header, subheader string, description *[]string, status gologgerstatus.Status) *Message
  • func (m *Message) Status() gologgerstatus.Status
  • func (m *Message) String() string

Variables

var (
	// HeaderSeparator is the header separator
	HeaderSeparator = gostringsseparator.NewRepeatedContent(gostringsseparator.Space)

	// StatusSeparator is the status separator
	StatusSeparator = gostringsseparator.NewRepeatedContent(gostringsseparator.Space)

	// DescriptionSeparator is the description separator
	DescriptionSeparator = gostringsseparator.NewMultiline(
		gostringsseparator.Space,
		gostringsseparator.NewLine,
		1,
	)

	// MessageSeparator is the message separator
	MessageSeparator = gostringsseparator.Space

	// AddCharactersFn is the add characters function
	AddCharactersFn = gostringsadd.Brackets
)

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

Types

type DefaultLogger

type DefaultLogger struct{}

DefaultLogger is a logger that logs messages

func NewDefaultLogger

func NewDefaultLogger() *DefaultLogger

NewDefaultLogger creates a new logger

func (*DefaultLogger) BuildAndLog

func (d *DefaultLogger) BuildAndLog(
	header, subheader string,
	details *[]string,
	status gologgerstatus.Status,
)

BuildAndLog builds a message and logs it

func (*DefaultLogger) Critical

func (d *DefaultLogger) Critical(header, subheader string, details *[]string)

Critical logs a critical message

func (*DefaultLogger) Debug

func (d *DefaultLogger) Debug(header, subheader string, details *[]string)

Debug logs a debug message

func (*DefaultLogger) Error

func (d *DefaultLogger) Error(header, subheader string, errors *[]error)

Error logs an error message

func (*DefaultLogger) Info

func (d *DefaultLogger) Info(header, subheader string, details *[]string)

Info logs an info message

func (*DefaultLogger) Log

func (d *DefaultLogger) Log(message *Message)

Log logs a message

func (*DefaultLogger) Warning

func (d *DefaultLogger) Warning(header, subheader string, details *[]string)

Warning logs a warning message

type Logger

type Logger interface {
	Log(message *Message)
	Info(header, subheader string, details *[]string)
	Error(header, subheader string, errors *[]error)
	Debug(header, subheader string, details *[]string)
	Critical(header, subheader string, details *[]string)
	Warning(header, subheader string, details *[]string)
}

Logger is an interface for logging messages

type Message

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

Message struct

func NewMessage

func NewMessage(
	header, subheader string,
	description *[]string,
	status gologgerstatus.Status,
) *Message

NewMessage creates a new message

func (*Message) Status

func (m *Message) Status() gologgerstatus.Status

Status returns the status of a message

func (*Message) String

func (m *Message) String() string

String gets the string representation of a message