Simplified Logs RPC. Cleaned up code. Added comments.

debug/log/default.go

@@ -50,13 +50,24 @@ func (l *defaultLog) Read(opts ...ReadOption) []Record {
 	// if Since options ha sbeen specified we honor it
 	if !options.Since.IsZero() {
 		entries = l.Buffer.Since(options.Since)
-	} else {
-		// otherwie return last count entries
-		entries = l.Buffer.Get(options.Count)
 	}
 
-	// TODO: if both Since and Count are set should we return?
-	// last Count from the returned time scoped entries?
+	// only if we specified valid count constraint
+	// do we do some serious if-else kung-fu
+	// if since has been given we return *count* number of
+	// logs since the requested timestamp;
+	// otherwise we retourn 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([]Record, 0, len(entries))
 	for _, entry := range entries {
@@ -66,5 +77,6 @@ func (l *defaultLog) Read(opts ...ReadOption) []Record {
 		}
 		records = append(records, record)
 	}
+
 	return records
 }

debug/log/default_test.go

@@ -9,21 +9,21 @@ func TestLogger(t *testing.T) {
 	// set size to some value
 	size := 100
 	// override the global logger
-	logger = NewLog(Size(size))
+	DefaultLog = NewLog(Size(size))
 	// make sure we have the right size of the logger ring buffer
-	if logger.(*defaultLog).Size() != size {
-		t.Errorf("expected buffer size: %d, got: %d", size, logger.(*defaultLog).Size())
+	if DefaultLog.(*defaultLog).Size() != size {
+		t.Errorf("expected buffer size: %d, got: %d", size, DefaultLog.(*defaultLog).Size())
 	}
 
 	// Log some cruft
 	Info("foobar")
 	// increase the log level
-	level = LevelDebug
+	DefaultLevel = LevelDebug
 	Debugf("foo %s", "bar")
 
 	// Check if the logs are stored in the logger ring buffer
 	expected := []string{"foobar", "foo bar"}
-	entries := logger.Read(Count(len(expected)))
+	entries := DefaultLog.Read(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/options.go

@@ -31,6 +31,8 @@ type ReadOptions struct {
 	Since time.Time
 	// Count specifies number of logs to return
 	Count int
+	// Stream requests continuous log stream
+	Stream bool
 }
 
 // ReadOption used for reading the logs
@@ -49,3 +51,10 @@ func Count(c int) ReadOption {
 		o.Count = c
 	}
 }
+
+// Stream requests continuous log stream
+func Stream(s bool) ReadOption {
+	return func(o *ReadOptions) {
+		o.Stream = s
+	}
+}