utils

Documentation

Index

• Constants
• type LogCollector
  • func NewLogCollector() *LogCollector
  • func (lc *LogCollector) GetLogs() []LogItem
  • func (lc *LogCollector) Log(msg string, level LogLevel)
• type LogItem
• type LogLevel

Constants

const (
	// DefaultLogCollectorMaxItems defines default maximum size of LogCollector.
	DefaultLogCollectorMaxItems = 50
	// DefaultLogCollectorItemLifetime is the default time after which LogItem will be removed from LogCollector.
	DefaultLogCollectorItemLifetime = 15 * time.Minute
)

Types

type LogCollector

type LogCollector struct {
	sync.Mutex
	// contains filtered or unexported fields
}

LogCollector keeps recent log events. It is automatically truncated on each access based on predefined set of conditions.

func NewLogCollector

func NewLogCollector() *LogCollector

NewLogCollector creates new LogCollector.

func (*LogCollector) GetLogs

func (lc *LogCollector) GetLogs() []LogItem

GetLogs returns a copy of messages in log. This is an actual copy, so it will not reflect any future changes in log.

func (*LogCollector) Log

func (lc *LogCollector) Log(msg string, level LogLevel)

Log logs a single provided message in LogCollector.

type LogItem

type LogItem struct {
	// Log is the logged message body.
	Log string
	// Level describes log severity.
	Level LogLevel
	// Timestamp when the Log was created.
	Timestamp time.Time
}

LogItem is a single entry in log managed by LogCollector.

type LogLevel

type LogLevel string

LogLevel describes severity of log entry.

const (
	// Debug log level.
	Debug LogLevel = "DEBUG"
	// Info log level.
	Info LogLevel = "INFO"
	// Warning log level.
	Warning LogLevel = "WARNING"
	// Error log level.
	Error LogLevel = "ERROR"
)