report

Documentation

Index

• type Entry
• type Report
  • func New() Report
  • func (r *Report) AddEntry(e Entry)
  • func (r *Report) Flush() error
  • func (r *Report) HasErrors() bool
  • func (r *Report) HasWarnings() bool
• type Writer
  • func NewWriter(report *Report) Writer
  • func (w Writer) Debug(msg string)
  • func (w Writer) Debugf(msg string, a ...interface{})
  • func (w Writer) Error(msg string)
  • func (w Writer) Errorf(msg string, a ...interface{})
  • func (w Writer) Fatal(msg string)
  • func (w Writer) Fatalf(msg string, a ...interface{})
  • func (w Writer) Info(msg string)
  • func (w Writer) Infof(msg string, a ...interface{})
  • func (w Writer) Warn(msg string)
  • func (w Writer) Warnf(msg string, a ...interface{})
  • func (w Writer) WithValue(key string, val interface{}) Writer

Types

type Entry

type Entry struct {
	Level   logrus.Level
	Message string
	Context map[string]interface{}
	Time    time.Time
}

Entry ...

type Report

type Report struct {
	Out      io.Writer
	LogLevel logrus.Level
	// contains filtered or unexported fields
}

Report reports debug, warning, & errors

func New

func New() Report

New returns new report w/ log level preconfigured

func (*Report) AddEntry

func (r *Report) AddEntry(e Entry)

AddEntry adds given entry to report

func (*Report) Flush

func (r *Report) Flush() error

Flush pops entries from list and writes them

func (*Report) HasErrors

func (r *Report) HasErrors() bool

HasErrors returns true if there are any error entries in the report

func (*Report) HasWarnings

func (r *Report) HasWarnings() bool

HasWarnings returns true if there are any warnings entries in the report

type Writer

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

Writer exposes methods for adding entries to a report

func NewWriter

func NewWriter(report *Report) Writer

NewWriter returns a new writer instance with context initialized

func (Writer) Debug

func (w Writer) Debug(msg string)

Debug logs debug messages

func (Writer) Debugf

func (w Writer) Debugf(msg string, a ...interface{})

Debugf logs debug messages

func (Writer) Error

func (w Writer) Error(msg string)

Error logs error

func (Writer) Errorf

func (w Writer) Errorf(msg string, a ...interface{})

Errorf logs error

func (Writer) Fatal

func (w Writer) Fatal(msg string)

Fatal logs fatal error and quits

func (Writer) Fatalf

func (w Writer) Fatalf(msg string, a ...interface{})

Fatalf logs fatal error and quits

func (Writer) Info

func (w Writer) Info(msg string)

Info logs information

func (Writer) Infof

func (w Writer) Infof(msg string, a ...interface{})

Infof logs info

func (Writer) Warn

func (w Writer) Warn(msg string)

Warn logs warning

func (Writer) Warnf

func (w Writer) Warnf(msg string, a ...interface{})

Warnf logs warning

func (Writer) WithValue

func (w Writer) WithValue(key string, val interface{}) Writer

WithValue returns a new writer instance with KV pair added