Merge pull request #131 from netlify/usability-for-metrics

take variadic args for labels

Author: rybit

metriks/metriks.go

@@ -127,8 +127,12 @@ func L(name string, value string) metrics.Label {
 //
 // metriks.Inc("publisher.errors", 1)
 //
-func Inc(name string, val int64) {
-	metrics.IncrCounter([]string{name}, float32(val))
+func Inc(name string, val int64, labels ...metrics.Label) {
+	if len(labels) > 0 {
+		metrics.IncrCounterWithLabels([]string{name}, float32(val), labels)
+	} else {
+		metrics.IncrCounter([]string{name}, float32(val))
+	}
 }
 
 // IncLabels increments a counter with additional labels
@@ -138,7 +142,7 @@ func Inc(name string, val int64) {
 // metriks.IncLabels("publisher.errors", metriks.Labels(metriks.L("status_class", "4xx")), 1)
 //
 func IncLabels(name string, labels []metrics.Label, val int64) {
-	metrics.IncrCounterWithLabels([]string{name}, float32(val), labels)
+	Inc(name, val, labels...)
 }
 
 // MeasureSince records the time from start until the invocation of the function
@@ -153,13 +157,17 @@ func IncLabels(name string, labels []metrics.Label, val int64) {
 //   return db.Execute(query)
 // }
 //
-func MeasureSince(name string, start time.Time) {
-	metrics.MeasureSince([]string{name}, start)
+func MeasureSince(name string, start time.Time, labels ...metrics.Label) {
+	if len(labels) > 0 {
+		metrics.MeasureSinceWithLabels([]string{name}, start, labels)
+	} else {
+		metrics.MeasureSince([]string{name}, start)
+	}
 }
 
 // MeasureSinceLabels is the same as MeasureSince, but with additional labels
 func MeasureSinceLabels(name string, labels []metrics.Label, start time.Time) {
-	metrics.MeasureSinceWithLabels([]string{name}, start, labels)
+	MeasureSince(name, start, labels...)
 }
 
 // Sample records a float32 sample as part of a histogram. This will get histogram
@@ -169,25 +177,33 @@ func MeasureSinceLabels(name string, labels []metrics.Label, start time.Time) {
 //
 // metriks.Sample("publisher-payload-size", float32(len(payload)))
 //
-func Sample(name string, val float32) {
-	metrics.AddSample([]string{name}, val)
+func Sample(name string, val float32, labels ...metrics.Label) {
+	if len(labels) > 0 {
+		metrics.AddSampleWithLabels([]string{name}, val, labels)
+	} else {
+		metrics.AddSample([]string{name}, val)
+	}
 }
 
 // SampleLabels is the same as Sample but with additional labels
 func SampleLabels(name string, labels []metrics.Label, val float32) {
-	metrics.AddSampleWithLabels([]string{name}, val, labels)
+	Sample(name, val, labels...)
 }
 
 // Gauge is used to report a single float32 value. It is most often used during a
 // periodic update or timer to report the current size of a queue or how many
 // connections are currently connected.
-func Gauge(name string, val float32) {
-	metrics.SetGauge([]string{name}, val)
+func Gauge(name string, val float32, labels ...metrics.Label) {
+	if len(labels) > 0 {
+		metrics.SetGaugeWithLabels([]string{name}, val, labels)
+	} else {
+		metrics.SetGauge([]string{name}, val)
+	}
 }
 
 // GaugeLabels is the same as Gauge but with additional labels
 func GaugeLabels(name string, labels []metrics.Label, val float32) {
-	metrics.SetGaugeWithLabels([]string{name}, val, labels)
+	Gauge(name, val, labels...)
 }
 
 func statsdAddr(conf Config) string {

metriks/metriks_test.go

@@ -7,6 +7,7 @@ import (
 
 	"github.com/armon/go-metrics"
 	"github.com/armon/go-metrics/datadog"
+	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"golang.org/x/net/nettest"
 )
@@ -69,3 +70,32 @@ func TestInMemorySink(t *testing.T) {
 	require.Equal(t, "test.test_counter", met[0].Counters["test.test_counter"].Name)
 	require.Equal(t, 1, met[0].Counters["test.test_counter"].Count)
 }
+
+func TestIncWithLabels(t *testing.T) {
+	sink, err := InitWithURL("test", "inmem://?interval=1s&retain=2s")
+	require.NoError(t, err)
+	require.IsType(t, &metrics.InmemSink{}, sink)
+
+	Inc("test_counter", 1, L("tag", "value"), L("tag2", "value2"))
+	met := sink.(*metrics.InmemSink).Data()
+	require.Len(t, met, 1)
+
+	require.Len(t, met[0].Counters, 1)
+	var incr metrics.SampledValue
+	for _, v := range met[0].Counters {
+		incr = v
+		break
+	}
+
+	assert.Len(t, incr.Labels, 2)
+	for _, l := range incr.Labels {
+		switch l.Name {
+		case "tag":
+			assert.Equal(t, "value", l.Value)
+		case "tag2":
+			assert.Equal(t, "value2", l.Value)
+		default:
+			assert.Fail(t, "unexpected label value")
+		}
+	}
+}