micro/debug/log/memory/memory.go

120 lines
2.6 KiB
Go
Raw Normal View History

2019-12-17 18:16:45 +00:00
// Package memory provides an in memory log buffer
package memory
2019-11-27 16:02:16 +00:00
import (
"fmt"
"github.com/micro/go-micro/v3/debug/log"
"github.com/micro/go-micro/v3/util/ring"
2019-11-27 16:02:16 +00:00
)
var (
// DefaultSize of the logger buffer
2019-12-17 15:38:03 +00:00
DefaultSize = 1024
2019-11-27 16:02:16 +00:00
)
2019-12-17 18:16:45 +00:00
// memoryLog is default micro log
type memoryLog struct {
2019-12-17 15:38:03 +00:00
*ring.Buffer
2019-11-27 16:02:16 +00:00
}
// NewLog returns default Logger with
2019-12-17 18:16:45 +00:00
func NewLog(opts ...log.Option) log.Log {
2019-11-27 16:02:16 +00:00
// get default options
2019-12-17 18:16:45 +00:00
options := log.DefaultOptions()
2019-11-27 16:02:16 +00:00
// apply requested options
for _, o := range opts {
o(&options)
}
2019-12-17 18:16:45 +00:00
return &memoryLog{
2019-12-17 15:38:03 +00:00
Buffer: ring.New(options.Size),
2019-11-27 16:02:16 +00:00
}
}
2019-11-28 11:05:35 +00:00
// Write writes logs into logger
2019-12-17 18:16:45 +00:00
func (l *memoryLog) Write(r log.Record) error {
2019-12-18 16:02:11 +00:00
l.Buffer.Put(fmt.Sprint(r.Message))
2019-12-17 16:56:55 +00:00
return nil
2019-11-27 16:02:16 +00:00
}
2019-11-28 11:05:35 +00:00
// Read reads logs and returns them
2019-12-17 18:16:45 +00:00
func (l *memoryLog) Read(opts ...log.ReadOption) ([]log.Record, error) {
options := log.ReadOptions{}
// initialize the read options
for _, o := range opts {
o(&options)
2019-11-27 16:12:39 +00:00
}
2019-11-27 16:02:16 +00:00
2019-12-17 15:38:03 +00:00
var entries []*ring.Entry
// if Since options ha sbeen specified we honor it
if !options.Since.IsZero() {
entries = l.Buffer.Since(options.Since)
}
// only if we specified valid count constraint
// do we end up doing some serious if-else kung-fu
// if since constraint has been provided
// we return *count* number of logs since the given timestamp;
// otherwise we return last count number of logs
if options.Count > 0 {
switch len(entries) > 0 {
case true:
// if we request fewer logs than what since constraint gives us
if options.Count < len(entries) {
entries = entries[0:options.Count]
}
default:
entries = l.Buffer.Get(options.Count)
}
}
2019-11-28 11:05:35 +00:00
2019-12-17 18:16:45 +00:00
records := make([]log.Record, 0, len(entries))
for _, entry := range entries {
2019-12-17 18:16:45 +00:00
record := log.Record{
Timestamp: entry.Timestamp,
2019-12-18 16:02:11 +00:00
Message: entry.Value,
}
records = append(records, record)
}
2019-12-17 16:56:55 +00:00
return records, nil
2019-11-27 16:02:16 +00:00
}
// Stream returns channel for reading log records
2019-12-17 15:38:03 +00:00
// along with a stop channel, close it when done
2019-12-17 18:16:45 +00:00
func (l *memoryLog) Stream() (log.Stream, error) {
// get stream channel from ring buffer
2019-12-17 15:38:03 +00:00
stream, stop := l.Buffer.Stream()
// make a buffered channel
2019-12-17 18:16:45 +00:00
records := make(chan log.Record, 128)
// get last 10 records
last10 := l.Buffer.Get(10)
// stream the log records
go func() {
// first send last 10 records
for _, entry := range last10 {
2019-12-17 18:16:45 +00:00
records <- log.Record{
Timestamp: entry.Timestamp,
2019-12-18 16:02:11 +00:00
Message: entry.Value,
Metadata: make(map[string]string),
}
}
// now stream continuously
for entry := range stream {
2019-12-17 18:16:45 +00:00
records <- log.Record{
Timestamp: entry.Timestamp,
2019-12-18 16:02:11 +00:00
Message: entry.Value,
Metadata: make(map[string]string),
}
}
}()
2019-12-17 16:56:55 +00:00
return &logStream{
stream: records,
stop: stop,
}, nil
}