Merge pull request #163 from Shopify/statsd-timer-tags

Support adding tags on timer finishers

Author: pior

go.mod

@@ -15,14 +15,12 @@ require (
 	github.com/nu7hatch/gouuid v0.0.0-20131221200532-179d4d0c4d8d
 	github.com/pkg/errors v0.9.1
 	github.com/sirupsen/logrus v1.8.1
-	github.com/stretchr/objx v0.3.0 // indirect
-	github.com/stretchr/testify v1.7.0
+	github.com/stretchr/testify v1.8.1
 	golang.org/x/net v0.0.0-20210813160813-60bc85c4be6d
 	golang.org/x/sync v0.0.0-20210220032951-036812b2e83c
 	golang.org/x/sys v0.0.0-20210817190340-bfb29a6856f2 // indirect
 	golang.org/x/text v0.3.7 // indirect
 	gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect
 	gopkg.in/tomb.v2 v2.0.0-20161208151619-d5d1b5820637
 	gopkg.in/yaml.v2 v2.4.0 // indirect
-	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
 )

go.sum

@@ -47,12 +47,15 @@ github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic
 github.com/sirupsen/logrus v1.8.1 h1:dJKuHgqk1NNQlqoA6BTlM1Wf9DOH3NBjQyu0h9+AZZE=
 github.com/sirupsen/logrus v1.8.1/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
-github.com/stretchr/objx v0.3.0 h1:NGXK3lHquSN08v5vWalVI/L8XU9hdzE/G6xsrze47As=
-github.com/stretchr/objx v0.3.0/go.mod h1:qt09Ya8vawLte6SNmTgCsAVtYtaKzEcn8ATUoHMkEqE=
+github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
+github.com/stretchr/objx v0.5.0 h1:1zr/of2m5FGMsad5YfcqgdqdWrIhu+EBEJRhR1U7z/c=
+github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
-github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
-github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
+github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
+github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
 golang.org/x/net v0.0.0-20210813160813-60bc85c4be6d h1:LO7XpTYMwTqxjLcGWPijK3vRXg1aWdlNOVOHRq45d7c=
 golang.org/x/net v0.0.0-20210813160813-60bc85c4be6d/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
 golang.org/x/sync v0.0.0-20210220032951-036812b2e83c h1:5KslGYwFpkhGh+Q16bwMP3cOontH8FOep7tGV86Y7SQ=
@@ -78,5 +81,5 @@ gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
 gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
-gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b h1:h8qDotaEPuJATrMmW04NCwg7v22aHH28wwpauUhK9Oo=
-gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

statsd/timer.go

@@ -34,8 +34,9 @@ func (t *Timer) Time(ctx context.Context, fn func() error, ts ...Tags) error {
 }
 
 type Finisher interface {
-	Finish()
-	SuccessFinish(err *error)
+	Finish(ts ...Tags)
+	SuccessFinish(err *error, ts ...Tags)
+	SetTags(ts ...Tags)
 }
 
 type timerFinisher struct {
@@ -45,18 +46,25 @@ type timerFinisher struct {
 	ctx       context.Context
 }
 
-func (t *timerFinisher) Finish() {
-	t.timer.Duration(t.ctx, time.Since(t.startTime), t.tags...)
+func (t *timerFinisher) Finish(ts ...Tags) {
+	tags := append([]Tags{}, t.tags...)
+	tags = append(tags, ts...)
+	t.timer.Duration(t.ctx, time.Since(t.startTime), tags...)
 }
 
-func (t *timerFinisher) SuccessFinish(errp *error) {
-	tags := append([]Tags{}, t.tags...) // Copy the slice
+func (t *timerFinisher) SuccessFinish(errp *error, ts ...Tags) {
+	tags := append([]Tags{}, t.tags...)
+	tags = append(tags, ts...)
 	if errp != nil {
 		tags = append(tags, Tags{"success": *errp == nil})
 	}
 	t.timer.Duration(t.ctx, time.Since(t.startTime), tags...)
 }
 
+func (t *timerFinisher) SetTags(ts ...Tags) {
+	t.tags = append(t.tags, ts...)
+}
+
 // StartTimer provides a way to collect a duration metric for a function call
 // in one line.
 //

statsd/timer_test.go

@@ -0,0 +1,50 @@
+package statsd
+
+import (
+	"context"
+	"io"
+	"testing"
+
+	"github.com/stretchr/testify/mock"
+
+	"github.com/Shopify/goose/statsd/mocks"
+)
+
+func TestTimer_StartTimer(t *testing.T) {
+	defer func() { SetBackend(NewNullBackend()) }()
+
+	ctx := WithTags(context.Background(), Tags{"context": "ok"})
+
+	statsd := new(mocks.Backend)
+	SetBackend(statsd)
+	metric := &Timer{Name: "metric"}
+
+	t.Run("Finish", func(t *testing.T) {
+		statsd.On("Distribution", ctx, "metric", mock.Anything, []string{"context:ok", "finish:ok", "starttimer:ok"}, 1.0).Return(nil).Once()
+
+		start := metric.StartTimer(ctx, Tags{"starttimer": "ok"})
+		start.Finish(Tags{"finish": "ok"})
+
+		statsd.AssertExpectations(t)
+	})
+
+	t.Run("SuccessFinish", func(t *testing.T) {
+		statsd.On("Distribution", ctx, "metric", mock.Anything, []string{"context:ok", "starttimer:ok", "success:false", "successfinish:ok"}, 1.0).Return(nil).Once()
+
+		err := io.EOF
+		start := metric.StartTimer(ctx, Tags{"starttimer": "ok"})
+		start.SuccessFinish(&err, Tags{"successfinish": "ok"})
+
+		statsd.AssertExpectations(t)
+	})
+
+	t.Run("SetTags", func(t *testing.T) {
+		statsd.On("Distribution", ctx, "metric", mock.Anything, []string{"context:ok", "settags:ok", "starttimer:ok"}, 1.0).Return(nil).Once()
+
+		start := metric.StartTimer(ctx, Tags{"starttimer": "ok"})
+		start.SetTags(Tags{"settags": "ok"})
+		start.Finish()
+
+		statsd.AssertExpectations(t)
+	})
+}