Merge pull request #24 from featheredtoast/fix-mem-leak

Fix mem leak

Author: featheredtoast

.github/workflows/pull_request.yml

@@ -1,10 +1,26 @@
 on: pull_request
 name: Pull Request
-defaults:
-  run:
-    shell: powershell
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    strategy:
+      fail-fast: true
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: ">=1.22.0"
+      - name: gofmt
+        working-directory: ./Companion
+        run: |
+          if [ "$(gofmt -l . | wc -l)" -gt 0 ]; then
+            exit 1
+          fi
   test:
+    defaults:
+      run:
+        shell: powershell
     name: test
     runs-on: windows-latest
     steps:
@@ -34,4 +50,4 @@ jobs:
 
       - name: Test README generation
         run: |
-          make readme
+          make readme

Companion/exporter/collector_runner_test.go

@@ -5,8 +5,8 @@ import (
 	"time"
 
 	"github.com/AP-Hunt/FicsitRemoteMonitoringCompanion/Companion/exporter"
-	. "github.com/onsi/ginkgo/v2"
 	"github.com/coder/quartz"
+	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 )
 
@@ -61,7 +61,7 @@ var _ = Describe("CollectorRunner", func() {
 		})
 
 		It("sanitizes session name", func() {
-			Expect(exporter.SanitizeSessionName(`it's giving -- 123456!@#$%^&*() yo hollar "'"`)).To(Equal(`its giving  123456 yo hollar ` ))
+			Expect(exporter.SanitizeSessionName(`it's giving -- 123456!@#$%^&*() yo hollar "'"`)).To(Equal(`its giving  123456 yo hollar `))
 		})
 	})
 })

Companion/exporter/common.go

@@ -43,12 +43,11 @@ func retrieveData(frmAddress string, details any) error {
 		return err
 	}
 
+	defer resp.Body.Close()
 	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)
 
 	err = decoder.Decode(&details)

Companion/exporter/factory_building_collector_test.go

@@ -55,9 +55,9 @@ var _ = Describe("FactoryBuildingCollector", func() {
 				IsPaused:       false,
 				CircuitGroupId: 0,
 				PowerInfo: exporter.PowerInfo{
-					CircuitGroupId: 1,
-					PowerConsumed:  23,
-					MaxPowerConsumed:  4,
+					CircuitGroupId:   1,
+					PowerConsumed:    23,
+					MaxPowerConsumed: 4,
 				},
 			},
 		})

Companion/exporter/frm_server_fake_test.go

@@ -24,7 +24,7 @@ type FRMServerFake struct {
 	extractorData      []exporter.ExtractorDetails
 	portalData         []exporter.PortalDetails
 	hypertubeData      []exporter.HypertubeDetails
-	frackingData      []exporter.FrackingDetails
+	frackingData       []exporter.FrackingDetails
 }
 
 func NewFRMServerFake() *FRMServerFake {

Companion/exporter/registration_test.go

@@ -36,17 +36,17 @@ var _ = Describe("metrics dropper", func() {
 		globalReg.Unregister(metric)
 	})
 	It("Keeps fresh metrics", func() {
-		dropper.CacheFreshMetricLabel(prometheus.Labels{"label1":"val1"})
-		metric.WithLabelValues("val1","val2").Set(1)
+		dropper.CacheFreshMetricLabel(prometheus.Labels{"label1": "val1"})
+		metric.WithLabelValues("val1", "val2").Set(1)
 		dropper.DropStaleMetricLabels()
 		expectGauge(metric, "val1", "val2").To(Equal(1.0))
 	})
 	It("drops old metrics", func() {
-		dropper.CacheFreshMetricLabel(prometheus.Labels{"label1":"val1"})
-		metric.WithLabelValues("val1","val2").Set(1)
-		metric.WithLabelValues("val3","val4").Set(1)
+		dropper.CacheFreshMetricLabel(prometheus.Labels{"label1": "val1"})
+		metric.WithLabelValues("val1", "val2").Set(1)
+		metric.WithLabelValues("val3", "val4").Set(1)
 		dropper.DropStaleMetricLabels()
-		metric.WithLabelValues("val3","val4").Set(2)
+		metric.WithLabelValues("val3", "val4").Set(2)
 		dropper.DropStaleMetricLabels()
 		expectGauge(metric, "val1", "val2").To(Equal(0.0))
 		expectGauge(metric, "val3", "val4").To(Equal(2.0))

Companion/exporter/vehicle_collector.go

@@ -10,7 +10,7 @@ import (
 type VehicleCollector struct {
 	endpoint        string
 	TrackedVehicles map[string]*VehicleDetails
-	metricsDropper *MetricsDropper
+	metricsDropper  *MetricsDropper
 }
 
 type VehicleDetails struct {
@@ -23,7 +23,7 @@ type VehicleDetails struct {
 	PathName     string   `json:"PathName"`
 	DepartTime   time.Time
 	Departed     bool
-	LastTracked time.Time
+	LastTracked  time.Time
 }
 
 type Fuel struct {

Companion/main.go

@@ -8,6 +8,7 @@ import (
 	"os/signal"
 	"path"
 	"path/filepath"
+	"strconv"
 	"strings"
 	"syscall"
 	"text/template"
@@ -46,18 +47,21 @@ func main() {
 	frmHostname = lookupEnvWithDefault("FRM_HOST", frmHostname)
 	frmPort = lookupEnvWithDefault("FRM_PORT", frmPort)
 	frmHostnames = lookupEnvWithDefault("FRM_HOSTS", frmHostnames)
+	logStdout, _ := strconv.ParseBool(lookupEnvWithDefault("FRM_LOG_STDOUT", "0"))
 
 	if genReadme {
 		generateReadme()
 		os.Exit(0)
 	}
 
-	logFile, err := createLogFile()
-	if err != nil {
-		fmt.Printf("error creating log file: %s", err)
-		os.Exit(1)
+	if !logStdout {
+		logFile, err := createLogFile()
+		if err != nil {
+			fmt.Printf("error creating log file: %s", err)
+			os.Exit(1)
+		}
+		log.Default().SetOutput(logFile)
 	}
-	log.Default().SetOutput(logFile)
 
 	// Create exporter
 	frmUrls := []string{}
@@ -75,6 +79,7 @@ func main() {
 	promExporter = exporter.NewPrometheusExporter(frmUrls)
 
 	var prom *prometheus.PrometheusWrapper
+	var err error
 	if !noProm {
 		// Create prometheus
 		prom, err = prometheus.NewPrometheusWrapper()

README.md

@@ -24,6 +24,16 @@ The [Prometheus metrics server](https://prometheus.io/) allows you to [explore t
 
 (* Link goes to the address on your local system. If FRMC is not running, you will see an error)
 
+### Env vars
+
+`FRM_HOST`: The host to the Ficsit Remote Monitoring server. EG: `172.17.0.1`.
+
+`FRM_PORT`: The port of the Ficist Remote Monitoring server. EG: `8080`.
+
+`FRM_HOSTS`: A comma separated list of Ficsit Remote Monitoring servers. If protocol is unspecified, it defaults to http. EG: `http://myserver1.frm.example:8080,myserver2.frm.example:8080,https://myserver3.frm.example:8081`
+
+`FRM_LOG_STDOUT`: If FRMC should print to stdout rather than a separate logfile. Useful for docker/containerization. default false.
+
 ## What metrics are available