spi

Documentation

Index

• Constants
• Variables
• func AddLogContext(ctx context.Context, key string, value interface{})
• func ColoredLevelName(level int) string
• func LevelName(level int) string
• type DummyEventHandler
  • func (handler *DummyEventHandler) Handle(event *Event)
  • func (handler *DummyEventHandler) LogSite() *LogSite
• type Event
• type EventHandler
• type EventHandlers
  • func (handlers EventHandlers) Handle(event *Event)
  • func (handlers EventHandlers) LogSite() *LogSite
• type EventSink
• type FuncEventHandler
  • func (handler FuncEventHandler) Handle(event *Event)
  • func (handler FuncEventHandler) LogSite() *LogSite
• type FuncEventSink
  • func (sink FuncEventSink) HandlerOf(site *LogSite) EventHandler
• type LogContext
  • func GetLogContext(ctx context.Context) *LogContext
• type LogSite
  • func (site *LogSite) Location() string
  • func (site *LogSite) LogContext() *LogContext
• type Memo

Constants

const LevelDebug = 20

const LevelDebugCall = 15

const LevelError = 50

LevelError is the level for user visible error

const LevelFatal = 60

LevelFatal is the level for panic or panic like scenario

const LevelInfo = 30

LevelInfo should be the production environment default

const LevelInfoCall = 25

const LevelTrace = 10

LevelTrace should be development environment default

const LevelTraceCall = 5

LevelTraceCall is lowest logging level enable this will print every TraceCall, which is a LOT

const LevelWarn = 40

LevelWarn is the level for error != nil

Variables

var LogContextKey = 1010010001

var MinCallLevel = LevelDebugCall

MinCallLevel will be half level higher than MinLevel to minimize the xxxCall output

var MinLevel = LevelTrace

MinLevel exists to minimize the overhead of Trace/Debug logging

Functions

func AddLogContext

func AddLogContext(ctx context.Context, key string, value interface{})

func ColoredLevelName

func ColoredLevelName(level int) string

func LevelName

func LevelName(level int) string

Types

type DummyEventHandler

type DummyEventHandler struct {
	Site *LogSite
}

func (*DummyEventHandler) Handle

func (handler *DummyEventHandler) Handle(event *Event)

func (*DummyEventHandler) LogSite

func (handler *DummyEventHandler) LogSite() *LogSite

type Event

type Event struct {
	Level      int
	Context    context.Context
	Error      error
	Timestamp  time.Time
	Properties []interface{}
}

type EventHandler

type EventHandler interface {
	Handle(event *Event)
	LogSite() *LogSite
}

type EventHandlers

type EventHandlers []EventHandler

func (EventHandlers) Handle

func (handlers EventHandlers) Handle(event *Event)

func (EventHandlers) LogSite

func (handlers EventHandlers) LogSite() *LogSite

type EventSink

type EventSink interface {
	HandlerOf(site *LogSite) EventHandler
}

type FuncEventHandler

type FuncEventHandler func(event *Event)

func (FuncEventHandler) Handle

func (handler FuncEventHandler) Handle(event *Event)

func (FuncEventHandler) LogSite

func (handler FuncEventHandler) LogSite() *LogSite

type FuncEventSink

type FuncEventSink func(site *LogSite) EventHandler

func (FuncEventSink) HandlerOf

func (sink FuncEventSink) HandlerOf(site *LogSite) EventHandler

type LogContext

type LogContext struct {
	Memos      [][]byte
	Properties []interface{}
}

func GetLogContext

func GetLogContext(ctx context.Context) *LogContext

type LogSite

type LogSite struct {
	Context context.Context
	Func    string
	File    string
	Line    int
	Event   string
	Agg     string
	Sample  []interface{}
}

LogSite is the location of log in the source code

func (*LogSite) Location

func (site *LogSite) Location() string

func (*LogSite) LogContext

func (site *LogSite) LogContext() *LogContext

type Memo

type Memo struct {
	Site  *LogSite
	Event *Event
}