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

Author: silvareal

.air.toml

@@ -0,0 +1,28 @@
+name: goreleaser
+on:
+  push:
+    branches: [main]
+    tags:
+        - 'v*'
+jobs:
+  goreleaser:
+    runs-on: ubuntu-latest
+    if: success() && startsWith(github.ref, 'refs/tags/')
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-go@v3
+        with:
+          go-version: '>=1.19.3'
+          cache: true
+      - run: make dependencies
+      - run: make build-frontend
+      - uses: goreleaser/goreleaser-action@v2
+        with:
+          distribution: goreleaser
+          version: latest
+          args: release --rm-dist
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+        

.github/workflows/release.yaml

@@ -1,8 +1,8 @@
 on: 
   push:
-    branches: [ main, develop ]
+    branches: [ main, develop]
   pull_request:
-    branches: [ main ]
+    branches: [ main]
 name: Test-MacOs
 jobs:
   test:
@@ -11,11 +11,16 @@ jobs:
       - name: Install Go
         uses: actions/setup-go@v2
         with:
-          go-version: 1.16
+          go-version:  '>=1.16'
       - name: Checkout code
         uses: actions/checkout@v2
       - name: Setup config script 
         # using locals for mac-OS because github CI mac platforms don't have docker
-        run: make prep-ci-local
+        run: | 
+          make prep-ci-local
+          make dependencies
+          make build-frontend
       - name: Test
-        run: go test -v ./...
+        run: | 
+          go mod tidy  
+          go test -v ./...

.github/workflows/test-macos.yml

@@ -1,8 +1,8 @@
 on: 
   push:
-    branches: [ main, develop ]
+    branches: [ main, develop]
   pull_request:
-    branches: [ main ]
+    branches: [ main]
 name: Test-Linux
 jobs:
   test:
@@ -11,11 +11,16 @@ jobs:
       - name: Install Go
         uses: actions/setup-go@v2
         with:
-          go-version: 1.16
+          go-version:  '>=1.16'
       - name: Checkout code
         uses: actions/checkout@v2
       - name: Setup SSH server and config
         # run docker ssh container for ssh tests
-        run: make prep-ci-ssh
+        run: |
+          make prep-ci-ssh
+          make dependencies
+          make build-frontend
       - name: Test
-        run: go test -v ./...
+        run: | 
+          go mod tidy  
+          go test -v ./...

.github/workflows/test-ssh.yml

@@ -1,8 +1,8 @@
 on: 
   push:
-    branches: [ main, develop ]
+    branches: [ main, develop]
   pull_request:
-    branches: [ main ]
+    branches: [ main]
 name: Test-Windows
 jobs:
   test:
@@ -11,7 +11,7 @@ jobs:
       - name: Install Go
         uses: actions/setup-go@v2
         with:
-          go-version: 1.16
+          go-version:  '>=1.16'
       - name: Checkout code
         uses: actions/checkout@v2
       - name: Choco Install make
@@ -20,6 +20,11 @@ jobs:
           args: install make
       - name: Setup config script 
         # using locals for Windows because github CI Windows platforms don't have docker
-        run: make prep-ci-local-windows
+        run: | 
+          make prep-ci-local-windows
+          make dependencies
+          make build-frontend
       - name: Test
-        run: go test -v ./...
+        run: | 
+          go mod tidy  
+          go test -v ./...

.github/workflows/test-windows.yml

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

.gitignore

@@ -0,0 +1,39 @@
+before:
+  hooks:
+    - go mod tidy
+    - go generate ./...
+builds:
+  - env:
+      - CGO_ENABLED=0
+    goos:
+      - linux
+      - windows
+      - darwin
+archives:
+  - replacements:
+      darwin: Darwin
+      linux: Linux
+      windows: Windows
+      386: i386
+      amd64: x86_64
+checksum:
+  name_template: 'checksums.txt'
+#snapshot:
+#  name_template: "{{ incpatch .Version }}-next"
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - '^docs:'
+      - '^test:'
+      - '^intergration:'
+      - '^assets:'
+nfpms:
+- maintainer: Bisohns Corp.
+  description: YAML based tool for monitoring metrics across multiple hosts
+  homepage: https://github.com/bisohns/saido
+  license: Apache License 2.0
+  formats:
+    - deb
+    - rpm
+    - apk

.goreleaser.yaml

@@ -1,4 +1,11 @@
 version=fake
+ifeq ($(OS),Windows_NT)
+bin=main.exe
+build_bin=tmp\main.exe
+else
+bin=main
+build_bin=tmp/main
+endif
 # Example:
 #   make
 #   make prep-ci-ssh
@@ -31,3 +38,23 @@ 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
+	yarn add react-scripts@latest
+else
+	@make prep-ci-local
+endif
+	go get .
+	cd web && yarn install && cd ..
+
+.PHONY: build-frontend
+build-frontend:
+	cd web && export BUILD_PATH=../cmd/build && CI=false yarn build && cd ..
+
+.PHONY: serve-backend
+serve-backend:
+	air --build.cmd "go build -o ./tmp/$(bin) ." --build.bin "$(build_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

Makefile

@@ -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

README.md

@@ -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/client.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)
 	}
 }