Add support for histograms in metrics scope (cadence-workflow#1964)

common/metrics/defs.go

@@ -20,6 +20,8 @@
 
 package metrics
 
+import "github.com/uber-go/tally"
+
 // types used/defined by the package
 type (
 	// MetricName is the name of the metric
@@ -30,8 +32,9 @@ type (
 
 	// metricDefinition contains the definition for a metric
 	metricDefinition struct {
-		metricType MetricType // metric type
-		metricName MetricName // metric name
+		metricType MetricType    // metric type
+		metricName MetricName    // metric name
+		buckets    tally.Buckets // buckets if we are emitting histograms
 	}
 
 	// scopeDefinition holds the tag definitions for a scope

common/metrics/interfaces.go

@@ -52,12 +52,16 @@ type (
 		IncCounter(counter int)
 		// AddCounter adds delta to the counter metric
 		AddCounter(counter int, delta int64)
-		// StartTimer starts a timer for the given
-		// metric name. Time will be recorded when stopwatch is stopped.
+		// StartTimer starts a timer for the given metric name.
+		// Time will be recorded when stopwatch is stopped.
 		StartTimer(timer int) Stopwatch
-		// RecordTimer starts a timer for the given
-		// metric name
+		// RecordTimer starts a timer for the given metric name
 		RecordTimer(timer int, d time.Duration)
+		// RecordHistogramDuration records a histogram duration value for the given
+		// metric name
+		RecordHistogramDuration(timer int, d time.Duration)
+		// RecordHistogramValue records a histogram value for the given metric name
+		RecordHistogramValue(timer int, value float64)
 		// UpdateGauge reports Gauge type absolute value metric
 		UpdateGauge(gauge int, value float64)
 		// Tagged return an internal scope that can be used to add additional

common/metrics/scope.go

@@ -74,6 +74,16 @@ func (m *metricsScope) RecordTimer(id int, d time.Duration) {
 	}
 }
 
+func (m *metricsScope) RecordHistogramDuration(id int, value time.Duration) {
+	name := string(m.defs[id].metricName)
+	m.scope.Histogram(name, m.getBuckets(id)).RecordDuration(value)
+}
+
+func (m *metricsScope) RecordHistogramValue(id int, value float64) {
+	name := string(m.defs[id].metricName)
+	m.scope.Histogram(name, m.getBuckets(id)).RecordValue(value)
+}
+
 func (m *metricsScope) Tagged(tags ...Tag) Scope {
 	domainTagged := false
 	tagMap := make(map[string]string, len(tags))
@@ -86,6 +96,13 @@ func (m *metricsScope) Tagged(tags ...Tag) Scope {
 	return newMetricsScope(m.scope.Tagged(tagMap), m.defs, domainTagged)
 }
 
+func (m *metricsScope) getBuckets(id int) tally.Buckets {
+	if m.defs[id].buckets != nil {
+		return m.defs[id].buckets
+	}
+	return tally.DefaultBuckets
+}
+
 func isDomainTagged(tag Tag) bool {
 	return tag.Key() == domain && tag.Value() != domainAllValue
 }

service/worker/archiver/replay_metrics_client.go

@@ -133,6 +133,22 @@ func (r *replayMetricsScope) RecordTimer(timer int, d time.Duration) {
 	r.scope.RecordTimer(timer, d)
 }
 
+// RecordHistogramDuration records a duration value in a histogram
+func (r *replayMetricsScope) RecordHistogramDuration(timer int, d time.Duration) {
+	if workflow.IsReplaying(r.ctx) {
+		return
+	}
+	r.scope.RecordHistogramDuration(timer, d)
+}
+
+// RecordHistogramValue records a value in a histogram
+func (r *replayMetricsScope) RecordHistogramValue(timer int, value float64) {
+	if workflow.IsReplaying(r.ctx) {
+		return
+	}
+	r.scope.RecordHistogramValue(timer, value)
+}
+
 // UpdateGauge reports Gauge type absolute value metric
 func (r *replayMetricsScope) UpdateGauge(gauge int, value float64) {
 	if workflow.IsReplaying(r.ctx) {