Add percent towards next coupon

Author: featheredtoast

Companion/exporter/resource_sink_collector.go

@@ -6,9 +6,9 @@ import (
 )
 
 type ResourceSinkCollector struct {
-	buildingEndpoint       string
-	globalResourceEndpoint string
-	globalExplorationEndpoint  string
+	buildingEndpoint          string
+	globalResourceEndpoint    string
+	globalExplorationEndpoint string
 }
 
 type ResourceSinkDetails struct {
@@ -17,17 +17,18 @@ type ResourceSinkDetails struct {
 }
 
 type GlobalSinkDetails struct {
-	SinkType       string `json:"Name"`
-	NumCoupon      int    `json:"NumCoupon"`
-	TotalPoints    int    `json:"TotalPoints"`
-	PointsToCoupon int    `json:"PointsToCoupon"`
+	SinkType       string  `json:"Name"`
+	NumCoupon      int     `json:"NumCoupon"`
+	TotalPoints    int     `json:"TotalPoints"`
+	PointsToCoupon int     `json:"PointsToCoupon"`
+	Percent        float64 `json:"Percent"`
 }
 
 func NewResourceSinkCollector(buildingEndpoint, globalResourceEndpoint, globalExplorationEndpoint string) *ResourceSinkCollector {
 	return &ResourceSinkCollector{
-		buildingEndpoint:       buildingEndpoint,
-		globalResourceEndpoint: globalResourceEndpoint,
-		globalExplorationEndpoint:  globalExplorationEndpoint,
+		buildingEndpoint:          buildingEndpoint,
+		globalResourceEndpoint:    globalResourceEndpoint,
+		globalExplorationEndpoint: globalExplorationEndpoint,
 	}
 }
 
@@ -49,6 +50,7 @@ func (c *ResourceSinkCollector) Collect(frmAddress string, sessionName string) {
 	for _, d := range globalResourceDetails {
 		ResourceSinkTotalPoints.WithLabelValues(d.SinkType, frmAddress, sessionName).Set(float64(d.TotalPoints))
 		ResourceSinkPointsToCoupon.WithLabelValues(d.SinkType, frmAddress, sessionName).Set(float64(d.PointsToCoupon))
+		ResourceSinkPercent.WithLabelValues(d.SinkType, frmAddress, sessionName).Set(float64(d.Percent))
 		ResourceSinkCollectedCoupons.WithLabelValues(frmAddress, sessionName).Set(float64(d.NumCoupon))
 	}
 
@@ -62,6 +64,7 @@ func (c *ResourceSinkCollector) Collect(frmAddress string, sessionName string) {
 	for _, d := range globalExplorationDetails {
 		ResourceSinkTotalPoints.WithLabelValues(d.SinkType, frmAddress, sessionName).Set(float64(d.TotalPoints))
 		ResourceSinkPointsToCoupon.WithLabelValues(d.SinkType, frmAddress, sessionName).Set(float64(d.PointsToCoupon))
+		ResourceSinkPercent.WithLabelValues(d.SinkType, frmAddress, sessionName).Set(float64(d.Percent))
 	}
 
 	powerInfo := map[float64]float64{}

Companion/exporter/resource_sink_collector_test.go

@@ -42,19 +42,21 @@ var _ = Describe("ResourceSinkCollector", func() {
 
 		FRMServer.ReturnsGlobalResourceSinkData([]exporter.GlobalSinkDetails{
 			{
-				SinkType: "Resource",
+				SinkType:       "Resource",
 				TotalPoints:    100,
 				PointsToCoupon: 200,
 				NumCoupon:      1,
+				Percent:        0.7,
 			},
 		})
 
 		FRMServer.ReturnsGlobalExplorationSinkData([]exporter.GlobalSinkDetails{
 			{
-				SinkType: "Exploration",
+				SinkType:       "Exploration",
 				TotalPoints:    1000,
 				PointsToCoupon: 2000,
 				NumCoupon:      1,
+				Percent:        0.8,
 			},
 		})
 	})
@@ -99,6 +101,14 @@ var _ = Describe("ResourceSinkCollector", func() {
 			Expect(err).ToNot(HaveOccurred())
 			Expect(val).To(Equal(200.0))
 		})
+		It("sets the 'resource_sink_points_to_coupon' percent with the right labels", func() {
+			collector.Collect(url, sessionName)
+
+			val, err := gaugeValue(exporter.ResourceSinkPercent, "Resource", url, sessionName)
+
+			Expect(err).ToNot(HaveOccurred())
+			Expect(val).To(Equal(0.7))
+		})
 		It("sets the 'resource_sink_points_to_coupon' metric with the right labels for exploration", func() {
 			collector.Collect(url, sessionName)
 
@@ -115,6 +125,14 @@ var _ = Describe("ResourceSinkCollector", func() {
 			Expect(err).ToNot(HaveOccurred())
 			Expect(val).To(Equal(2000.0))
 		})
+		It("sets the 'resource_sink_points_to_coupon' percent with the right labels for exploration", func() {
+			collector.Collect(url, sessionName)
+
+			val, err := gaugeValue(exporter.ResourceSinkPercent, "Exploration", url, sessionName)
+
+			Expect(err).ToNot(HaveOccurred())
+			Expect(val).To(Equal(0.8))
+		})
 		It("sets the 'resource_sink_collected_coupons' metric with the right labels", func() {
 			collector.Collect(url, sessionName)
 

Companion/exporter/resource_sink_metrics.go

@@ -33,6 +33,13 @@ var (
 		"sink_type",
 	})
 
+	ResourceSinkPercent = RegisterNewGaugeVec(prometheus.GaugeOpts{
+		Name: "resource_sink_percent",
+		Help: "AWESOME sink percent to next coupon",
+	}, []string{
+		"sink_type",
+	})
+
 	ResourceSinkCollectedCoupons = RegisterNewGaugeVec(prometheus.GaugeOpts{
 		Name: "resource_sink_collected_coupons",
 		Help: "AWESOME sink collected coupons",