Merge pull request #13 from istreamlabs/upgrade-dd-client

sslotnick-isp · web-flow · commit af57a979f93b · 2020-03-13T11:56:16.000-10:00
Upgrade DataDog client to 3.x, add support for Distribution()
diff --git a/Gopkg.lock b/Gopkg.lock
diff --git a/Gopkg.toml b/Gopkg.toml
diff --git a/go.mod b/go.mod
@@ -3,9 +3,10 @@ module github.com/istreamlabs/go-metrics
 go 1.12
 
 require (
-	github.com/DataDog/datadog-go v2.3.0+incompatible
-	github.com/mattn/go-colorable v0.0.9
-	github.com/mattn/go-isatty v0.0.3
+	github.com/DataDog/datadog-go v3.4.1+incompatible
+	github.com/mattn/go-colorable v0.1.6 // indirect
+	github.com/mattn/go-isatty v0.0.12
 	github.com/mgutz/ansi v0.0.0-20170206155736-9520e82c474b
-	golang.org/x/sys v0.0.0-20180314180151-89ac7f292d17
+	github.com/stretchr/testify v1.5.1 // indirect
+	golang.org/x/sys v0.0.0-20200302150141-5c8b2ff67527 // indirect
 )
diff --git a/go.sum b/go.sum
@@ -1,12 +1,24 @@
-github.com/DataDog/datadog-go v2.2.0+incompatible h1:V5BKkxACZLjzHjSgBbr2gvLA2Ae49yhc6CSY7MLy5k4=
-github.com/DataDog/datadog-go v2.2.0+incompatible/go.mod h1:LButxg5PwREeZtORoXG3tL4fMGNddJ+vMq1mwgfaqoQ=
-github.com/DataDog/datadog-go v2.3.0+incompatible h1:ypCT7tHzMUrUKjdHX6GGEsGq0yi0IYMaljwN5b6hbIc=
-github.com/DataDog/datadog-go v2.3.0+incompatible/go.mod h1:LButxg5PwREeZtORoXG3tL4fMGNddJ+vMq1mwgfaqoQ=
-github.com/mattn/go-colorable v0.0.9 h1:UVL0vNpWh04HeJXV0KLcaT7r06gOH2l4OW6ddYRUIY4=
-github.com/mattn/go-colorable v0.0.9/go.mod h1:9vuHe8Xs5qXnSaW/c/ABM9alt+Vo+STaOChaDxuIBZU=
-github.com/mattn/go-isatty v0.0.3 h1:ns/ykhmWi7G9O+8a448SecJU3nSMBXJfqQkl0upE1jI=
-github.com/mattn/go-isatty v0.0.3/go.mod h1:M+lRXTBqGeGNdLjl/ufCoiOlB5xdOkqRJdNxMWT7Zi4=
+github.com/DataDog/datadog-go v3.4.1+incompatible h1:hRUopimy+td4Lc3QDvP/hsbQKI3n5xsmGJTRghwaA7U=
+github.com/DataDog/datadog-go v3.4.1+incompatible/go.mod h1:LButxg5PwREeZtORoXG3tL4fMGNddJ+vMq1mwgfaqoQ=
+github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/mattn/go-colorable v0.1.6 h1:6Su7aK7lXmJ/U79bYtBjLNaha4Fs1Rg9plHpcH+vvnE=
+github.com/mattn/go-colorable v0.1.6/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc=
+github.com/mattn/go-isatty v0.0.12 h1:wuysRhFDzyxgEmMf5xjvJ2M9dZoWAXNNr5LSBS7uHXY=
+github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU=
 github.com/mgutz/ansi v0.0.0-20170206155736-9520e82c474b h1:j7+1HpAFS1zy5+Q4qx1fWh90gTKwiN4QCGoY9TWyyO4=
 github.com/mgutz/ansi v0.0.0-20170206155736-9520e82c474b/go.mod h1:01TrycV0kFyexm33Z7vhZRXopbI8J3TDReVlkTgMUxE=
-golang.org/x/sys v0.0.0-20180314180151-89ac7f292d17 h1:N8O/0j49esAfvJVDdHct24vdhaAPxjtIUhpkpX+7E5Y=
-golang.org/x/sys v0.0.0-20180314180151-89ac7f292d17/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0 h1:4G4v2dO3VZwixGIRoQ5Lfboy6nUhCyYzaqnIAPPhYs4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.5.1 h1:nOGnQDM7FYENwehXlg/kFVnos3rEvtKTjRvOWSzb6H4=
+github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
+golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20200302150141-5c8b2ff67527 h1:uYVVQ9WP/Ds2ROhcaGPeIdVq0RIXVLwsHlnvJ+cT1So=
+golang.org/x/sys v0.0.0-20200302150141-5c8b2ff67527/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
+gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
diff --git a/metrics/client.go b/metrics/client.go
@@ -70,6 +70,12 @@ type Client interface {
 	// Timing creates a histogram of a duration.
 	Timing(name string, value time.Duration)
 
-	// Historgram creates a numeric floating point metric with min/max/avg/p95/etc
+	// Historgram creates a numeric floating point metric with min/max/avg/p95/etc.
 	Histogram(name string, value float64)
+
+	// Distribution tracks the statistical distribution of a set of values.
+	Distribution(name string, value float64)
+
+	// Close closes all client connections and flushes any buffered data.
+	Close() error
 }
