log

Documentation

Index

• type ErrEncoder
  • func NewErrEncoder(w io.Writer) *ErrEncoder
  • func (w *ErrEncoder) Write(p []byte) (int, error)
  • func (w *ErrEncoder) WriteString(s string) (int, error)
• type Target
  • func NewTarget(targets ...io.Writer) *Target
  • func (t *Target) Add(target io.Writer)
  • func (t *Target) Log() *log.Logger
  • func (t *Target) Remove(target io.Writer)

Types

type ErrEncoder

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

ErrEncoder is an io.Writer that converts all log messages into a stream of kes.ErrorEvents.

An ErrEncoder should be used when converting log messages to JSON.

func NewErrEncoder

func NewErrEncoder(w io.Writer) *ErrEncoder

NewErrEncoder returns a new ErrEncoder that writes kes.ErrorEvents to w.

func (*ErrEncoder) Write

func (w *ErrEncoder) Write(p []byte) (int, error)

Write converts p into an kes.ErrorEvent and writes its JSON representation to the underlying io.Writer.

func (*ErrEncoder) WriteString

func (w *ErrEncoder) WriteString(s string) (int, error)

WriteString converts s into an kes.ErrorEvent and writes its JSON representation to the underlying io.Writer.

type Target

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

Target groups a set of logging targets.

A message that gets written to the Target.Log will be sent to all logging targets.

func NewTarget

func NewTarget(targets ...io.Writer) *Target

NewTarget creates a new group of logging targets from the given targets. Dublicate or nil targets will be filtered out.

If no targets are provided the returned Target will discard any log messages.

func (*Target) Add

func (t *Target) Add(target io.Writer)

Add adds the given target to the set of logging targets.

It does not add the given target if it is already in the set of logging targets nor if it is nil.

func (*Target) Log

func (t *Target) Log() *log.Logger

Log returns the log.Logger that writes to all logging targets.

The output of the returned *log.Logger must not be modified directly via its SetOutput method. Instead, use the Add and Remove methods of Target.

func (*Target) Remove

func (t *Target) Remove(target io.Writer)

Remove removes the given target from the set of logging targets.