nucliozap

Documentation

Index

• Variables
• type BufferLogger
  • func NewBufferLogger(name string, encoding string, level Level) (*BufferLogger, error)
  • func (bl *BufferLogger) GetJSONString() (string, error)
  • func (bl *BufferLogger) GetLogEntries() ([]map[string]interface{}, error)
• type BufferLoggerPool
  • func NewBufferLoggerPool(numBufferLoggers int, name string, encoding string, level Level) (*BufferLoggerPool, error)
  • func (blp *BufferLoggerPool) Allocate(timeout *time.Duration) (*BufferLogger, error)
  • func (blp *BufferLoggerPool) Release(bufferLogger *BufferLogger)
• type Level
  • func GetLevelByName(levelName string) Level
• type MuxLogger
  • func NewMuxLogger(loggers ...nuclio.Logger) (*MuxLogger, error)
  • func (ml *MuxLogger) Debug(format interface{}, vars ...interface{})
  • func (ml *MuxLogger) DebugWith(format interface{}, vars ...interface{})
  • func (ml *MuxLogger) Error(format interface{}, vars ...interface{})
  • func (ml *MuxLogger) ErrorWith(format interface{}, vars ...interface{})
  • func (ml *MuxLogger) Flush()
  • func (ml *MuxLogger) GetChild(name string) interface{}
  • func (ml *MuxLogger) Info(format interface{}, vars ...interface{})
  • func (ml *MuxLogger) InfoWith(format interface{}, vars ...interface{})
  • func (ml *MuxLogger) SetLoggers(loggers ...nuclio.Logger)
  • func (ml *MuxLogger) Warn(format interface{}, vars ...interface{})
  • func (ml *MuxLogger) WarnWith(format interface{}, vars ...interface{})
• type NuclioZap
  • func NewNuclioZap(name string, encoding string, sink io.Writer, errSink io.Writer, level Level) (*NuclioZap, error)
  • func NewNuclioZapCmd(name string, level Level) (*NuclioZap, error)
  • func NewNuclioZapTest(name string) (*NuclioZap, error)
  • func (nz *NuclioZap) Debug(format interface{}, vars ...interface{})
  • func (nz *NuclioZap) DebugWith(format interface{}, vars ...interface{})
  • func (nz *NuclioZap) Error(format interface{}, vars ...interface{})
  • func (nz *NuclioZap) ErrorWith(format interface{}, vars ...interface{})
  • func (nz *NuclioZap) Flush()
  • func (nz *NuclioZap) GetChild(name string) interface{}
  • func (nz *NuclioZap) GetLevel() Level
  • func (nz *NuclioZap) Info(format interface{}, vars ...interface{})
  • func (nz *NuclioZap) InfoWith(format interface{}, vars ...interface{})
  • func (nz *NuclioZap) SetLevel(level Level)
  • func (nz *NuclioZap) Warn(format interface{}, vars ...interface{})
  • func (nz *NuclioZap) WarnWith(format interface{}, vars ...interface{})

Variables

var ErrBufferPoolAllocationTimeout = errors.New("Timed out waiting for buffer logger")

Types

type BufferLogger

type BufferLogger struct {
	Logger *NuclioZap
	Buffer *bytes.Buffer
	// contains filtered or unexported fields
}

a logger who outputs the records to a buffer

func NewBufferLogger

func NewBufferLogger(name string, encoding string, level Level) (*BufferLogger, error)

func (*BufferLogger) GetJSONString

func (bl *BufferLogger) GetJSONString() (string, error)

func (*BufferLogger) GetLogEntries

func (bl *BufferLogger) GetLogEntries() ([]map[string]interface{}, error)

type BufferLoggerPool

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

a pool for buffer loggers

func NewBufferLoggerPool

func NewBufferLoggerPool(numBufferLoggers int,
	name string,
	encoding string,
	level Level) (*BufferLoggerPool, error)

a pool of buffer loggers

func (*BufferLoggerPool) Allocate

func (blp *BufferLoggerPool) Allocate(timeout *time.Duration) (*BufferLogger, error)

func (*BufferLoggerPool) Release

func (blp *BufferLoggerPool) Release(bufferLogger *BufferLogger)

type Level

type Level int8

Level is logging levels

