log

Documentation

Index

• Constants
• func InitLog(path string)
• func InitLogWriter(w io.Writer)
• func SetOptions(opts ...optionFn)
• func Unsubscribe(sub *Subscription)
• func WithEventSubscriber(fn func(evt Event)) optionFn
• type Encoder
• type Event
• type Field
  • func Bool(key string, val bool) Field
  • func Duration(key string, val time.Duration) Field
  • func Error(err error) Field
  • func Float64(key string, val float64) Field
  • func Int(key string, val int) Field
  • func Int64(key string, val int64) Field
  • func Message(val interface{}) Field
  • func Object(key string, val interface{}) Field
  • func Stack() Field
  • func String(key string, val string) Field
  • func Stringer(key string, val fmt.Stringer) Field
  • func Time(key string, val time.Time) Field
  • func TypeOf(key string, val interface{}) Field
  • func Uint(key string, val uint) Field
  • func Uint64(key string, val uint64) Field
  • func (f Field) Encode(enc Encoder)
• type Level
• type Logger
  • func New(level Level, prefix string, context ...Field) *Logger
  • func (l *Logger) Debug(msg string, fields ...Field)
  • func (l *Logger) Error(msg string, fields ...Field)
  • func (l *Logger) Info(msg string, fields ...Field)
  • func (l *Logger) Level() Level
  • func (l *Logger) SetLevel(level Level)
  • func (l *Logger) With(fields ...Field) *Logger
• type Subscription
  • func Subscribe(fn func(evt Event)) *Subscription
  • func (s *Subscription) WithMinLevel(level Level) *Subscription

Constants

const (
	MinLevel = Level(iota)
	DebugLevel
	InfoLevel
	ErrorLevel
	OffLevel
)

Functions

func InitLog

func InitLog(path string)

func InitLogWriter

func InitLogWriter(w io.Writer)

InitLogWriter initializes the given io.Writer as the log output.

func SetOptions

func SetOptions(opts ...optionFn)

SetOptions is used to configure the log system

func Unsubscribe

func Unsubscribe(sub *Subscription)

func WithEventSubscriber

func WithEventSubscriber(fn func(evt Event)) optionFn

WithEventSubscriber option replaces the default Event subscriber with fn.

Specifying nil will disable logging of events.

Types

type Encoder

type Encoder interface {
	EncodeBool(key string, val bool)
	EncodeFloat64(key string, val float64)
	EncodeInt(key string, val int)
	EncodeInt64(key string, val int64)
	EncodeDuration(key string, val time.Duration)
	EncodeUint(key string, val uint)
	EncodeUint64(key string, val uint64)
	EncodeString(key string, val string)
	EncodeObject(key string, val interface{})
	EncodeType(key string, val reflect.Type)
}

type Event

type Event struct {
	Time    time.Time
	Level   Level
	Prefix  string
	Message string
	Context []Field
	Fields  []Field
}

type Field

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

func Bool

func Bool(key string, val bool) Field

Bool constructs a Field with the given key and value.

func Duration

func Duration(key string, val time.Duration) Field

Duration constructs a Field with the given key and value.

func Error

func Error(err error) Field

Error constructs a Field that lazily stores err.Error() under the key "error". If passed a nil error, the field is skipped.

func Float64

func Float64(key string, val float64) Field

Float64 constructs a Field with the given key and value.

func Int

func Int(key string, val int) Field

Int constructs a Field with the given key and value. Marshaling ints is lazy.

func Int64

func Int64(key string, val int64) Field

Int64 constructs a Field with the given key and value.

func Message

func Message(val interface{}) Field

Message constructs a field to store the message under the key message

func Object

func Object(key string, val interface{}) Field

Object constructs a field with the given key and an arbitrary object.

func Stack

func Stack() Field

Stack constructs a Field that stores a stacktrace under the key "stacktrace".

This is eager and therefore an expensive operation.

func String

func String(key string, val string) Field

String constructs a Field with the given key and value.

func Stringer

func Stringer(key string, val fmt.Stringer) Field

Stringer constructs a Field with the given key and the output of the value's String method. The String is not evaluated until encoding.

func Time

func Time(key string, val time.Time) Field

Time constructs a Field with the given key and value. It represents a time.Time as a floating-point number of seconds since the Unix epoch.

func TypeOf

func TypeOf(key string, val interface{}) Field

TypeOf constructs a field with the given key and an arbitrary object that will log the type information lazily.

func Uint

func Uint(key string, val uint) Field

Uint constructs a Field with the given key and value.

func Uint64

func Uint64(key string, val uint64) Field

Uint64 constructs a Field with the given key and value.

func (Field) Encode

func (f Field) Encode(enc Encoder)

Encode encodes a field to a type safe val via the encoder.

type Level

type Level int32

type Logger

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

func New

func New(level Level, prefix string, context ...Field) *Logger

func (*Logger) Debug

func (l *Logger) Debug(msg string, fields ...Field)

func (*Logger) Error

func (l *Logger) Error(msg string, fields ...Field)

func (*Logger) Info

func (l *Logger) Info(msg string, fields ...Field)

func (*Logger) Level

func (l *Logger) Level() Level

func (*Logger) SetLevel

func (l *Logger) SetLevel(level Level)

func (*Logger) With

func (l *Logger) With(fields ...Field) *Logger

type Subscription

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

Subscription is returned from the Subscribe function.

This value and can be passed to Unsubscribe when the observer is no longer interested in receiving messages

func Subscribe

func Subscribe(fn func(evt Event)) *Subscription

func (*Subscription) WithMinLevel

func (s *Subscription) WithMinLevel(level Level) *Subscription

WithMinLevel filter messages below the provided level

For example, setting ErrorLevel will only pass error messages. Setting MinLevel will allow all messages, and is the default.