Move TCF metrics more in line with other metrics implementaion

pbsmetrics/go_metrics.go

@@ -53,9 +53,7 @@ type Metrics struct {
 	TimeoutNotificationFailure metrics.Meter
 
 	// TCF adaption metrics
-	TCF1ReqMeter   metrics.Meter
-	TCF2ReqMeter   metrics.Meter
-	TCFReqErrMeter metrics.Meter
+	TCFReqVersion []metrics.Meter
 
 	AdapterMetrics map[openrtb_ext.BidderName]*AdapterMetrics
 	// Don't export accountMetrics because we need helper functions here to insure its properly populated dynamically
@@ -143,9 +141,7 @@ func NewBlankMetrics(registry metrics.Registry, exchanges []openrtb_ext.BidderNa
 		TimeoutNotificationSuccess: blankMeter,
 		TimeoutNotificationFailure: blankMeter,
 
-		TCF1ReqMeter:   blankMeter,
-		TCF2ReqMeter:   blankMeter,
-		TCFReqErrMeter: blankMeter,
+		TCFReqVersion: make([]metrics.Meter, len(TCFVersions()), len(TCFVersions())),
 
 		AdapterMetrics:  make(map[openrtb_ext.BidderName]*AdapterMetrics, len(exchanges)),
 		accountMetrics:  make(map[string]*accountMetrics),
@@ -164,6 +160,15 @@ func NewBlankMetrics(registry metrics.Registry, exchanges []openrtb_ext.BidderNa
 		}
 	}
 
+	for _, c := range CacheResults() {
+		newMetrics.StoredReqCacheMeter[c] = blankMeter
+		newMetrics.StoredImpCacheMeter[c] = blankMeter
+	}
+
+	for i := range TCFVersions() {
+		newMetrics.TCFReqVersion[i] = blankMeter
+	}
+
 	//to minimize memory usage, queuedTimeout metric is now supported for video endpoint only
 	//boolean value represents 2 general request statuses: accepted and rejected
 	newMetrics.RequestsQueueTimer["video"] = make(map[bool]metrics.Timer)
@@ -229,9 +234,10 @@ func NewMetrics(registry metrics.Registry, exchanges []openrtb_ext.BidderName, d
 	newMetrics.TimeoutNotificationSuccess = metrics.GetOrRegisterMeter("timeout_notification.ok", registry)
 	newMetrics.TimeoutNotificationFailure = metrics.GetOrRegisterMeter("timeout_notification.failed", registry)
 
-	newMetrics.TCF1ReqMeter = metrics.GetOrRegisterMeter("privacy.request.tcf.v1", registry)
-	newMetrics.TCF2ReqMeter = metrics.GetOrRegisterMeter("privacy.request.tcf.v2", registry)
-	newMetrics.TCFReqErrMeter = metrics.GetOrRegisterMeter("privacy.request.tcf.err", registry)
+	for i, version := range TCFVersions() {
+		newMetrics.TCFReqVersion[i] = metrics.GetOrRegisterMeter(fmt.Sprintf("privacy.request.tcf.%s", string(version)), registry)
+	}
+
 	return newMetrics
 }
 
@@ -577,13 +583,10 @@ func (me *Metrics) RecordTimeoutNotice(success bool) {
 }
 
 func (me *Metrics) RecordTCFReq(version int) {
-	if version == 1 {
-		me.TCF1ReqMeter.Mark(1)
-	} else if version == 2 {
-		me.TCF2ReqMeter.Mark(1)
-	} else {
-		me.TCFReqErrMeter.Mark(1)
+	if version >= 0 && version < len(me.TCFReqVersion) {
+		me.TCFReqVersion[version].Mark(1)
 	}
+	me.TCFReqVersion[0].Mark(1)
 	return
 }
 

pbsmetrics/go_metrics_test.go

@@ -56,9 +56,9 @@ func TestNewMetrics(t *testing.T) {
 
 	ensureContains(t, registry, "timeout_notification.ok", m.TimeoutNotificationSuccess)
 	ensureContains(t, registry, "timeout_notification.failed", m.TimeoutNotificationFailure)
-	ensureContains(t, registry, "privacy.request.tcf.v1", m.TCF1ReqMeter)
-	ensureContains(t, registry, "privacy.request.tcf.v2", m.TCF2ReqMeter)
-	ensureContains(t, registry, "privacy.request.tcf.err", m.TCFReqErrMeter)
+	ensureContains(t, registry, "privacy.request.tcf.v1", m.TCFReqVersion[1])
+	ensureContains(t, registry, "privacy.request.tcf.v2", m.TCFReqVersion[2])
+	ensureContains(t, registry, "privacy.request.tcf.err", m.TCFReqVersion[0])
 
 }
 

pbsmetrics/metrics.go

@@ -248,6 +248,24 @@ func RequestActions() []RequestAction {
 	}
 }
 
+// TCFVersionValue : The possible values for TCF versions
+type TCFVersionValue string
+
+const (
+	TCFVersionErr TCFVersionValue = "err"
+	TCFVersionV1  TCFVersionValue = "v1"
+	TCFVersionV2  TCFVersionValue = "v2"
+)
+
+// TCFVersions rtuens the possible values for the TCF version
+func TCFVersions() []TCFVersionValue {
+	return []TCFVersionValue{
+		TCFVersionErr,
+		TCFVersionV1,
+		TCFVersionV2,
+	}
+}
+
 // MetricsEngine is a generic interface to record PBS metrics into the desired backend
 // The first three metrics function fire off once per incoming request, so total metrics
 // will equal the total number of incoming requests. The remaining 5 fire off per outgoing

pbsmetrics/prometheus/preload.go

@@ -101,7 +101,7 @@ func preloadLabelValues(m *Metrics) {
 	})
 
 	preloadLabelValuesForCounter(m.tcfMetrics, map[string][]string{
-		versionLabel: {"err", "v1", "v2"},
+		versionLabel: tcfVersionsAsString(),
 		sourceLabel:  {string(sourceRequest)},
 	})
 }

