log

type FormatFunc func(Record) string

type Log interface {
	// Read reads log entries from the logger
	// Read 从日志记录器中读取日志条目
	Read(...ReadOption) ([]Record, error)
	// Write writes records to log
	// Write 将记录写入日志
	Write(Record) error
	// Stream log records
	// Stream 日志记录流
	Stream() (Stream, error)
}

type Option func(*Options)

type Options struct {
	// Name of the log
	// 日志的名称
	Name string
	// Size is the size of ring buffer
	// Size 是环形缓冲区的大小
	Size int
	// Format specifies the output format
	// Format 指定输出格式
	Format FormatFunc
}

type ReadOption func(*ReadOptions)

type ReadOptions struct {
	// Since what time in past to return the logs
	// 从过去的哪个时间点开始返回日志
	Since time.Time
	// Count specifies number of logs to return
	// Count 指定要返回的日志数量
	Count int
	// Stream requests continuous log stream
	// Stream 请求连续的日志流
	Stream bool
}

type Record struct {
	// Timestamp of logged event
	// 日志事件的时间戳
	Timestamp time.Time `json:"timestamp"`
	// Metadata to enrich log record
	// 用于丰富日志记录的元数据
	Metadata map[string]string `json:"metadata"`
	// Value contains log entry
	// 包含日志条目的值
	Message interface{} `json:"message"`
}

type Stream interface {
	Chan() <-chan Record
	Stop() error
}