const (
	DebugLevel  Level = Level(zapcore.DebugLevel)
	InfoLevel   Level = Level(zapcore.InfoLevel)
	WarnLevel   Level = Level(zapcore.WarnLevel)
	ErrorLevel  Level = Level(zapcore.ErrorLevel)
	DPanicLevel Level = Level(zapcore.DPanicLevel)
	PanicLevel  Level = Level(zapcore.PanicLevel)
	FatalLevel  Level = Level(zapcore.FatalLevel)
)

Predefined logging levels

func GetLevelByName

func GetLevelByName(levelName string) Level

GetLevelByName return logging level by name

type MuxLogger

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

a logger that multiplexes logs towards multiple loggers

func NewMuxLogger

func NewMuxLogger(loggers ...nuclio.Logger) (*MuxLogger, error)

func (*MuxLogger) Debug

func (ml *MuxLogger) Debug(format interface{}, vars ...interface{})

func (*MuxLogger) DebugWith

func (ml *MuxLogger) DebugWith(format interface{}, vars ...interface{})

func (*MuxLogger) Error

func (ml *MuxLogger) Error(format interface{}, vars ...interface{})

func (*MuxLogger) ErrorWith

func (ml *MuxLogger) ErrorWith(format interface{}, vars ...interface{})

func (*MuxLogger) Flush

func (ml *MuxLogger) Flush()

func (*MuxLogger) GetChild

func (ml *MuxLogger) GetChild(name string) interface{}

func (*MuxLogger) Info

func (ml *MuxLogger) Info(format interface{}, vars ...interface{})

func (*MuxLogger) InfoWith

func (ml *MuxLogger) InfoWith(format interface{}, vars ...interface{})

func (*MuxLogger) SetLoggers

func (ml *MuxLogger) SetLoggers(loggers ...nuclio.Logger)

func (*MuxLogger) Warn

func (ml *MuxLogger) Warn(format interface{}, vars ...interface{})

func (*MuxLogger) WarnWith

func (ml *MuxLogger) WarnWith(format interface{}, vars ...interface{})

type NuclioZap

type NuclioZap struct {
	*zap.SugaredLogger
	// contains filtered or unexported fields
}

NuclioZap is a concrete implementation of the nuclio logger interface, using zap

func NewNuclioZap

func NewNuclioZap(name string,
	encoding string,
	sink io.Writer,
	errSink io.Writer,
	level Level) (*NuclioZap, error)

NewNuclioZap create a configurable logger

func NewNuclioZapCmd

func NewNuclioZapCmd(name string, level Level) (*NuclioZap, error)

NewNuclioZapCmd creates a logger pre-configured for commands

func NewNuclioZapTest

func NewNuclioZapTest(name string) (*NuclioZap, error)

NewNuclioZapTest creates a logger pre-configured for tests

func (*NuclioZap) Debug

func (nz *NuclioZap) Debug(format interface{}, vars ...interface{})

Debug emits debug level log

func (*NuclioZap) DebugWith

func (nz *NuclioZap) DebugWith(format interface{}, vars ...interface{})

DebugWith emits debug level log with arguments

func (*NuclioZap) Error

func (nz *NuclioZap) Error(format interface{}, vars ...interface{})

Errors emits error level log

func (*NuclioZap) ErrorWith

func (nz *NuclioZap) ErrorWith(format interface{}, vars ...interface{})

ErrorWith emits error level log with arguments

func (*NuclioZap) Flush

func (nz *NuclioZap) Flush()

Flush flushes the log

func (*NuclioZap) GetChild

func (nz *NuclioZap) GetChild(name string) interface{}

GetChild returned a named child logger

func (*NuclioZap) GetLevel

func (nz *NuclioZap) GetLevel() Level

GetLevel returns the current logging level

func (*NuclioZap) Info

func (nz *NuclioZap) Info(format interface{}, vars ...interface{})

Info emits info level log

func (*NuclioZap) InfoWith

func (nz *NuclioZap) InfoWith(format interface{}, vars ...interface{})

InfoWith emits info level log with arguments

func (*NuclioZap) SetLevel

func (nz *NuclioZap) SetLevel(level Level)

SetLevel sets the logging level

func (*NuclioZap) Warn

func (nz *NuclioZap) Warn(format interface{}, vars ...interface{})

Warn emits warn level log

func (*NuclioZap) WarnWith

func (nz *NuclioZap) WarnWith(format interface{}, vars ...interface{})

WarnWith emits warn level log with arguments