Merge branch 'FEAT/web-dashboard' of github.com:bisohns/saido into FE…

…AT/web-dashboard

.gitignore

@@ -15,3 +15,6 @@ ssh-key/ci/
 config-ci.yaml
 config-test.yaml
 tmp/
+cmd/build/
+*-packr.go
+.air.toml

Makefile

@@ -1,3 +1,9 @@
+version=fake
+ifeq ($(OS),Windows_NT)
+bin=main.exe
+else
+bin=main
+endif
 # Example:
 #   make
 #   make prep-ci-ssh
@@ -18,7 +24,7 @@ prep-ci-local-windows:
 	cp ".\scripts\config.local.yaml" ".\config-test.yaml"
 	cat config-test.yaml
 
-ifneq($(findstring fake, $(version)), fake)
+ifneq ($(findstring fake, $(version)), fake)
 upgrade:
 	@echo ">>> Recreating version_num.go"
 	@echo 'package cmd\n\nconst Version = "$(version)"' > cmd/version_num.go
@@ -30,3 +36,22 @@ else
 upgrade:
 	@echo "Version not set - use syntax \`make upgrade version=0.x.x\`"
 endif
+
+dependencies:
+ifeq ($(bin),main.exe)
+	@make prep-ci-local-windows
+else
+	@make prep-ci-local
+endif
+	go get .
+	cd web && yarn install && cd ..
+
+.PHONY: build-frontend
+build-frontend:
+	cd web && yarn build && cd ..
+
+.PHONY: serve-backend
+serve-backend:
+	air --build.cmd "go build -o ./tmp/$(bin) ." --build.bin "tmp/$(bin)" --build.exclude_dir "assets,docs,tmp,web,scripts,ssh-key,.github,.git" --build.include_ext "go,yaml,html,js" --build.exclude_file "config.example.yaml" --build.args_bin "dashboard,--config,config-test.yaml" --build.stop_on_error true --misc.clean_on_exit true --log.time true
+
+app: build-frontend serve-backend

README.md

