logging

Documentation

Index

• Constants
• func DefaultFormatter(l, m string) string
• func WithFormatter(f func(string, string) string) util.Option
• func WithLevel(s string) util.Option
• func WithLogger(f func(...interface{})) util.Option
• type Instance
  • func NewInstance(opts ...util.Option) (*Instance, error)
  • func (i *Instance) Critical(f string)
  • func (i *Instance) Criticalf(f string, a ...interface{})
  • func (i *Instance) Debug(f string)
  • func (i *Instance) Debugf(f string, a ...interface{})
  • func (i *Instance) Emit(m interface{})
  • func (i *Instance) Info(f string)
  • func (i *Instance) Infof(f string, a ...interface{})

Constants

const (
	// Debug is the debug log level.
	Debug = "debug"
	// Info is the info(rmational) log level.
	Info = "info"
	// Critical is the critical log level.
	Critical = "critical"
)

Functions

func DefaultFormatter

func DefaultFormatter(l, m string) string

DefaultFormatter is the default logging instance formatter -- this formatter simply adds colors to the log message based on log level.

func WithFormatter

func WithFormatter(f func(string, string) string) util.Option

WithFormatter sets the Formatter function of the logging instance.

func WithLevel

func WithLevel(s string) util.Option

WithLevel sets the logging level for a logging instance.

func WithLogger

func WithLogger(f func(...interface{})) util.Option

WithLogger appends a logger (a function that accepts an interface) to the Loggers slice of a logging instance.

Types

type Instance

type Instance struct {
	Level     string
	Formatter func(string, string) string
	Loggers   []func(...interface{})
}

Instance is a simple logging object.

func NewInstance

func NewInstance(opts ...util.Option) (*Instance, error)

NewInstance returns a new logging Instance.

func (*Instance) Critical

func (i *Instance) Critical(f string)

Critical accepts a Critical level log message with no formatting.

func (*Instance) Criticalf

func (i *Instance) Criticalf(f string, a ...interface{})

Criticalf accepts a Critical level log message normal fmt.Sprintf type formatting.

func (*Instance) Debug

func (i *Instance) Debug(f string)

Debug accepts a Debug level log message with no formatting.

func (*Instance) Debugf

func (i *Instance) Debugf(f string, a ...interface{})

Debugf accepts a Debug level log message normal fmt.Sprintf type formatting.

func (*Instance) Emit

func (i *Instance) Emit(m interface{})

Emit "emits" a logging message m to all the loggers in the Instance.

func (*Instance) Info

func (i *Instance) Info(f string)

Info accepts an Info level log message with no formatting.

func (*Instance) Infof

func (i *Instance) Infof(f string, a ...interface{})

Infof accepts an Info level log message normal fmt.Sprintf type formatting.