1.0 fixes, adds ability to monitor multiple servers, and future save file

Companion/exporter/collector_runner.go

@@ -2,46 +2,83 @@ package exporter
 
 import (
 	"context"
+	"log"
+	"regexp"
 	"time"
+
+	"github.com/prometheus/client_golang/prometheus"
 )
 
+func SanitizeSessionName(sessionName string) string {
+	re := regexp.MustCompile(`[^\w\s]`)
+	return re.ReplaceAllString(sessionName, "")
+}
+
 type CollectorRunner struct {
-	collectors []Collector
-	ctx        context.Context
-	cancel     context.CancelFunc
+	collectors  []Collector
+	ctx         context.Context
+	cancel      context.CancelFunc
+	frmBaseUrl  string
+	sessionName string
 }
 
 type Collector interface {
-	Collect()
+	Collect(string, string)
+	DropCache()
+}
+
+type SessionInfo struct {
+	SessionName string `json:"SessionName"`
 }
 
-func NewCollectorRunner(ctx context.Context, collectors ...Collector) *CollectorRunner {
+func NewCollectorRunner(ctx context.Context, frmBaseUrl string, collectors ...Collector) *CollectorRunner {
 	ctx, cancel := context.WithCancel(ctx)
 	return &CollectorRunner{
-		ctx:        ctx,
-		cancel:     cancel,
-		collectors: collectors,
+		ctx:         ctx,
+		cancel:      cancel,
+		collectors:  collectors,
+		frmBaseUrl:  frmBaseUrl,
+		sessionName: "default",
 	}
 }
 
-func (c *CollectorRunner) Start() {
-	c.Collect()
-	for {
-		select {
-		case <-c.ctx.Done():
-			return
-		case <-Clock.After(5 * time.Second):
-			c.Collect()
+func (c *CollectorRunner) updateSessionName() {
+	details := SessionInfo{}
+	err := retrieveData(c.frmBaseUrl+"/getSessionInfo", &details)
+	if err != nil {
+		log.Printf("error reading session name from FRM: %s\n", err)
+		return
+	}
+	newSessionName := SanitizeSessionName(details.SessionName)
+	if newSessionName != "" && newSessionName != c.sessionName {
+		log.Printf("%s has a new session name: %s\n", c.frmBaseUrl, newSessionName)
+		for _, metric := range RegisteredMetrics {
+			metric.DeletePartialMatch(prometheus.Labels{"url": c.frmBaseUrl, "session_name": c.sessionName})
+		}
+		for _, collector := range c.collectors {
+			collector.DropCache()
 		}
+		c.sessionName = newSessionName
 	}
 }
 
+func (c *CollectorRunner) Start() error {
+	c.updateSessionName()
+	c.Collect(c.frmBaseUrl, c.sessionName)
+	t := Clock.TickerFunc(c.ctx, 5*time.Second, func() error {
+		c.updateSessionName()
+		c.Collect(c.frmBaseUrl, c.sessionName)
+		return nil
+	})
+	return t.Wait()
+}
+
 func (c *CollectorRunner) Stop() {
 	c.cancel()
 }
 
-func (c *CollectorRunner) Collect() {
+func (c *CollectorRunner) Collect(server string, sessionName string) {
 	for _, collector := range c.collectors {
-		collector.Collect()
+		collector.Collect(server, sessionName)
 	}
 }

Companion/exporter/collector_runner_test.go

@@ -2,12 +2,12 @@ package exporter_test
 
 import (
 	"context"
+	"time"
 
 	"github.com/AP-Hunt/FicsitRemoteMonitoringCompanion/Companion/exporter"
-	"github.com/benbjohnson/clock"
 	. "github.com/onsi/ginkgo/v2"
+	"github.com/coder/quartz"
 	. "github.com/onsi/gomega"
-	"time"
 )
 
 type TestCollector struct {
@@ -19,42 +19,49 @@ func NewTestCollector() *TestCollector {
 		counter: 0,
 	}
 }
-func (t *TestCollector) Collect() {
+func (t *TestCollector) Collect(url string, sessionName string) {
 	t.counter = t.counter + 1
 }
+func (t *TestCollector) DropCache() {}
 
 var _ = Describe("CollectorRunner", func() {
+	var url string
+
+	BeforeEach(func() {
+		FRMServer.Reset()
+		url = FRMServer.server.URL
+		FRMServer.ReturnsSessionInfoData(exporter.SessionInfo{
+			SessionName: "test",
+		})
+	})
+
 	Describe("Basic Functionality", func() {
 		It("runs on init and on each timeout", func() {
 			ctx, cancel := context.WithCancel(context.Background())
-			testTime := clock.NewMock()
+			timeout, _ := context.WithTimeout(ctx, 10*time.Second)
+			defer cancel()
+			testTime := quartz.NewMock(GinkgoTB())
 			exporter.Clock = testTime
+			trap := testTime.Trap().TickerFunc()
+			defer trap.Close()
 
 			c1 := NewTestCollector()
 			c2 := NewTestCollector()
-			runner := exporter.NewCollectorRunner(ctx, c1, c2)
+			runner := exporter.NewCollectorRunner(ctx, url, c1, c2)
 			go runner.Start()
-			testTime.Add(5 * time.Second)
-			testTime.Add(5 * time.Second)
-			testTime.Add(5 * time.Second)
-			cancel()
+			call := trap.MustWait(timeout)
+			call.Release()
+
+			for i := 0; i < 2; i++ {
+				_, w := testTime.AdvanceNext()
+				w.MustWait(ctx)
+			}
 			Expect(c1.counter).To(Equal(3))
 			Expect(c2.counter).To(Equal(3))
 		})
 
-		It("does not run after being canceled", func() {
-			ctx, cancel := context.WithCancel(context.Background())
-			testTime := clock.NewMock()
-			exporter.Clock = testTime
-
-			c1 := NewTestCollector()
-			runner := exporter.NewCollectorRunner(ctx, c1)
-			go runner.Start()
-			testTime.Add(5 * time.Second)
-			cancel()
-			testTime.Add(5 * time.Second)
-			testTime.Add(5 * time.Second)
-			Expect(c1.counter).To(Equal(1))
+		It("sanitizes session name", func() {
+			Expect(exporter.SanitizeSessionName(`it's giving -- 123456!@#$%^&*() yo hollar "'"`)).To(Equal(`its giving  123456 yo hollar ` ))
 		})
 	})
 })

Companion/exporter/common.go

@@ -2,7 +2,8 @@ package exporter
 
 import (
 	"encoding/json"
-	"github.com/benbjohnson/clock"
+	"fmt"
+	"github.com/coder/quartz"
 	"log"
 	"net/http"
 	"regexp"
@@ -12,7 +13,7 @@ import (
 
 var timeRegex = regexp.MustCompile(`\d\d:\d\d:\d\d`)
 
-var Clock = clock.New()
+var Clock = quartz.NewReal()
 
 func parseTimeSeconds(timeStr string) *float64 {
 	match := timeRegex.FindStringSubmatch(timeStr)
@@ -42,6 +43,10 @@ func retrieveData(frmAddress string, details any) error {
 		return err
 	}
 
+	if resp.StatusCode != 200 {
+		return fmt.Errorf("non-200 returned when retireving data: %d", resp.StatusCode)
+	}
+
 	defer resp.Body.Close()
 
 	decoder := json.NewDecoder(resp.Body)

Companion/exporter/drone_station_collector.go

@@ -3,81 +3,111 @@ package exporter
 import (
 	"log"
 	"strconv"
+
+	"github.com/prometheus/client_golang/prometheus"
 )
 
 type DroneStationCollector struct {
-	FRMAddress string
+	endpoint       string
+	metricsDropper *MetricsDropper
+}
+
+type DroneFuelInventory struct {
+	Name   string  `json:"Name"`
+	Amount float64 `json:"Amount"`
+}
+
+type DroneActiveFuel struct {
+	Name string  `json:"FuelName"`
+	Rate float64 `json:"EstimatedFuelCostRate"`
 }
 
 type DroneStationDetails struct {
-	Id                     string    `json:"ID"`
-	HomeStation            string    `json:"Name"`
-	PairedStation          string    `json:"PairedStation"`
-	DroneStatus            string    `json:"DroneStatus"`
-	AvgIncRate             float64   `json:"AvgIncRate"`
-	AvgIncStack            float64   `json:"AvgIncStack"`
-	AvgOutRate             float64   `json:"AvgOutRate"`
-	AvgOutStack            float64   `json"AvgOutStack"`
-	AvgRndTrip             string    `json:"AvgRndTrip"`
-	AvgTotalIncRate        float64   `json:"AvgTotalIncRate"`
-	AvgTotalIncStack       float64   `json:"AvgTotalIncStack"`
-	AvgTotalOutRate        float64   `json:"AvgTotalOutRate"`
-	AvgTotalOutStack       float64   `json:"AvgTotalOutStack"`
-	AvgTripIncAmt          float64   `json:"AvgTripIncAmt"`
-	EstRndTrip             string    `json:"EstRndTrip"`
-	EstTotalTransRate      float64   `json:"EstTotalTransRate"`
-	EstTransRate           float64   `json:"EstTransRate"`
-	EstLatestTotalIncStack float64   `json:"EstLatestTotalIncStack"`
-	EstLatestTotalOutStack float64   `json:"EstLatestTotalOutStack"`
-	LatestIncStack         float64   `json:"LatestIncStack"`
-	LatestOutStack         float64   `json:"LatestOutStack"`
-	LatestRndTrip          string    `json:"LatestRndTrip"`
-	LatestTripIncAmt       float64   `json:"LatestTripIncAmt"`
-	LatestTripOutAmt       float64   `json:"LatestTripOutAmt"`
-	MedianRndTrip          string    `json:"MedianRndTrip"`
-	MedianTripIncAmt       float64   `json:"MedianTripIncAmt"`
-	MedianTripOutAmt       float64   `json:"MedianTripOutAmt"`
-	EstBatteryRate         float64   `json:"EstBatteryRate"`
-	PowerInfo              PowerInfo `json:"PowerInfo"`
+	Id                     string               `json:"ID"`
+	HomeStation            string               `json:"Name"`
+	PairedStation          string               `json:"PairedStation"`
+	DroneStatus            string               `json:"DroneStatus"`
+	AvgIncRate             float64              `json:"AvgIncRate"`
+	AvgIncStack            float64              `json:"AvgIncStack"`
+	AvgOutRate             float64              `json:"AvgOutRate"`
+	AvgOutStack            float64              `json"AvgOutStack"`
+	AvgRndTrip             string               `json:"AvgRndTrip"`
+	AvgTotalIncRate        float64              `json:"AvgTotalIncRate"`
+	AvgTotalIncStack       float64              `json:"AvgTotalIncStack"`
+	AvgTotalOutRate        float64              `json:"AvgTotalOutRate"`
+	AvgTotalOutStack       float64              `json:"AvgTotalOutStack"`
+	AvgTripIncAmt          float64              `json:"AvgTripIncAmt"`
+	EstTotalTransRate      float64              `json:"EstTotalTransRate"`
+	EstTransRate           float64              `json:"EstTransRate"`
+	EstLatestTotalIncStack float64              `json:"EstLatestTotalIncStack"`
+	EstLatestTotalOutStack float64              `json:"EstLatestTotalOutStack"`
+	LatestIncStack         float64              `json:"LatestIncStack"`
+	LatestOutStack         float64              `json:"LatestOutStack"`
+	LatestRndTrip          float64              `json:"LatestRndTrip"`
+	LatestTripIncAmt       float64              `json:"LatestTripIncAmt"`
+	LatestTripOutAmt       float64              `json:"LatestTripOutAmt"`
+	MedianRndTrip          string               `json:"MedianRndTrip"`
+	MedianTripIncAmt       float64              `json:"MedianTripIncAmt"`
+	MedianTripOutAmt       float64              `json:"MedianTripOutAmt"`
+	PowerInfo              PowerInfo            `json:"PowerInfo"`
+	Fuel                   []DroneFuelInventory `json:"FuelInventory"`
+	ActiveFuel             DroneActiveFuel      `json:"ActiveFuel"`
 }
 
-func NewDroneStationCollector(frmAddress string) *DroneStationCollector {
+func NewDroneStationCollector(endpoint string) *DroneStationCollector {
 	return &DroneStationCollector{
-		FRMAddress: frmAddress,
+		endpoint: endpoint,
+		metricsDropper: NewMetricsDropper(
+			DronePortFuelRate,
+			DronePortFuelAmount,
+			DronePortRndTrip,
+		),
 	}
 }
 
-func (c *DroneStationCollector) Collect() {
+func (c *DroneStationCollector) Collect(frmAddress string, sessionName string) {
 	details := []DroneStationDetails{}
-	err := retrieveData(c.FRMAddress, &details)
+	err := retrieveData(frmAddress+c.endpoint, &details)
 	if err != nil {
+		c.metricsDropper.DropStaleMetricLabels()
 		log.Printf("error reading drone station statistics from FRM: %s\n", err)
 		return
 	}
 
 	powerInfo := map[float64]float64{}
+	maxPowerInfo := map[float64]float64{}
 	for _, d := range details {
+		c.metricsDropper.CacheFreshMetricLabel(prometheus.Labels{"url": frmAddress, "session_name": sessionName, "id": d.Id})
 		id := d.Id
 		home := d.HomeStation
 		paired := d.PairedStation
 
-		DronePortBatteryRate.WithLabelValues(id, home, paired).Set(d.EstBatteryRate)
-
-		roundTrip := parseTimeSeconds(d.LatestRndTrip)
-		if roundTrip != nil {
-			DronePortRndTrip.WithLabelValues(id, home, paired).Set(*roundTrip)
+		if len(d.Fuel) > 0 {
+			DronePortFuelAmount.WithLabelValues(id, home, d.Fuel[0].Name, frmAddress, sessionName).Set(d.Fuel[0].Amount)
+			DronePortFuelRate.WithLabelValues(id, home, d.Fuel[0].Name, frmAddress, sessionName).Set(d.ActiveFuel.Rate)
+			DronePortRndTrip.WithLabelValues(id, home, paired, frmAddress, sessionName).Set(d.LatestRndTrip)
 		}
 
-		val, ok := powerInfo[d.PowerInfo.CircuitId]
+		val, ok := powerInfo[d.PowerInfo.CircuitGroupId]
 		if ok {
-			powerInfo[d.PowerInfo.CircuitId] = val + d.PowerInfo.PowerConsumed
+			powerInfo[d.PowerInfo.CircuitGroupId] = val + d.PowerInfo.PowerConsumed
 		} else {
-			powerInfo[d.PowerInfo.CircuitId] = d.PowerInfo.PowerConsumed
+			powerInfo[d.PowerInfo.CircuitGroupId] = d.PowerInfo.PowerConsumed
+		}
+		val, ok = maxPowerInfo[d.PowerInfo.CircuitGroupId]
+		if ok {
+			maxPowerInfo[d.PowerInfo.CircuitGroupId] = val + d.PowerInfo.MaxPowerConsumed
+		} else {
+			maxPowerInfo[d.PowerInfo.CircuitGroupId] = d.PowerInfo.MaxPowerConsumed
 		}
 	}
 
 	for circuitId, powerConsumed := range powerInfo {
 		cid := strconv.FormatFloat(circuitId, 'f', -1, 64)
-		DronePortPower.WithLabelValues(cid).Set(powerConsumed)
+		DronePortPower.WithLabelValues(cid, frmAddress, sessionName).Set(powerConsumed)
 	}
+
+	c.metricsDropper.DropStaleMetricLabels()
 }
+
+func (c *DroneStationCollector) DropCache() {}