log

Documentation

Overview

Package log provides simple log interfaces

Index

• Constants
• Variables
• func SetNoStdErrLogs()
• func SetOptions(opts ...option)
• func Unsubscribe(sub *Subscription)
• func WithCaller(enabled bool) option
• func WithDefaultLevel(level Level) option
• func WithEventSubscriber(fn func(evt Event)) option
• type CallerInfo
  • func (ci *CallerInfo) ShortFileName() string
  • func (ci *CallerInfo) String() string
• type Encoder
• type Event
• type Field
  • func Bool(key string, val bool) Field
  • func Caller() Field
  • func CallerSkip(skip int) 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 PID(key string, val fmt.Stringer) 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
  • func (l Level) String() string
• 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) Warn(msg string, fields ...Field)
  • func (l *Logger) With(fields ...Field) *Logger
  • func (l *Logger) WithCaller() *Logger
• type Options
  • func (o *Options) With(opts ...option) *Options
• type Subscription
  • func Subscribe(fn func(evt Event)) *Subscription
  • func (s *Subscription) WithMinLevel(level Level) *Subscription

Constants

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

Variables

var (
	Development = &Options{
		logLevel:     DebugLevel,
		enableCaller: true,
	}

	Production = &Options{
		logLevel:     InfoLevel,
		enableCaller: false,
	}

	Current = Production
)

Functions

func SetNoStdErrLogs

func SetNoStdErrLogs()

Disables Proto.Actor standard error logs if there is one or more additional log subscribers registered

func SetOptions

func SetOptions(opts ...option)

func Unsubscribe

func Unsubscribe(sub *Subscription)

func WithCaller

func WithCaller(enabled bool) option

WithCaller option will print the file name and line number.

func WithDefaultLevel

func WithDefaultLevel(level Level) option

func WithEventSubscriber

func WithEventSubscriber(fn func(evt Event)) option

WithEventSubscriber option replaces the default Event subscriber with fn.

Specifying nil will disable logging of events.

Types

type CallerInfo

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

func (*CallerInfo) ShortFileName

func (ci *CallerInfo) ShortFileName() string

func (*CallerInfo) String

func (ci *CallerInfo) String() string

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)
	EncodeCaller(key string, val CallerInfo)
}

type Event

type Event struct {
	Time    time.Time
	Level   Level
	Prefix  string
	Caller  CallerInfo
	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 Caller

func Caller() Field

func CallerSkip

func CallerSkip(skip int) Field

Caller constructs a field with function name and number of line

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 PID

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

PID constructs a Field with the given key and value.

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

Level of log.

func (Level) String

func (l Level) String() string

type Logger

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

func New

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

New a 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) Warn

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

func (*Logger) With

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

func (*Logger) WithCaller

func (l *Logger) WithCaller() *Logger

type Options

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

Options for log.

func (*Options) With

func (o *Options) With(opts ...option) *Options

Setup is used to configure the log system

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.