@@ -19,26 +19,28 @@ For personal usage, install latest from [Github Releases](https://github.com/bis
 
 ```bash
 # binary is downloaded and named as saido
-saido api
+saido dashboard --config config.yaml --port 3000
 ```
 
 
 ### Development
 
-With Golang installed, run
+#### Requirements
+- [Golang](https://go.dev/doc/install)
+- [Docker](https://docs.docker.com/get-docker/)
+- [Yarn](https://classic.yarnpkg.com/lang/en/docs/install/)
+- [Air](https://github.com/cosmtrek/air)
 
 ```bash
 git clone https://github.com/bisohns/saido
 cd saido
-## Update Golang dependencies
-go get .
+## Update dependencies
+make dependencies
 
-## Update yarn dependencies
-cd web
-yarn install
+# Build and serve frontend
+make app
 
-# Run websocket server and serve frontend
-go run main.go dashboard --config config-test.yaml
+# Modify generated `config-test.yaml` file and air would reload server
 ```
 
 ## Deployment

client/client.go

@@ -21,7 +21,7 @@ func (client *Client) Write() {
 		if err != nil {
 			log.Error("Error inside client write ", err)
 			// check socket connection has been closed and end writer
-			if websocket.IsUnexpectedCloseError(err, websocket.CloseGoingAway, websocket.CloseAbnormalClosure) {
+			if websocket.IsUnexpectedCloseError(err, websocket.CloseGoingAway, websocket.CloseAbnormalClosure, websocket.CloseInternalServerErr) || err == websocket.ErrCloseSent {
 				return
 			}
 		}

client/controller.go

@@ -74,8 +74,8 @@ func (hosts *HostsController) sendMetric(host config.Host, client *Client) {
 		hosts.resetDriver(host)
 	}
 	for metric, custom := range hosts.Info.Metrics {
-		driver := hosts.getDriver(host.Address)
-		initializedMetric, err := inspector.Init(metric, driver, custom)
+		inspectorDriver := hosts.getDriver(host.Address)
+		initializedMetric, err := inspector.Init(metric, inspectorDriver, custom)
 		if err != nil {
 			log.Error(err)
 		}
@@ -86,7 +86,7 @@ func (hosts *HostsController) sendMetric(host config.Host, client *Client) {
 			message := &SendMessage{
 				Message: Message{
 					Host:     host.Address,
-					Platform: (*driver).GetDetails().Name,
+					Platform: (*inspectorDriver).GetDetails().Name,
 					Name:     metric,
 					Data:     unmarsh,
 				},
@@ -99,12 +99,15 @@ func (hosts *HostsController) sendMetric(host config.Host, client *Client) {
 			// check for error 127 which means command was not found
 			var errorContent string
 			if !strings.Contains(fmt.Sprintf("%s", err), "127") {
-				errorContent = fmt.Sprintf("Could not retrieve metric %s from driver %s with error %s, resetting connection...", metric, host.Address, err)
+				errorContent = fmt.Sprintf("Could not retrieve metric %s from driver %s with error %s", metric, host.Address, err)
 			} else {
 				errorContent = fmt.Sprintf("Command %s not found on driver %s", metric, host.Address)
 			}
-			log.Error(errorContent)
-			hosts.resetDriver(host)
+			log.Debug(errorContent)
+			//FIXME: what kind of errors do we especially want to reset driver for
+			if _, ok := err.(*driver.SSHConnectError); ok {
+				hosts.resetDriver(host)
+			}
 			message := &SendMessage{
 				Message: ErrorMessage{
 					Error: errorContent,
@@ -128,7 +131,7 @@ func (hosts *HostsController) Poll(client *Client) {
 				go hosts.sendMetric(host, client)
 			}
 		}
-		log.Infof("Delaying for %d seconds", hosts.Info.PollInterval)
+		log.Debugf("Delaying for %d seconds", hosts.Info.PollInterval)
 		time.Sleep(time.Duration(hosts.Info.PollInterval) * time.Second)
 	}
 }

cmd/api.go

@@ -16,35 +16,79 @@ limitations under the License.
 package cmd
 
 import (
+	"embed"
+	"fmt"
+	"io/fs"
 	"net/http"
 	"os"
+	"path"
 	"strconv"
 
 	"github.com/bisohns/saido/client"
+	"github.com/bisohns/saido/config"
 	"github.com/gorilla/handlers"
+	"github.com/pkg/browser"
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
 var (
 	port   string
 	server = http.NewServeMux()
+
+	//go:embed build/*
+	build   embed.FS
+	cfgFile string
+	cfg     *config.Config
 )
 
+type fsFunc func(name string) (fs.File, error)
+
+func (f fsFunc) Open(name string) (fs.File, error) {
+	return f(name)
+}
+
+func EmbedHandler(prefix, root string) http.Handler {
+	handler := fsFunc(func(name string) (fs.File, error) {
+		assetPath := path.Join(root, name)
+
+		// If we can't find the asset, return the default index.html
+		// build
+		f, err := build.Open(assetPath)
+		if os.IsNotExist(err) {
+			return build.Open(fmt.Sprintf("%s/index.html", root))
+		}
+
+		// Otherwise assume this is a legitimate request routed
+		// correctly
+		return f, err
+	})
+
+	return http.StripPrefix(prefix, http.FileServer(http.FS(handler)))
+}
+
 var apiCmd = &cobra.Command{
 	Use:   "dashboard",
 	Short: "Run saido dashboard on a PORT env variable, fallback to set argument",
 	Long:  ``,
 	Run: func(cmd *cobra.Command, args []string) {
+		cfg = config.LoadConfig(cfgFile)
 		hosts := client.NewHostsController(cfg)
+
+		frontendHandler := EmbedHandler("/", "build")
+		server.Handle("/", frontendHandler)
 		server.Handle("/metrics", hosts)
+		server.Handle("/*filepath", frontendHandler)
 		log.Info("listening on :", port)
 		_, err := strconv.Atoi(port)
 		if err != nil {
 			log.Fatal(err)
 		}
 		go hosts.Run()
 		loggedRouters := handlers.LoggingHandler(os.Stdout, server)
+		// Trigger browser open
+		url := fmt.Sprintf("http://localhost:%s", port)
+		browser.OpenURL(url)
 		if err := http.ListenAndServe(":"+port, loggedRouters); err != nil {
 			log.Fatal(err)
 		}
@@ -53,5 +97,7 @@ var apiCmd = &cobra.Command{
 
 func init() {
 	apiCmd.Flags().StringVarP(&port, "port", "p", "3000", "Port to run application server on")
+	apiCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "Path to config file")
+	cobra.MarkFlagRequired(apiCmd.PersistentFlags(), "config")
 	rootCmd.AddCommand(apiCmd)
 }

cmd/root.go

@@ -26,9 +26,6 @@ import (
 )
 
 var (
-	cfgFile string
-	cfg     *config.Config
-
 	// Verbose : Should display verbose logs
 	verbose       bool
 	dashboardInfo *config.DashboardInfo
@@ -39,22 +36,21 @@ const appName = "saido"
 // rootCmd represents the base command when called without any subcommands
 var rootCmd = &cobra.Command{
 	Use:   "saido",
-	Short: "TUI for monitoring specific host metrics",
+	Short: "Tool for monitoring metrics",
 	Long:  ``,
 	PersistentPreRun: func(cmd *cobra.Command, args []string) {
 		// Log only errors except in Verbose mode
 		if verbose {
 			log.SetLevel(log.DebugLevel)
 		} else {
-			//      log.SetLevel(log.InfoLevel)
-			log.SetLevel(log.DebugLevel)
+			log.SetLevel(log.InfoLevel)
 		}
 	},
 	PersistentPostRun: func(cmd *cobra.Command, args []string) {
-		fmt.Println("\n\nSaido - Bisoncorp (2020) (https://github.com/bisohns/saido)")
+		fmt.Println("\n\nSaido - Bisohns (2020) (https://github.com/bisohns/saido)")
 	},
 	Run: func(cmd *cobra.Command, args []string) {
-		log.Info("Saido is running ...")
+		log.Info("Run dashboard with the [dashboard] subcommand. Feel free to drop a star at https://github.com/bisohns/saido")
 	},
 }
 
@@ -68,13 +64,5 @@ func Execute() {
 }
 
 func init() {
-	cobra.OnInitialize(initConfig)
-	rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "Path to config file")
-
-	cobra.MarkFlagRequired(rootCmd.PersistentFlags(), "config")
-}
-
-// initConfig reads in config file and ENV variables if set.
-func initConfig() {
-	cfg = config.LoadConfig(cfgFile)
+	rootCmd.Flags().BoolVarP(&verbose, "verbose", "v", false, "Run saido in verbose mode")
 }

config.example.yaml

@@ -44,4 +44,4 @@ metrics:
   custom-uptime: "cat /proc/uptime"
   custom-dir: 'dir C:\'
   custom-echo: 'echo $HOME'
-poll-interval: 30
+poll-interval: 10

config/config.go

@@ -114,8 +114,8 @@ func GetDashboardInfoConfig(config *Config) *DashboardInfo {
 	for _, host := range dashboardInfo.Hosts {
 		log.Debugf("%s: %v", host.Address, host.Connection)
 	}
-	if config.PollInterval < 10 {
-		log.Fatal("Cannot set poll interval below 10 seconds")
+	if config.PollInterval < 5 {
+		log.Fatal("Cannot set poll interval below 5 seconds")
 	}
 	dashboardInfo.PollInterval = config.PollInterval
 	return dashboardInfo