pbsmetrics/prometheus/prometheus.go

@@ -1,7 +1,6 @@
 package prometheusmetrics
 
 import (
-	"fmt"
 	"strconv"
 	"time"
 
@@ -44,6 +43,9 @@ type Metrics struct {
 
 	// Account Metrics
 	accountRequests *prometheus.CounterVec
+
+	// Lookup tables
+	tcfVersions []string
 }
 
 const (
@@ -170,6 +172,7 @@ func NewMetrics(cfg config.PrometheusMetrics) *Metrics {
 		"privacy_tcf",
 		"Count of TCF versions for requests where GDPR was enforced.",
 		[]string{versionLabel, sourceLabel})
+	metrics.tcfVersions = tcfVersionsAsString()
 
 	metrics.adapterBids = newCounter(cfg, metrics.Registry,
 		"adapter_bids",
@@ -436,9 +439,11 @@ func (m *Metrics) RecordTimeoutNotice(success bool) {
 }
 
 func (m *Metrics) RecordTCFReq(version int) {
-	var value string = "err"
-	if version > 0 {
-		value = fmt.Sprintf("v%d", version)
+	var value string
+	if version >= 0 && version < len(m.tcfVersions) {
+		value = m.tcfVersions[version]
+	} else {
+		value = m.tcfVersions[0]
 	}
 	m.tcfMetrics.With(prometheus.Labels{
 		versionLabel: value,

pbsmetrics/prometheus/type_conversion.go

@@ -76,3 +76,12 @@ func requestTypesAsString() []string {
 	}
 	return valuesAsString
 }
+
+func tcfVersionsAsString() []string {
+	values := pbsmetrics.TCFVersions()
+	valuesAsString := make([]string, len(values))
+	for i, v := range values {
+		valuesAsString[i] = string(v)
+	}
+	return valuesAsString
+}