easylog

README

easylog

Documentation

Index

• func AddHandler(h Handler)
• func Close()
• func DelKv(k interface{})
• func DelTag(k string)
• func DisableCaller(level Level)
• func DisableStack(level Level)
• func EnableCaller(level Level)
• func EnableStack(level Level)
• func Flush()
• func Kvs() map[interface{}]interface{}
• func NewNopErrorHandler() *nopErrorHandler
• func NewNopHandler() *nopHandler
• func RemoveHandler(h Handler)
• func ResetHandler()
• func ResetKv()
• func ResetTag()
• func SetErrorHandler(h ErrorHandler)
• func SetKv(k interface{}, v interface{})
• func SetLevel(level Level)
• func SetTag(k string, v interface{})
• func Tags() map[interface{}]interface{}
• type Bytes
  • func (b *Bytes) AppendByte(s byte)
  • func (b *Bytes) AppendInt(i int64)
  • func (b *Bytes) AppendString(s string)
  • func (b *Bytes) String() string
• type ErrorHandler
• type Event
  • func Debug() *Event
  • func Error() *Event
  • func Fatal() *Event
  • func Info() *Event
  • func Panic() *Event
  • func Warn() *Event
  • func (e *Event) Attach(extra interface{}) *Event
  • func (e *Event) Clone() *Event
  • func (e *Event) E(err error) *Event
  • func (e *Event) GetCaller() *caller
  • func (e *Event) GetError() error
  • func (e *Event) GetExtra() interface{}
  • func (e *Event) GetKvs() map[interface{}]interface{}
  • func (e *Event) GetLevel() Level
  • func (e *Event) GetLogger() *Logger
  • func (e *Event) GetMsg() string
  • func (e *Event) GetStack() string
  • func (e *Event) GetTags() map[interface{}]interface{}
  • func (e *Event) GetTime() time.Time
  • func (e *Event) Kv(k, v interface{}) *Event
  • func (e *Event) Log()
  • func (e *Event) Logf(msg string, args ...interface{})
  • func (e *Event) Put()
  • func (e *Event) Tag(k interface{}, v interface{}) *Event
• type Handler
• type Level
  • func GetLevel() Level
  • func (l Level) String() string
• type Logger
  • func GetLogger(name string) *Logger
  • func GetRootLogger() *Logger
  • func (l *Logger) AddHandler(h Handler)
  • func (l *Logger) Close()
  • func (l *Logger) Debug() *Event
  • func (l *Logger) DelKv(k interface{})
  • func (l *Logger) DelTag(k interface{})
  • func (l *Logger) DisableCaller(level Level)
  • func (l *Logger) DisableStack(level Level)
  • func (l *Logger) EnableCaller(level Level)
  • func (l *Logger) EnableStack(level Level)
  • func (l *Logger) Error() *Event
  • func (l *Logger) Fatal() *Event
  • func (l *Logger) Flush()
  • func (l *Logger) GetLevel() Level
  • func (l *Logger) GetPropagate() bool
  • func (l *Logger) Info() *Event
  • func (l *Logger) Kvs() map[interface{}]interface{}
  • func (l *Logger) Name() string
  • func (l *Logger) Panic() *Event
  • func (l *Logger) RemoveHandler(h Handler)
  • func (l *Logger) ResetHandler()
  • func (l *Logger) ResetKv()
  • func (l *Logger) ResetTag()
  • func (l *Logger) SetErrorHandler(w ErrorHandler)
  • func (l *Logger) SetKv(k interface{}, v interface{})
  • func (l *Logger) SetLevel(level Level)
  • func (l *Logger) SetPropagate(propagate bool)
  • func (l *Logger) SetTag(k interface{}, v interface{})
  • func (l *Logger) Tags() map[interface{}]interface{}
  • func (l *Logger) Warn() *Event
• type MockErrorHandler
  • func (_m *MockErrorHandler) Close() error
  • func (_m *MockErrorHandler) Flush() error
  • func (_m *MockErrorHandler) Handle(_a0 error) error
