Move logger

debug/log/memory/memory.go

@@ -0,0 +1,119 @@
+// Package memory provides an in memory log buffer
+package memory
+
+import (
+	"fmt"
+
+	"github.com/micro/go-micro/debug/log"
+	"github.com/micro/go-micro/util/ring"
+)
+
+var (
+	// DefaultSize of the logger buffer
+	DefaultSize = 1024
+)
+
+// memoryLog is default micro log
+type memoryLog struct {
+	*ring.Buffer
+}
+
+// NewLog returns default Logger with
+func NewLog(opts ...log.Option) log.Log {
+	// get default options
+	options := log.DefaultOptions()
+
+	// apply requested options
+	for _, o := range opts {
+		o(&options)
+	}
+
+	return &memoryLog{
+		Buffer: ring.New(options.Size),
+	}
+}
+
+// Write writes logs into logger
+func (l *memoryLog) Write(r log.Record) error {
+	l.Buffer.Put(fmt.Sprint(r.Value))
+	return nil
+}
+
+// Read reads logs and returns them
+func (l *memoryLog) Read(opts ...log.ReadOption) ([]log.Record, error) {
+	options := log.ReadOptions{}
+	// initialize the read options
+	for _, o := range opts {
+		o(&options)
+	}
+
+	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)
+		}
+	}
+
+	records := make([]log.Record, 0, len(entries))
+	for _, entry := range entries {
+		record := log.Record{
+			Timestamp: entry.Timestamp,
+			Value:     entry.Value,
+		}
+		records = append(records, record)
+	}
+
+	return records, nil
+}
+
+// Stream returns channel for reading log records
+// along with a stop channel, close it when done
+func (l *memoryLog) Stream() (log.Stream, error) {
+	// get stream channel from ring buffer
+	stream, stop := l.Buffer.Stream()
+	// make a buffered channel
+	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 {
+			records <- log.Record{
+				Timestamp: entry.Timestamp,
+				Value:     entry.Value,
+				Metadata:  make(map[string]string),
+			}
+		}
+		// now stream continuously
+		for entry := range stream {
+			records <- log.Record{
+				Timestamp: entry.Timestamp,
+				Value:     entry.Value,
+				Metadata:  make(map[string]string),
+			}
+		}
+	}()
+
+	return &logStream{
+		stream: records,
+		stop:   stop,
+	}, nil
+}

debug/log/memory/memory_test.go

@@ -0,0 +1,32 @@
+package memory
+
+import (
+	"reflect"
+	"testing"
+
+	"github.com/micro/go-micro/debug/log"
+)
+
+func TestLogger(t *testing.T) {
+	// set size to some value
+	size := 100
+	// override the global logger
+	lg := NewLog(log.Size(size))
+	// make sure we have the right size of the logger ring buffer
+	if lg.(*memoryLog).Size() != size {
+		t.Errorf("expected buffer size: %d, got: %d", size, lg.(*memoryLog).Size())
+	}
+
+	// Log some cruft
+	lg.Write(log.Record{Value: "foobar"})
+	lg.Write(log.Record{Value: "foo bar"})
+
+	// Check if the logs are stored in the logger ring buffer
+	expected := []string{"foobar", "foo bar"}
+	entries, _ := lg.Read(log.Count(len(expected)))
+	for i, entry := range entries {
+		if !reflect.DeepEqual(entry.Value, expected[i]) {
+			t.Errorf("expected %s, got %s", expected[i], entry.Value)
+		}
+	}
+}

debug/log/memory/stream.go

@@ -0,0 +1,24 @@
+package memory
+
+import (
+	"github.com/micro/go-micro/debug/log"
+)
+
+type logStream struct {
+	stream <-chan log.Record
+	stop   chan bool
+}
+
+func (l *logStream) Chan() <-chan log.Record {
+	return l.stream
+}
+
+func (l *logStream) Stop() error {
+	select {
+	case <-l.stop:
+		return nil
+	default:
+		close(l.stop)
+	}
+	return nil
+}