Merge pull request #12 from riemann/feat/time-refactoring

[Breaking change] Refactoring event Time
riemann · Apr 24, 2017 · 121dccf · 121dccf
2 parents 0f94ab1 + c9cf1ed
commit 121dccf
Show file tree

Hide file tree

Showing 10 changed files with 177 additions and 79 deletions.
diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-RIEMANN_VERSION = 0.2.12
+RIEMANN_VERSION = 0.2.13
 
 all:    install
 

diff --git a/README.md b/README.md
@@ -8,6 +8,7 @@ Features:
 * Idiomatic concurrency
 * Sending events, queries.
 * Support TCP, UDP, TLS clients.
+* Second and Microsecond time resolution
 
 This client is a fork of Goryman, a Riemann go client written by Christopher Gilbert. Thanks and full credit to him!
 

diff --git a/event.go b/event.go
@@ -1,11 +1,13 @@
 package riemanngo
 
-import ()
+import (
+	"time"
+)
 
 // Event is a wrapper for Riemann events
 type Event struct {
 	Ttl         float32
-	Time        int64
+	Time        time.Time
 	Tags        []string
 	Host        string // Defaults to os.Hostname()
 	State       string

diff --git a/marshal.go b/marshal.go
@@ -4,8 +4,8 @@ import (
 	"fmt"
 	"os"
 	"reflect"
-	"time"
 	"sort"
+	"time"
 
 	pb "github.com/golang/protobuf/proto"
 	"github.com/riemann/riemann-go-client/proto"
@@ -16,13 +16,14 @@ func EventToProtocolBuffer(event *Event) (*proto.Event, error) {
 	if event.Host == "" {
 		event.Host, _ = os.Hostname()
 	}
-	if event.Time == 0 {
-		event.Time = time.Now().Unix()
+	if event.Time.IsZero() {
+		event.Time = time.Now()
 	}
 
 	var e proto.Event
 	e.Host = pb.String(event.Host)
-	e.Time = pb.Int64(event.Time)
+	e.Time = pb.Int64(event.Time.Unix())
+	e.TimeMicros = pb.Int64(event.Time.UnixNano() / int64(time.Microsecond))
 	if event.Service != "" {
 		e.Service = pb.String(event.Service)
 	}
@@ -77,9 +78,13 @@ func ProtocolBuffersToEvents(pbEvents []*proto.Event) []Event {
 			Host:        event.GetHost(),
 			Description: event.GetDescription(),
 			Ttl:         event.GetTtl(),
-			Time:        event.GetTime(),
 			Tags:        event.GetTags(),
 		}
+		if event.TimeMicros != nil {
+			e.Time = time.Unix(0, event.GetTimeMicros()*int64(time.Microsecond))
+		} else if event.Time != nil {
+			e.Time = time.Unix(event.GetTime(), 0)
+		}
 		if event.MetricF != nil {
 			e.Metric = event.GetMetricF()
 		} else if event.MetricD != nil {

diff --git a/marshal_test.go b/marshal_test.go
@@ -4,6 +4,7 @@ import (
 	pb "github.com/golang/protobuf/proto"
 	"github.com/riemann/riemann-go-client/proto"
 	"testing"
+	"time"
 )
 
 func TestEventToProtocolBuffer(t *testing.T) {
@@ -14,7 +15,7 @@ func TestEventToProtocolBuffer(t *testing.T) {
 		Service: "foobar",
 		Metric:  m,
 		Tags:    []string{"hello"},
-		Time:    100,
+		Time:    time.Unix(100, 0),
 	}
 	protoRes, error := EventToProtocolBuffer(&event)
 	if error != nil {
@@ -23,6 +24,7 @@ func TestEventToProtocolBuffer(t *testing.T) {
 	protoTest := proto.Event{
 		Host:         pb.String("baz"),
 		Time:         pb.Int64(100),
+		TimeMicros:   pb.Int64(100000000),
 		MetricSint64: pb.Int64(100),
 		Service:      pb.String("foobar"),
 		Tags:         []string{"hello"},
@@ -36,7 +38,7 @@ func TestEventToProtocolBuffer(t *testing.T) {
 		Service: "foobar",
 		Metric:  100,
 		Tags:    []string{"hello"},
-		Time:    100,
+		Time:    time.Unix(100, 0),
 	}
 	protoRes, error = EventToProtocolBuffer(&event)
 	if error != nil {
@@ -45,6 +47,7 @@ func TestEventToProtocolBuffer(t *testing.T) {
 	protoTest = proto.Event{
 		Host:         pb.String("baz"),
 		Time:         pb.Int64(100),
+		TimeMicros:   pb.Int64(100000000),
 		MetricSint64: pb.Int64(100),
 		Service:      pb.String("foobar"),
 		Tags:         []string{"hello"},
@@ -58,7 +61,7 @@ func TestEventToProtocolBuffer(t *testing.T) {
 		Service: "foobar",
 		Metric:  100.1,
 		Tags:    []string{"hello"},
-		Time:    100,
+		Time:    time.Unix(100, 0),
 		Ttl:     10,
 		Attributes: map[string]string{
 			"foo": "bar",
@@ -70,18 +73,19 @@ func TestEventToProtocolBuffer(t *testing.T) {
 		t.Error("Error during EventToProtocolBuffer")
 	}
 	protoTest = proto.Event{
-		Host:    pb.String("baz"),
-		Time:    pb.Int64(100),
-		MetricD: pb.Float64(100.1),
-		Service: pb.String("foobar"),
-		Tags:    []string{"hello"},
-		Ttl:     pb.Float32(10),
+		Host:       pb.String("baz"),
+		Time:       pb.Int64(100),
+		TimeMicros: pb.Int64(100000000),
+		MetricD:    pb.Float64(100.1),
+		Service:    pb.String("foobar"),
+		Tags:       []string{"hello"},
+		Ttl:        pb.Float32(10),
 		Attributes: []*proto.Attribute{
-			&proto.Attribute{
+			{
 				Key:   pb.String("bar"),
 				Value: pb.String("baz"),
 			},
-			&proto.Attribute{
+			{
 				Key:   pb.String("foo"),
 				Value: pb.String("bar"),
 			},
@@ -99,7 +103,7 @@ func TestEventToProtocolBuffer(t *testing.T) {
 		State:       "critical",
 		Metric:      100,
 		Tags:        []string{"hello"},
-		Time:        100,
+		Time:        time.Unix(100, 0),
 	}
 	protoRes, error = EventToProtocolBuffer(&event)
 	if error != nil {
@@ -108,6 +112,7 @@ func TestEventToProtocolBuffer(t *testing.T) {
 	protoTest = proto.Event{
 		Host:         pb.String("baz"),
 		Time:         pb.Int64(100),
+		TimeMicros:   pb.Int64(100000000),
 		Ttl:          pb.Float32(20),
 		Description:  pb.String("desc"),
 		State:        pb.String("critical"),
@@ -127,7 +132,7 @@ func TestEventToProtocolBuffer(t *testing.T) {
 		State:       "critical",
 		Metric:      int64(100),
 		Tags:        []string{"hello"},
-		Time:        100,
+		Time:        time.Unix(100, 0),
 	}
 	protoRes, error = EventToProtocolBuffer(&event)
 	if error != nil {
@@ -136,6 +141,7 @@ func TestEventToProtocolBuffer(t *testing.T) {
 	protoTest = proto.Event{
 		Host:         pb.String("baz"),
 		Time:         pb.Int64(100),
+		TimeMicros:   pb.Int64(100000000),
 		Ttl:          pb.Float32(20),
 		Description:  pb.String("desc"),
 		State:        pb.String("critical"),
@@ -155,21 +161,22 @@ func TestEventToProtocolBuffer(t *testing.T) {
 		State:       "critical",
 		Metric:      float32(100.0),
 		Tags:        []string{"hello"},
-		Time:        100,
+		Time:        time.Unix(100, 0),
 	}
 	protoRes, error = EventToProtocolBuffer(&event)
 	if error != nil {
 		t.Error("Error during EventToProtocolBuffer")
 	}
 	protoTest = proto.Event{
-		Host:         pb.String("baz"),
-		Time:         pb.Int64(100),
-		Ttl:          pb.Float32(20),
-		Description:  pb.String("desc"),
-		State:        pb.String("critical"),
-		MetricD:      pb.Float64(100.0),
-		Service:      pb.String("foobar"),
-		Tags:         []string{"hello"},
+		Host:        pb.String("baz"),
+		Time:        pb.Int64(100),
+		TimeMicros:  pb.Int64(100000000),
+		Ttl:         pb.Float32(20),
+		Description: pb.String("desc"),
+		State:       pb.String("critical"),
+		MetricD:     pb.Float64(100.0),
+		Service:     pb.String("foobar"),
+		Tags:        []string{"hello"},
 	}
 	if !pb.Equal(protoRes, &protoTest) {
 		t.Error("Error during event to protobuf conversion")
@@ -183,7 +190,33 @@ func TestEventToProtocolBuffer(t *testing.T) {
 		State:       "critical",
 		Metric:      float64(100.12),
 		Tags:        []string{"hello"},
-		Time:        100,
+		Time:        time.Unix(100, 0),
+	}
+	protoRes, error = EventToProtocolBuffer(&event)
+	if error != nil {
+		t.Error("Error during EventToProtocolBuffer")
+	}
+	protoTest = proto.Event{
+		Host:        pb.String("baz"),
+		Time:        pb.Int64(100),
+		TimeMicros:  pb.Int64(100000000),
+		Ttl:         pb.Float32(20),
+		Description: pb.String("desc"),
+		State:       pb.String("critical"),
+		MetricD:     pb.Float64(100.12),
+		Service:     pb.String("foobar"),
+		Tags:        []string{"hello"},
+	}
+	if !pb.Equal(protoRes, &protoTest) {
+		t.Error("Error during event to protobuf conversion")
+	}
+	// simple event with time in nanosecond
+	event = Event{
+		Host:    "baz",
+		Service: "foobar",
+		Metric:  m,
+		Tags:    []string{"hello"},
+		Time:    time.Unix(100, 123456789),
 	}
 	protoRes, error = EventToProtocolBuffer(&event)
 	if error != nil {
@@ -192,10 +225,8 @@ func TestEventToProtocolBuffer(t *testing.T) {
 	protoTest = proto.Event{
 		Host:         pb.String("baz"),
 		Time:         pb.Int64(100),
-		Ttl:          pb.Float32(20),
-		Description:  pb.String("desc"),
-		State:        pb.String("critical"),
-		MetricD:      pb.Float64(100.12),
+		TimeMicros:   pb.Int64(100123456),
+		MetricSint64: pb.Int64(100),
 		Service:      pb.String("foobar"),
 		Tags:         []string{"hello"},
 	}
@@ -249,7 +280,7 @@ func compareEvents(e1 *Event, e2 *Event, t *testing.T) {
 
 func TestProtocolBuffersToEvents(t *testing.T) {
 	pbEvents := []*proto.Event{
-		&proto.Event{
+		{
 			Host:         pb.String("baz"),
 			Time:         pb.Int64(100),
 			Ttl:          pb.Float32(20),
@@ -262,7 +293,7 @@ func TestProtocolBuffersToEvents(t *testing.T) {
 	}
 	event := Event{
 		Host:        "baz",
-		Time:        100,
+		Time:        time.Unix(100, 0),
 		Ttl:         20,
 		Description: "desc",
 		State:       "critical",
@@ -273,7 +304,7 @@ func TestProtocolBuffersToEvents(t *testing.T) {
 	events := ProtocolBuffersToEvents(pbEvents)
 	compareEvents(&events[0], &event, t)
 	pbEvents = []*proto.Event{
-		&proto.Event{
+		{
 			Host:         pb.String("baz"),
 			Time:         pb.Int64(100),
 			Ttl:          pb.Float32(20),
@@ -283,7 +314,7 @@ func TestProtocolBuffersToEvents(t *testing.T) {
 			Service:      pb.String("foobar"),
 			Tags:         []string{"hello"},
 		},
-		&proto.Event{
+		{
 			Host:        pb.String("baz"),
 			Time:        pb.Int64(100),
 			Ttl:         pb.Float32(20),
@@ -293,11 +324,11 @@ func TestProtocolBuffersToEvents(t *testing.T) {
 			Service:     pb.String("foobar"),
 			Tags:        []string{"hello"},
 			Attributes: []*proto.Attribute{
-				&proto.Attribute{
+				{
 					Key:   pb.String("foo"),
 					Value: pb.String("bar"),
 				},
-				&proto.Attribute{
+				{
 					Key:   pb.String("bar"),
 					Value: pb.String("baz"),
 				},
@@ -306,7 +337,7 @@ func TestProtocolBuffersToEvents(t *testing.T) {
 	}
 	event1 := Event{
 		Host:        "baz",
-		Time:        100,
+		Time:        time.Unix(100, 0),
 		Ttl:         20,
 		Description: "desc",
 		State:       "critical",
@@ -321,7 +352,7 @@ func TestProtocolBuffersToEvents(t *testing.T) {
 		State:       "critical",
 		Metric:      100.1,
 		Tags:        []string{"hello"},
-		Time:        100,
+		Time:        time.Unix(100, 0),
 		Ttl:         20,
 		Attributes: map[string]string{
 			"foo": "bar",
@@ -331,4 +362,55 @@ func TestProtocolBuffersToEvents(t *testing.T) {
 	events = ProtocolBuffersToEvents(pbEvents)
 	compareEvents(&events[0], &event1, t)
 	compareEvents(&events[1], &event2, t)
+
+	pbEvents = []*proto.Event{
+		{
+			Host:         pb.String("baz"),
+			Time:         pb.Int64(100),
+			TimeMicros:   pb.Int64(100123456),
+			Ttl:          pb.Float32(20),
+			Description:  pb.String("desc"),
+			State:        pb.String("critical"),
+			MetricSint64: pb.Int64(100),
+			Service:      pb.String("foobar"),
+			Tags:         []string{"hello"},
+		},
+	}
+	event = Event{
+		Host:        "baz",
+		Time:        time.Unix(100, 123456000),
+		Ttl:         20,
+		Description: "desc",
+		State:       "critical",
+		Metric:      int64(100),
+		Service:     "foobar",
+		Tags:        []string{"hello"},
+	}
+	events = ProtocolBuffersToEvents(pbEvents)
+	compareEvents(&events[0], &event, t)
+
+	pbEvents = []*proto.Event{
+		{
+			Host:         pb.String("baz"),
+			TimeMicros:   pb.Int64(100123456),
+			Ttl:          pb.Float32(20),
+			Description:  pb.String("desc"),
+			State:        pb.String("critical"),
+			MetricSint64: pb.Int64(100),
+			Service:      pb.String("foobar"),
+			Tags:         []string{"hello"},
+		},
+	}
+	event = Event{
+		Host:        "baz",
+		Time:        time.Unix(100, 123456000),
+		Ttl:         20,
+		Description: "desc",
+		State:       "critical",
+		Metric:      int64(100),
+		Service:     "foobar",
+		Tags:        []string{"hello"},
+	}
+	events = ProtocolBuffersToEvents(pbEvents)
+	compareEvents(&events[0], &event, t)
 }