• type MockHandler
  • func (_m *MockHandler) Close() error
  • func (_m *MockHandler) Flush() error
  • func (_m *MockHandler) Handle(_a0 *Event) (bool, error)

Functions

func AddHandler

func AddHandler(h Handler)

func Close

func Close()

func DelKv

func DelKv(k interface{})

func DelTag

func DelTag(k string)

func DisableCaller

func DisableCaller(level Level)

func DisableStack

func DisableStack(level Level)

func EnableCaller

func EnableCaller(level Level)

func EnableStack

func EnableStack(level Level)

func Flush

func Flush()

func Kvs

func Kvs() map[interface{}]interface{}

func NewNopErrorHandler

func NewNopErrorHandler() *nopErrorHandler

func NewNopHandler

func NewNopHandler() *nopHandler

func RemoveHandler

func RemoveHandler(h Handler)

func ResetHandler

func ResetHandler()

func ResetKv

func ResetKv()

func ResetTag

func ResetTag()

func SetErrorHandler

func SetErrorHandler(h ErrorHandler)

func SetKv

func SetKv(k interface{}, v interface{})

func SetLevel

func SetLevel(level Level)

func SetTag

func SetTag(k string, v interface{})

func Tags

func Tags() map[interface{}]interface{}

Types

type Bytes

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

func (*Bytes) AppendByte

func (b *Bytes) AppendByte(s byte)

func (*Bytes) AppendInt

func (b *Bytes) AppendInt(i int64)

func (*Bytes) AppendString

func (b *Bytes) AppendString(s string)

func (*Bytes) String

func (b *Bytes) String() string

type ErrorHandler

type ErrorHandler interface {
	// Handle consumes the error
	Handle(error) error
	// Flush flushes buffered data (if any).
	// ErrorHandler could have an internal flush() mechanism.
	// However, in some cases, only Logger knows when to flush().
	Flush() error
	// Close releases resources used by ErrorHandler. If any buffered data, should flush() before close().
	Close() error
}

ErrorHandler mockery --name=ErrorHandler --inpackage --case=underscore --filename=error_handler_mock.go --structname MockErrorHandler

type Event

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

func Debug

func Debug() *Event

func Error

func Error() *Event

func Fatal

func Fatal() *Event

func Info

func Info() *Event

func Panic

func Panic() *Event

func Warn

func Warn() *Event

func (*Event) Attach

func (e *Event) Attach(extra interface{}) *Event

func (*Event) Clone

func (e *Event) Clone() *Event

func (*Event) E

func (e *Event) E(err error) *Event

func (*Event) GetCaller

func (e *Event) GetCaller() *caller

func (*Event) GetError

func (e *Event) GetError() error

func (*Event) GetExtra

func (e *Event) GetExtra() interface{}

func (*Event) GetKvs

func (e *Event) GetKvs() map[interface{}]interface{}

func (*Event) GetLevel

func (e *Event) GetLevel() Level

func (*Event) GetLogger

func (e *Event) GetLogger() *Logger

func (*Event) GetMsg

func (e *Event) GetMsg() string

func (*Event) GetStack

func (e *Event) GetStack() string

func (*Event) GetTags

func (e *Event) GetTags() map[interface{}]interface{}

func (*Event) GetTime

func (e *Event) GetTime() time.Time

func (*Event) Kv

func (e *Event) Kv(k, v interface{}) *Event

func (*Event) Log

func (e *Event) Log()

func (*Event) Logf

func (e *Event) Logf(msg string, args ...interface{})

func (*Event) Put

func (e *Event) Put()

func (*Event) Tag

func (e *Event) Tag(k interface{}, v interface{}) *Event

type Handler

type Handler interface {
	// Handle consumes the Event, determine whether Event should be consumed by the next Handler and parent's Handler.
	// It returns a decision for the Logger to determine whether to continue handling the Event or not.
	// And returns an error which will be handled by the Logger's errHandler.
	// For example,
	// (true, <error>) means the Event will be consumed by the next Handler.
	// (false, <error>) means the Event will not be sequentially handled.
	Handle(*Event) (bool, error)
	// Flush flushes buffered data (if any).
	// Handler could have an internal flush() mechanism.
	// However, in some cases, only Logger knows when to flush().
	Flush() error
	// Close releases resources used by Handler. If any buffered data, should flush() before close().
	Close() error
}