diff --git a/metrics/datadog.go b/metrics/datadog.go
@@ -57,6 +57,11 @@ func (c *DataDogClient) tagsList() []string {
 	return mapToStrings(c.tagMap)
 }
 
+// Close closes all client connections and flushes any buffered data.
+func (c *DataDogClient) Close() error {
+	return c.client.Close()
+}
+
 // Count adds some integer value to a metric.
 func (c *DataDogClient) Count(name string, value int64) {
 	c.client.Count(name, value, c.tagsList(), c.rate)
@@ -95,3 +100,8 @@ func (c *DataDogClient) Timing(name string, value time.Duration) {
 func (c *DataDogClient) Histogram(name string, value float64) {
 	c.client.Histogram(name, value, c.tagsList(), c.rate)
 }
+
+// Distribution tracks the statistical distribution of a set of values.
+func (c *DataDogClient) Distribution(name string, value float64) {
+	c.client.Distribution(name, value, c.tagsList(), c.rate)
+}
diff --git a/metrics/datadog_test.go b/metrics/datadog_test.go
@@ -39,6 +39,7 @@ func TestDataDogClient(t *testing.T) {
 	datadog.Decr("one")
 	datadog.Gauge("memory", 1024)
 	datadog.Histogram("histo", 123)
+	datadog.Distribution("distro", 999)
 
 	if rater, ok := datadog.(withRater); ok {
 		ratedClient := rater.WithRate(0.5)
@@ -76,4 +77,6 @@ func TestDataDogClient(t *testing.T) {
 	if !reflect.DeepEqual(e.Tags, []string{"tag1:value1"}) {
 		t.Fatalf("Expected event to have tags '[tag1:value1]'. Found '%v'", e.Tags)
 	}
+
+	datadog.Close()
 }
diff --git a/metrics/logger.go b/metrics/logger.go
@@ -148,6 +148,11 @@ func (c *LoggerClient) getTags() string {
 	return "map[" + tags + "]"
 }
 
+// Close on LoggerClient is a no-op
+func (c *LoggerClient) Close() error {
+	return nil
+}
+
 // Count adds some value to a metric.
 func (c *LoggerClient) Count(name string, value int64) {
 	c.print("Count", name, value, float64(value)*c.rate)
@@ -182,3 +187,8 @@ func (c *LoggerClient) Timing(name string, value time.Duration) {
 func (c *LoggerClient) Histogram(name string, value float64) {
 	c.print("Histogram", name, value, value)
 }
+
+// Distribution tracks the statistical distribution of a set of values.
+func (c *LoggerClient) Distribution(name string, value float64) {
+	c.print("Distribution", name, value, value)
+}
diff --git a/metrics/logger_test.go b/metrics/logger_test.go
@@ -46,13 +46,16 @@ func TestLoggerClient(t *testing.T) {
 	client.Decr("one")
 	client.Gauge("memory", 1024)
 	client.Histogram("histo", 123)
+	client.Distribution("distro", 999)
+	client.Close()
 
 	ExpectEqual(t, "Count one:1 map[]", recorder.messages[0])
 	ExpectEqual(t, "Event title\ndesc map[]", recorder.messages[1])
 	ExpectEqual(t, "Timing two:2s map[tag1:override]", recorder.messages[2])
 	ExpectEqual(t, "Count one:-1 map[]", recorder.messages[3])
 	ExpectEqual(t, "Gauge memory:1024 map[]", recorder.messages[4])
 	ExpectEqual(t, "Histogram histo:123 map[]", recorder.messages[5])
+	ExpectEqual(t, "Distribution distro:999 map[]", recorder.messages[6])
 
 	// Make sure the call works, but since it is randomly sampled we have no
 	// assertion to make.
diff --git a/metrics/null.go b/metrics/null.go
@@ -27,6 +27,11 @@ func (c *NullClient) WithRate(rate float64) Client {
 	return &NullClient{}
 }
 
+// Close on a NullClient is a no-op
+func (c *NullClient) Close() error {
+	return nil
+}
+
 // Count adds some value to a metric.
 func (c *NullClient) Count(name string, value int64) {
 }
@@ -54,3 +59,7 @@ func (c *NullClient) Timing(name string, value time.Duration) {
 // Histogram sets a numeric value while tracking min/max/avg/p95/etc.
 func (c *NullClient) Histogram(name string, value float64) {
 }
+
+// Distribution tracks the statistical distribution of a set of values.
+func (c *NullClient) Distribution(name string, value float64) {
+}
diff --git a/metrics/null_test.go b/metrics/null_test.go
@@ -30,8 +30,10 @@ func TestNullClientMethods(t *testing.T) {
 
 	client.Histogram("histo", 1.25)
 	client.Timing("timing", time.Duration(123))
+	client.Distribution("distro", 999)
 
 	client.Event(&statsd.Event{})
 
 	client.WithRate(1.2).Incr("rated")
+	client.Close()
 }
diff --git a/metrics/recorder.go b/metrics/recorder.go
@@ -198,6 +198,11 @@ func (c *RecorderClient) logCall(name string, value interface{}) {
 	})
 }
 
+// Close on the RecorderClient is a no-op
+func (c *RecorderClient) Close() error {
+	return nil
+}
+
 // Count adds some value to a metric.
 func (c *RecorderClient) Count(name string, value int64) {
 	// Normally this would be stored as an integer, but instead we assert that
@@ -245,6 +250,11 @@ func (c *RecorderClient) Histogram(name string, value float64) {
 	c.logCall(name, value)
 }
 
+// Distribution tracks the statistical distribution of a set of values.
+func (c *RecorderClient) Distribution(name string, value float64) {
+	c.logCall(name, value)
+}
+
 // Reset will clear the call info context, which is useful between test runs.
 func (c *RecorderClient) Reset() {
 	c.callInfo.RWMutex.Lock()
diff --git a/metrics/recorder_test.go b/metrics/recorder_test.go
@@ -109,6 +109,7 @@ func TestRecorderClient(t *testing.T) {
 	client.Decr("one")
 	client.Gauge("memory", 1024)
 	client.Histogram("histo", 123)
+	client.Distribution("distro", 999)
 
 	// Cast to access additional methods for testing.
 	recorder := client.(*metrics.RecorderClient)
@@ -121,13 +122,15 @@ func TestRecorderClient(t *testing.T) {
 	recorder.Expect("title").Text("desc")
 	recorder.Expect("histo").Value(4.3)
 	recorder.ExpectContains("two:2[tag1:value1]")
+	recorder.Expect("distro").Value(999)
 	recorder.
 		Expect("three").
 		Tag("tag1", "override").
 		TagName("tag2")
 	recorder.Expect("one").Value(-1)
 	recorder.Expect("memory").Value(1024)
 	recorder.Expect("histo").Value(123)
+	recorder.Expect("distro").Value(999)
 
 	recorder.If("*").Tag("tag1", "override2").Reject()
 
@@ -137,6 +140,8 @@ func TestRecorderClient(t *testing.T) {
 		t.Fatal("Expected a length of zero after reset")
 	}
 
+	client.Close()
+
 	recorder.Incr("one")
 	recorder.Incr("two")
 	calls := recorder.Expect("one").GetCalls()

Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,7 @@ func TestDataDogClient(t *testing.T) {`
`39`	`39`	`datadog.Decr("one")`
`40`	`40`	`datadog.Gauge("memory", 1024)`
`41`	`41`	`datadog.Histogram("histo", 123)`
	`42`	`+ datadog.Distribution("distro", 999)`
`42`	`43`
`43`	`44`	`if rater, ok := datadog.(withRater); ok {`
`44`	`45`	`ratedClient := rater.WithRate(0.5)`
`@@ -76,4 +77,6 @@ func TestDataDogClient(t *testing.T) {`
`76`	`77`	`if !reflect.DeepEqual(e.Tags, []string{"tag1:value1"}) {`
`77`	`78`	`t.Fatalf("Expected event to have tags '[tag1:value1]'. Found '%v'", e.Tags)`
`78`	`79`	`}`
	`80`	`+`
	`81`	`+ datadog.Close()`
`79`	`82`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,11 @@ func (c *NullClient) WithRate(rate float64) Client {`
`27`	`27`	`return &NullClient{}`
`28`	`28`	`}`
`29`	`29`
	`30`	`+// Close on a NullClient is a no-op`
	`31`	`+func (c *NullClient) Close() error {`
	`32`	`+ return nil`
	`33`	`+}`
	`34`	`+`
`30`	`35`	`// Count adds some value to a metric.`
`31`	`36`	`func (c *NullClient) Count(name string, value int64) {`
`32`	`37`	`}`
`@@ -54,3 +59,7 @@ func (c *NullClient) Timing(name string, value time.Duration) {`
`54`	`59`	`// Histogram sets a numeric value while tracking min/max/avg/p95/etc.`
`55`	`60`	`func (c *NullClient) Histogram(name string, value float64) {`
`56`	`61`	`}`
	`62`	`+`
	`63`	`+// Distribution tracks the statistical distribution of a set of values.`
	`64`	`+func (c *NullClient) Distribution(name string, value float64) {`
	`65`	`+}`