Moved version file into webapp source tree. Replacing fmt with logger calls. moved Jobber config file into /scrutiny/jobber directory. Added scsi json file. Moved API rooute handlers into their own files in a module. Added not yet implemnented tooltips.

collector/pkg/collector/base.go

@@ -4,9 +4,9 @@ import (
 	"bytes"
 	"encoding/json"
 	"errors"
-	"fmt"
 	"github.com/analogj/scrutiny/collector/pkg/models"
 	"github.com/jaypipes/ghw"
+	"github.com/sirupsen/logrus"
 	"io"
 	"net/http"
 	"os"
@@ -17,13 +17,15 @@ import (
 
 var httpClient = &http.Client{Timeout: 10 * time.Second}
 
-type BaseCollector struct{}
+type BaseCollector struct {
+	logger *logrus.Entry
+}
 
 func (c *BaseCollector) detectStorageDevices() ([]models.Device, error) {
 
 	block, err := ghw.Block()
 	if err != nil {
-		fmt.Printf("Error getting block storage info: %v", err)
+		c.logger.Errorf("Error getting block storage info: %v", err)
 		return nil, err
 	}
 
@@ -32,31 +34,31 @@ func (c *BaseCollector) detectStorageDevices() ([]models.Device, error) {
 
 		// ignore optical drives and floppy disks
 		if disk.DriveType == ghw.DRIVE_TYPE_FDD || disk.DriveType == ghw.DRIVE_TYPE_ODD {
-			fmt.Printf(" => Ignore: Optical or floppy disk - (found %s)\n", disk.DriveType.String())
+			c.logger.Debugf(" => Ignore: Optical or floppy disk - (found %s)\n", disk.DriveType.String())
 			continue
 		}
 
 		// ignore removable disks
 		if disk.IsRemovable {
-			fmt.Printf(" => Ignore: Removable disk (%v)\n", disk.IsRemovable)
+			c.logger.Debugf(" => Ignore: Removable disk (%v)\n", disk.IsRemovable)
 			continue
 		}
 
 		// ignore virtual disks & mobile phone storage devices
 		if disk.StorageController == ghw.STORAGE_CONTROLLER_VIRTIO || disk.StorageController == ghw.STORAGE_CONTROLLER_MMC {
-			fmt.Printf(" => Ignore: Virtual/multi-media storage controller - (found %s)\n", disk.StorageController.String())
+			c.logger.Debugf(" => Ignore: Virtual/multi-media storage controller - (found %s)\n", disk.StorageController.String())
 			continue
 		}
 
 		// ignore NVMe devices (not currently supported) TBA
 		if disk.StorageController == ghw.STORAGE_CONTROLLER_NVME {
-			fmt.Printf(" => Ignore: NVMe storage controller - (found %s)\n", disk.StorageController.String())
+			c.logger.Debugf(" => Ignore: NVMe storage controller - (found %s)\n", disk.StorageController.String())
 			continue
 		}
 
 		// Skip unknown storage controllers, not usually S.M.A.R.T compatible.
 		if disk.StorageController == ghw.STORAGE_CONTROLLER_UNKNOWN {
-			fmt.Printf(" => Ignore: Unknown storage controller - (found %s)\n", disk.StorageController.String())
+			c.logger.Debugf(" => Ignore: Unknown storage controller - (found %s)\n", disk.StorageController.String())
 			continue
 		}
 

collector/pkg/collector/metrics.go

@@ -14,9 +14,7 @@ import (
 
 type MetricsCollector struct {
 	BaseCollector
-
 	apiEndpoint *url.URL
-	logger      *logrus.Entry
 }
 
 func CreateMetricsCollector(logger *logrus.Entry, apiEndpoint string) (MetricsCollector, error) {
@@ -27,7 +25,9 @@ func CreateMetricsCollector(logger *logrus.Entry, apiEndpoint string) (MetricsCo
 
 	sc := MetricsCollector{
 		apiEndpoint: apiEndpointUrl,
-		logger:      logger,
+		BaseCollector: BaseCollector{
+			logger: logger,
+		},
 	}
 
 	return sc, nil
@@ -44,8 +44,11 @@ func (mc *MetricsCollector) Run() error {
 
 	deviceRespWrapper := new(models.DeviceWrapper)
 	detectedStorageDevices, err := mc.detectStorageDevices()
+	if err != nil {
+		return err
+	}
 
-	fmt.Println("Sending detected devices to API, for filtering & validation")
+	mc.logger.Infoln("Sending detected devices to API, for filtering & validation")
 	err = mc.postJson(apiEndpoint.String(), models.DeviceWrapper{
 		Data: detectedStorageDevices,
 	}, &deviceRespWrapper)
@@ -54,10 +57,10 @@ func (mc *MetricsCollector) Run() error {
 	}
 
 	if !deviceRespWrapper.Success {
-		//TODO print error payload
-		fmt.Println("An error occurred while retrieving devices")
+		mc.logger.Errorln("An error occurred while retrieving filtered devices")
+		return errors.ApiServerCommunicationError("An error occurred while retrieving filtered devices")
 	} else {
-		fmt.Println(deviceRespWrapper)
+		mc.logger.Debugln(deviceRespWrapper)
 		var wg sync.WaitGroup
 
 		for _, device := range deviceRespWrapper.Data {
@@ -66,16 +69,16 @@ func (mc *MetricsCollector) Run() error {
 			go mc.Collect(&wg, device.WWN, device.DeviceName)
 		}
 
-		fmt.Println("Main: Waiting for workers to finish")
+		mc.logger.Infoln("Main: Waiting for workers to finish")
 		wg.Wait()
-		fmt.Println("Main: Completed")
+		mc.logger.Infoln("Main: Completed")
 	}
 
 	return nil
 }
 
 func (mc *MetricsCollector) Validate() error {
-	fmt.Println("Verifying required tools")
+	mc.logger.Infoln("Verifying required tools")
 	_, lookErr := exec.LookPath("smartctl")
 
 	if lookErr != nil {
@@ -87,14 +90,14 @@ func (mc *MetricsCollector) Validate() error {
 
 func (mc *MetricsCollector) Collect(wg *sync.WaitGroup, deviceWWN string, deviceName string) {
 	defer wg.Done()
-	fmt.Printf("Collecting smartctl results for %s\n", deviceName)
+	mc.logger.Infof("Collecting smartctl results for %s\n", deviceName)
 
 	result, err := mc.execCmd("smartctl", []string{"-a", "-j", fmt.Sprintf("/dev/%s", deviceName)}, "", nil)
 	resultBytes := []byte(result)
 	if err != nil {
-		fmt.Printf("error while retrieving data from smartctl %s\n", deviceName)
-		fmt.Printf("ERROR MESSAGE: %v", err)
-		fmt.Printf("RESULT: %v", result)
+		mc.logger.Errorf("error while retrieving data from smartctl %s\n", deviceName)
+		mc.logger.Errorf("ERROR MESSAGE: %v", err)
+		mc.logger.Errorf("RESULT: %v", result)
 		// TODO: error while retrieving data from smartctl.
 		// TODO: we should pass this data on to scrutiny API for recording.
 		return
@@ -105,7 +108,7 @@ func (mc *MetricsCollector) Collect(wg *sync.WaitGroup, deviceWWN string, device
 }
 
 func (mc *MetricsCollector) Publish(deviceWWN string, payload []byte) error {
-	fmt.Printf("Publishing smartctl results for %s\n", deviceWWN)
+	mc.logger.Infof("Publishing smartctl results for %s\n", deviceWWN)
 
 	apiEndpoint, _ := url.Parse(mc.apiEndpoint.String())
 	apiEndpoint.Path = fmt.Sprintf("/api/device/%s/smart", strings.ToLower(deviceWWN))

collector/pkg/errors/errors.go

@@ -24,3 +24,10 @@ type DependencyMissingError string
 func (str DependencyMissingError) Error() string {
 	return fmt.Sprintf("DependencyMissingError: %q", string(str))
 }
+
+// Raised when there was an error communicating with API server
+type ApiServerCommunicationError string
+
+func (str ApiServerCommunicationError) Error() string {
+	return fmt.Sprintf("ApiServerCommunicationError: %q", string(str))
+}

collector/pkg/models/selftest.go

@@ -1,8 +0,0 @@
-package models
-
-//type SelfTest struct {
-//	DeviceWWN string
-//	Device    Device `gorm:"foreignkey:DeviceWWN"` // use DeviceWWN as foreign key
-//
-//	TestDate time.Time
-//}

collector/pkg/models/smart.go

@@ -1,14 +0,0 @@
-package models
-
-//type Smart struct {
-//	DeviceWWN string
-//	Device    Device `gorm:"foreignkey:DeviceWWN"` // use DeviceWWN as foreign key
-//
-//	TestDate time.Time
-//
-//	Temp            float32
-//	PowerOnCount    int64
-//	PowerOnHours    int64
-//	SmartStatus     string
-//	SmartAttributes string
-//}

collector/pkg/version/version.go

@@ -1,5 +0,0 @@
-package version
-
-// VERSION is the app-global version string, which will be replaced with a
-// new value during packaging
-const VERSION = "0.1.2"