Handler mockery --name=Handler --inpackage --case=underscore --filename=handler_mock.go --structname MockHandler

type Level

type Level int8

const (
	DEBUG Level = iota - 1
	INFO
	WARN
	ERROR
	PANIC
	FATAL
)

func GetLevel

func GetLevel() Level

func (Level) String

func (l Level) String() string

type Logger

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

Logger is not thread safe Make sure to configure the Logger before emitting logs, And do not reconfigure the Logger during runtime.

func GetLogger

func GetLogger(name string) *Logger

func GetRootLogger

func GetRootLogger() *Logger

GetRootLogger is equivalent to GetLogger("")

func (*Logger) AddHandler

func (l *Logger) AddHandler(h Handler)

func (*Logger) Close

func (l *Logger) Close()

func (*Logger) Debug

func (l *Logger) Debug() *Event

func (*Logger) DelKv

func (l *Logger) DelKv(k interface{})

func (*Logger) DelTag

func (l *Logger) DelTag(k interface{})

func (*Logger) DisableCaller

func (l *Logger) DisableCaller(level Level)

func (*Logger) DisableStack

func (l *Logger) DisableStack(level Level)

func (*Logger) EnableCaller

func (l *Logger) EnableCaller(level Level)

func (*Logger) EnableStack

func (l *Logger) EnableStack(level Level)

func (*Logger) Error

func (l *Logger) Error() *Event

func (*Logger) Fatal

func (l *Logger) Fatal() *Event

func (*Logger) Flush

func (l *Logger) Flush()

func (*Logger) GetLevel

func (l *Logger) GetLevel() Level

func (*Logger) GetPropagate

func (l *Logger) GetPropagate() bool

func (*Logger) Info

func (l *Logger) Info() *Event

func (*Logger) Kvs

func (l *Logger) Kvs() map[interface{}]interface{}

func (*Logger) Name

func (l *Logger) Name() string

func (*Logger) Panic

func (l *Logger) Panic() *Event

func (*Logger) RemoveHandler

func (l *Logger) RemoveHandler(h Handler)

func (*Logger) ResetHandler

func (l *Logger) ResetHandler()

func (*Logger) ResetKv

func (l *Logger) ResetKv()

func (*Logger) ResetTag

func (l *Logger) ResetTag()

func (*Logger) SetErrorHandler

func (l *Logger) SetErrorHandler(w ErrorHandler)

func (*Logger) SetKv

func (l *Logger) SetKv(k interface{}, v interface{})

func (*Logger) SetLevel

func (l *Logger) SetLevel(level Level)

func (*Logger) SetPropagate

func (l *Logger) SetPropagate(propagate bool)

func (*Logger) SetTag

func (l *Logger) SetTag(k interface{}, v interface{})

func (*Logger) Tags

func (l *Logger) Tags() map[interface{}]interface{}

func (*Logger) Warn

func (l *Logger) Warn() *Event

type MockErrorHandler

type MockErrorHandler struct {
	mock.Mock
}

MockErrorHandler is an autogenerated mock type for the ErrorHandler type

func (*MockErrorHandler) Close

func (_m *MockErrorHandler) Close() error

Close provides a mock function with given fields:

func (*MockErrorHandler) Flush

func (_m *MockErrorHandler) Flush() error

Flush provides a mock function with given fields:

func (*MockErrorHandler) Handle

func (_m *MockErrorHandler) Handle(_a0 error) error

Handle provides a mock function with given fields: _a0

type MockHandler

type MockHandler struct {
	mock.Mock
}

MockHandler is an autogenerated mock type for the Handler type

func (*MockHandler) Close

func (_m *MockHandler) Close() error

Close provides a mock function with given fields:

func (*MockHandler) Flush

func (_m *MockHandler) Flush() error

Flush provides a mock function with given fields:

func (*MockHandler) Handle

func (_m *MockHandler) Handle(_a0 *Event) (bool, error)

Handle provides a mock function with given fields: _a0