feat(api): add /api/v1/counts endpoint - app stats

- service_count
- updates_available
- updates_skipped

fixes #436

cmd/argus/main.go

@@ -81,10 +81,11 @@ func main() {
 		}
 	}
 
-	go db.Run(&config, &jLog)
+	// Setup DB and last known service versions.
+	db.Run(&config, &jLog)
 
 	// Track all targets for changes in version and act on any found changes.
-	go (&config).Service.Track(&config.Order, &config.OrderMutex)
+	go config.Service.Track(&config.Order, &config.OrderMutex)
 
 	// Web server.
 	web.Run(&config, &jLog)

command/command.go

@@ -1,4 +1,4 @@
-// Copyright [2024] [Argus]
+// Copyright [2025] [Argus]
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -90,7 +90,7 @@ func (c *Controller) ExecIndex(logFrom util.LogFrom, index int) error {
 			util.ServiceInfo{ID: *c.ServiceStatus.ServiceID},
 			true)
 	}
-	metric.IncreasePrometheusCounter(metric.CommandMetric,
+	metric.IncPrometheusCounter(metric.CommandResultTotal,
 		(*c.Command)[index].String(),
 		*c.ServiceStatus.ServiceID,
 		"",

command/init.go

@@ -1,4 +1,4 @@
-// Copyright [2024] [Argus]
+// Copyright [2025] [Argus]
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -70,12 +70,12 @@ func (c *Controller) InitMetrics() {
 	// ############
 	for _, cmd := range *c.Command {
 		name := cmd.String()
-		metric.InitPrometheusCounter(metric.CommandMetric,
+		metric.InitPrometheusCounter(metric.CommandResultTotal,
 			name,
 			*c.ServiceStatus.ServiceID,
 			"",
 			"SUCCESS")
-		metric.InitPrometheusCounter(metric.CommandMetric,
+		metric.InitPrometheusCounter(metric.CommandResultTotal,
 			name,
 			*c.ServiceStatus.ServiceID,
 			"",
@@ -91,12 +91,12 @@ func (c *Controller) DeleteMetrics() {
 
 	for _, cmd := range *c.Command {
 		name := cmd.String()
-		metric.DeletePrometheusCounter(metric.CommandMetric,
+		metric.DeletePrometheusCounter(metric.CommandResultTotal,
 			name,
 			*c.ServiceStatus.ServiceID,
 			"",
 			"SUCCESS")
-		metric.DeletePrometheusCounter(metric.CommandMetric,
+		metric.DeletePrometheusCounter(metric.CommandResultTotal,
 			name,
 			*c.ServiceStatus.ServiceID,
 			"",

command/init_test.go

@@ -1,4 +1,4 @@
-// Copyright [2024] [Argus]
+// Copyright [2025] [Argus]
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -376,13 +376,13 @@ func TestController_Metrics(t *testing.T) {
 	}
 
 	// WHEN the Prometheus metrics are initialised with initMetrics
-	hadC := testutil.CollectAndCount(metric.CommandMetric)
+	hadC := testutil.CollectAndCount(metric.CommandResultTotal)
 	hadG := testutil.CollectAndCount(metric.LatestVersionIsDeployed)
 	controller.InitMetrics()
 
 	// THEN it can be collected
 	// counters
-	gotC := testutil.CollectAndCount(metric.CommandMetric)
+	gotC := testutil.CollectAndCount(metric.CommandResultTotal)
 	wantC := 2 * len(*controller.Command)
 	if (gotC - hadC) != wantC {
 		t.Errorf("Controller.InitMetrics() %d Counter metrics were initialised, expecting %d",
@@ -399,7 +399,7 @@ func TestController_Metrics(t *testing.T) {
 	// AND it can be deleted
 	// counters
 	controller.DeleteMetrics()
-	gotC = testutil.CollectAndCount(metric.CommandMetric)
+	gotC = testutil.CollectAndCount(metric.CommandResultTotal)
 	if gotC != hadC {
 		t.Errorf("Controller.DeleteMetrics() was called, but Counter metrics mismatch got %d, expecting %d",
 			gotC, hadC)
@@ -416,7 +416,7 @@ func TestController_Metrics(t *testing.T) {
 	// InitMetrics
 	controller.InitMetrics()
 	// counters
-	gotC = testutil.CollectAndCount(metric.CommandMetric)
+	gotC = testutil.CollectAndCount(metric.CommandResultTotal)
 	if gotC != hadC {
 		t.Errorf("Controller.InitMetrics() on nil Controller shouldn't have changed the Counter metrics, got %d. expecting %d",
 			gotC, hadC)
@@ -430,7 +430,7 @@ func TestController_Metrics(t *testing.T) {
 	// DeleteMetrics
 	controller.DeleteMetrics()
 	// counters
-	gotC = testutil.CollectAndCount(metric.CommandMetric)
+	gotC = testutil.CollectAndCount(metric.CommandResultTotal)
 	if gotC != hadC {
 		t.Errorf("Controller.DeleteMetrics() on nil Controller shouldn't have changed the Counter metrics, got %d. expecting %d",
 			gotC, hadC)

db/handlers.go

@@ -1,4 +1,4 @@
-// Copyright [2024] [Argus]
+// Copyright [2025] [Argus]
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -23,8 +23,9 @@ import (
 )
 
 // handler will listen to the DatabaseChannel and act on
-// incoming messages.
+// incoming messages to the DatabaseChannel.
 func (api *api) handler() {
+	defer api.db.Close()
 	for message := range *api.config.DatabaseChannel {
 		// If the message is to delete a row.
 		if message.Delete {

db/handlers_test.go

@@ -1,4 +1,4 @@
-// Copyright [2024] [Argus]
+// Copyright [2025] [Argus]
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -27,7 +27,7 @@ import (
 )
 
 func TestAPI_UpdateRow(t *testing.T) {
-	// GIVEN a DB with a few service status'
+	// GIVEN a DB with a few service status'.
 	tests := map[string]struct {
 		cells           []dbtype.Cell
 		target          string
@@ -107,21 +107,21 @@ func TestAPI_UpdateRow(t *testing.T) {
 			t.Cleanup(func() { dbCleanup(tAPI) })
 			tAPI.initialise()
 
-			// Ensure the row exists if tc.exists
+			// Ensure the row exists when tc.exists.
 			if tc.exists {
 				tAPI.db.Exec("INSERT INTO status (id) VALUES (?)",
 					tc.target)
 			}
-			// Delete the DB file
+			// Delete the DB file.
 			if tc.databaseDeleted {
 				os.Remove(tAPI.config.Settings.Data.DatabaseFile)
 			}
 
-			// WHEN updateRow is called targeting single/multiple cells
+			// WHEN updateRow is called targeting single/multiple cells.
 			tAPI.updateRow(tc.target, tc.cells)
 			time.Sleep(100 * time.Millisecond)
 
-			// THEN those cell(s) are changed in the DB
+			// THEN those cell(s) are changed in the DB.
 			row := queryRow(t, tAPI.db, tc.target)
 			for _, cell := range tc.cells {
 				var got string
@@ -137,7 +137,7 @@ func TestAPI_UpdateRow(t *testing.T) {
 				case "approved_version":
 					got = row.ApprovedVersion()
 				default:
-					continue // Skip unknown columns
+					continue // Skip unknown columns.
 				}
 				if got != cell.Value {
 					if !tc.databaseDeleted {
@@ -155,7 +155,7 @@ func TestAPI_UpdateRow(t *testing.T) {
 }
 
 func TestAPI_DeleteRow(t *testing.T) {
-	// GIVEN a DB with a few service status'
+	// GIVEN a DB with a few service status'.
 	tests := map[string]struct {
 		serviceID       string
 		exists          bool
@@ -175,15 +175,15 @@ func TestAPI_DeleteRow(t *testing.T) {
 
 	for name, tc := range tests {
 		t.Run(name, func(t *testing.T) {
-			// t.Parallel() - Cannot run in parallel since we're using stdout
+			// t.Parallel() - Cannot run in parallel since we're using stdout.
 			releaseStdout := test.CaptureStdout()
 
 			tAPI := testAPI(name, "TestAPI_DeleteRow")
 			os.Remove(tAPI.config.Settings.Data.DatabaseFile)
 			t.Cleanup(func() { dbCleanup(tAPI) })
 			tAPI.initialise()
 
-			// Ensure the row exists if tc.exists
+			// Ensure the row exists if tc.exists.
 			if tc.exists {
 				tAPI.updateRow(
 					tc.serviceID,
@@ -192,31 +192,31 @@ func TestAPI_DeleteRow(t *testing.T) {
 				)
 				time.Sleep(100 * time.Millisecond)
 			}
-			// Check the row existence before the test
+			// Check the row existence before the test.
 			row := queryRow(t, tAPI.db, tc.serviceID)
 			if tc.exists && (row.LatestVersion() == "" || row.DeployedVersion() == "") {
 				t.Errorf("expecting row to exist. got %#v", row)
 			}
-			// Delete the DB file
+			// Delete the DB file.
 			if tc.databaseDeleted {
 				os.Remove(tAPI.config.Settings.Data.DatabaseFile)
 			}
 
-			// WHEN deleteRow is called targeting a row
+			// WHEN deleteRow is called targeting a row.
 			tAPI.deleteRow(tc.serviceID)
 			time.Sleep(100 * time.Millisecond)
 
-			// THEN if we deleted the DB before the statement, we should have logged an error
+			// THEN if we deleted the DB before the statement, we should have logged an error.
 			stdout := releaseStdout()
 			deleteFailRegex := `ERROR: [^)]+\), deleteRow`
 			if tc.databaseDeleted != util.RegexCheck(deleteFailRegex, stdout) {
 				t.Errorf("stdout mismatch:\nwant=%t (%q)\ngot:\n%q",
 					tc.databaseDeleted, deleteFailRegex, stdout)
 			}
-			// AND the row is deleted from the DB (if it existed and the DB wasn't deleted)
+			// AND the row is deleted from the DB (if it existed and the DB wasn't deleted).
 			row = queryRow(t, tAPI.db, tc.serviceID)
 			if row.LatestVersion() != "" || row.DeployedVersion() != "" {
-				// no delete if we deleted the db
+				// no delete if we deleted the db.
 				if !tc.databaseDeleted {
 					t.Errorf("expecting row to be deleted.\ngot %#v", row)
 				}
@@ -228,13 +228,13 @@ func TestAPI_DeleteRow(t *testing.T) {
 }
 
 func TestAPI_Handler(t *testing.T) {
-	// GIVEN a DB with a few service status'
+	// GIVEN a DB with a few service status'.
 	tAPI := testAPI("TestAPI_Handler", "db")
 	t.Cleanup(func() { dbCleanup(tAPI) })
 	tAPI.initialise()
 	go tAPI.handler()
 
-	// WHEN a message is sent to the DatabaseChannel targeting latest_version
+	// WHEN a message is sent to the DatabaseChannel targeting latest_version.
 	target := "keep0"
 	cell1 := dbtype.Cell{
 		Column: "latest_version", Value: "9.9.9"}
@@ -253,7 +253,7 @@ func TestAPI_Handler(t *testing.T) {
 	*tAPI.config.DatabaseChannel <- msg1
 	time.Sleep(250 * time.Millisecond)
 
-	// THEN the cell was changed in the DB
+	// THEN the cell was changed in the DB.
 	got := queryRow(t, tAPI.db, target)
 	if got.LatestVersion() != want.LatestVersion() {
 		t.Errorf("Expected %q to be updated to %q\ngot  %#v\nwant %#v",
@@ -262,28 +262,28 @@ func TestAPI_Handler(t *testing.T) {
 
 	// ------------------------------
 
-	// WHEN a message is sent to the DatabaseChannel deleting a row
+	// WHEN a message is sent to the DatabaseChannel deleting a row.
 	*tAPI.config.DatabaseChannel <- dbtype.Message{
 		ServiceID: target,
 		Delete:    true,
 	}
 	time.Sleep(250 * time.Millisecond)
 
-	// THEN the row is deleted from the DB
+	// THEN the row is deleted from the DB.
 	got = queryRow(t, tAPI.db, target)
 	if got.LatestVersion() != "" || got.DeployedVersion() != "" {
 		t.Errorf("Expected row to be deleted\ngot  %#v\nwant %#v", got, want)
 	}
 
 	// ------------------------------
 
-	// WHEN multiple messages are targeting the same row in quick succession
+	// WHEN multiple messages are targeting the same row in quick succession.
 	*tAPI.config.DatabaseChannel <- msg1
 	wantLatestVersion := msg2.Cells[0].Value
 	*tAPI.config.DatabaseChannel <- msg2
 	time.Sleep(250 * time.Millisecond)
 
-	// THEN the last message is the one that is applied
+	// THEN the last message is the one that is applied.
 	got = queryRow(t, tAPI.db, target)
 	if got.LatestVersion() != wantLatestVersion {
 		t.Errorf("Expected %q to be updated to %q\ngot  %#v\nwant %#v",

db/help_test.go

@@ -37,15 +37,14 @@ var cfg *config.Config
 func TestMain(m *testing.M) {
 	databaseFile := "TestDB.db"
 
-	// Log
+	// Log.
 	jLog := util.NewJLog("DEBUG", false)
 	jLog.Testing = true
 	LogInit(jLog, databaseFile)
 
 	cfg = testConfig()
 	cfg.Settings.Data.DatabaseFile = databaseFile
-	go Run(cfg, nil)
-	time.Sleep(250 * time.Millisecond) // Time for db to start
+	Run(cfg, nil)
 
 	exitCode := m.Run()
 	os.Remove(cfg.Settings.Data.DatabaseFile)
@@ -85,7 +84,7 @@ func testConfig() (cfg *config.Config) {
 		SaveChannel:     &saveChannel,
 	}
 
-	// Services
+	// Services.
 	for svcName := range cfg.Service {
 		svc := service.Service{
 			ID:     "foo",
@@ -99,7 +98,7 @@ func testConfig() (cfg *config.Config) {
 		svc.Status.SetDeployedVersion("2.0.0", "", false)
 		svc.Status.SetLatestVersion("3.0.0", time.Now().Add(time.Hour).Format(time.RFC3339), false)
 
-		// Add service to Config
+		// Add service to Config.
 		cfg.Service[svcName] = &svc
 	}
 
@@ -137,7 +136,7 @@ func queryRow(t *testing.T, db *sql.DB, serviceID string) *status.Status {
 		approved_version
 	FROM status
 	WHERE id = ?;`
-	// Retry up-to 10 times incase 'database is locked'
+	// Retry up-to 10 times in case 'database is locked'.
 	var row *sql.Rows
 	var err error
 	for i := 0; i < 10; i++ {

db/init.go

@@ -1,4 +1,4 @@
-// Copyright [2024] [Argus]
+// Copyright [2025] [Argus]
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -75,20 +75,28 @@ func checkFile(path string) {
 	}
 }
 
-// Run the database, initialising it and running the handler for any new message(s).
+// Run will start the database, initialise it and run the handler for messages in the background.
 func Run(cfg *config.Config, log *util.JLog) {
-	api := api{config: cfg}
 	if log != nil {
 		LogInit(log, cfg.Settings.DataDatabaseFile())
 	}
+	api := api{config: cfg}
+
 	api.initialise()
-	defer api.db.Close()
+	runningHandler := false
+	defer func() {
+		if !runningHandler {
+			api.db.Close()
+		}
+	}()
+
 	if len(api.config.Order) > 0 {
 		api.removeUnknownServices()
 		api.extractServiceStatus()
 	}
 
-	api.handler()
+	go api.handler()
+	runningHandler = true
 }
 
 func (api *api) initialise() {