Merge pull request #391 from xmidt-org/denopink/feat/improve-outbound…

…_dropped_messages-metric

feat: improve outbound_dropped_messages metric

ackDispatcher.go

@@ -7,7 +7,7 @@ import (
 	"os"
 	"time"
 
-	"github.com/go-kit/kit/metrics"
+	"github.com/prometheus/client_golang/prometheus"
 	"github.com/xmidt-org/webpa-common/v2/device"
 	"go.uber.org/zap"
 
@@ -26,10 +26,10 @@ type ackDispatcher struct {
 	hostname          string
 	logger            *zap.Logger
 	timeout           time.Duration
-	AckSuccess        metrics.Counter
-	AckFailure        metrics.Counter
-	AckSuccessLatency metrics.Histogram
-	AckFailureLatency metrics.Histogram
+	AckSuccess        CounterVec
+	AckFailure        CounterVec
+	AckSuccessLatency HistogramVec
+	AckFailureLatency HistogramVec
 }
 
 // NewAckDispatcher is an ackDispatcher factory which processes outbound events
@@ -130,33 +130,33 @@ func (d *ackDispatcher) OnDeviceEvent(event *device.Event) {
 	p := dm.PartnerIDClaim()
 	t := m.Type.FriendlyName()
 	// Metric labels
-	ls := []string{qosLevelLabel, l.String(), partnerIDLabel, p, messageType, t}
+	ls := prometheus.Labels{qosLevelLabel: l.String(), partnerIDLabel: p, messageType: t}
 	ctx, cancel := context.WithTimeout(context.Background(), d.timeout)
 	defer cancel()
 
 	// Observe the latency of sending an ack to the source device
 	ackFailure := false
 	defer func(s time.Time) {
-		d.recordAckLatency(s, ackFailure, ls...)
+		d.recordAckLatency(s, ackFailure, ls)
 	}(time.Now())
 
 	if _, err := event.Device.Send(r.WithContext(ctx)); err != nil {
 		d.logger.Error("Error dispatching QOS ack", zap.Any("qosLevel", l), zap.Any("partnerID", p), zap.Any("messageType", t), zap.Error(err))
-		d.AckFailure.With(ls...).Add(1)
+		d.AckFailure.With(ls).Add(1)
 		ackFailure = true
 		return
 	}
 
-	d.AckSuccess.With(ls...).Add(1)
+	d.AckSuccess.With(ls).Add(1)
 }
 
 // recordAckLatency records the latency for both successful and failed acks
-func (d *ackDispatcher) recordAckLatency(s time.Time, f bool, l ...string) {
+func (d *ackDispatcher) recordAckLatency(s time.Time, f bool, l prometheus.Labels) {
 	switch {
 	case f:
-		d.AckFailureLatency.With(l...).Observe(time.Since(s).Seconds())
+		d.AckFailureLatency.With(l).Observe(time.Since(s).Seconds())
 
 	default:
-		d.AckSuccessLatency.With(l...).Observe(time.Since(s).Seconds())
+		d.AckSuccessLatency.With(l).Observe(time.Since(s).Seconds())
 	}
 }

ackDispatcher_test.go

@@ -7,6 +7,7 @@ import (
 	"errors"
 	"testing"
 
+	"github.com/prometheus/client_golang/prometheus"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
 	"github.com/stretchr/testify/require"
@@ -46,7 +47,7 @@ func testAckDispatcherOnDeviceEventQOSEventFailure(t *testing.T) {
 			mAckFailureLatency := new(mockHistogram)
 			p, mt, qosl := failure_case, failure_case, failure_case
 			// Setup labels for metrics
-			l := []string{qosLevelLabel, qosl, partnerIDLabel, p, messageType, mt}
+			l := prometheus.Labels{qosLevelLabel: qosl, partnerIDLabel: p, messageType: mt}
 			om := OutboundMeasures{
 				AckSuccess:        mAckSuccess,
 				AckFailure:        mAckFailure,
@@ -169,7 +170,7 @@ func testAckDispatcherOnDeviceEventQOSDeviceFailure(t *testing.T) {
 			require.True(ok)
 			// Setup labels for metrics
 			dm := genTestMetadata()
-			l := []string{qosLevelLabel, m.QualityOfService.Level().String(), partnerIDLabel, dm.PartnerIDClaim(), messageType, m.Type.FriendlyName()}
+			l := prometheus.Labels{qosLevelLabel: m.QualityOfService.Level().String(), partnerIDLabel: dm.PartnerIDClaim(), messageType: m.Type.FriendlyName()}
 			// Setup metrics for the dispatcher
 			om := OutboundMeasures{
 				AckSuccess:        mAckSuccess,
@@ -493,7 +494,7 @@ func testAckDispatcherOnDeviceEventQOSSuccess(t *testing.T) {
 			}
 
 			// Setup labels for metrics
-			l := []string{qosLevelLabel, qosl, partnerIDLabel, p, messageType, mt}
+			l := prometheus.Labels{qosLevelLabel: qosl, partnerIDLabel: p, messageType: mt}
 			// Setup metrics for the dispatcher
 			om := OutboundMeasures{
 				AckSuccess:        mAckSuccess,