Migrating frontend to VueJS

Author: carsso

.gitignore

@@ -7,9 +7,11 @@
 /wigo.*
 /debs
 /release
+/public
 
 # dev
 /probes/60
+/dev
 /ssl
 /var
 /wigo.conf.*

Makefile

@@ -17,7 +17,7 @@ endif
 
 build = go build
 
-.PHONY: release race
+.PHONY: release race build-dev run-dev
 race:
 	@echo "Building with race detector (current OS)"
 	@mkdir -p release
@@ -27,9 +27,19 @@ race:
 	GORACE="halt_on_error=1" go build -race -o current/wigocli $(BASE_DIR)/src/wigocli.go; \
 	go build -o current/generate_cert $(BASE_DIR)/src/generate_cert.go
 
-all: clean release
+all: clean lint release releases
 
-releases:
+deps:
+	@echo "Installing dependencies"
+	go mod download -x
+	@echo "Installing frontend dependencies"
+	cd src/public && npm install
+
+build-frontend: deps
+	@echo "Building frontend"
+	cd src/public && npm run build
+
+releases: build-frontend
 	@echo "Building Wigo releases"
 	@mkdir -p release
 	@cd release && for target in $(RELEASE_TARGETS) ; do \
@@ -51,7 +61,7 @@ releases:
 		$(build) -o $$RELEASE_DIR/generate_cert $(BASE_DIR)/src/cmd/generate_cert/main.go; \
 	done
 
-release:
+release: build-frontend
 	@echo "Building Wigo release for current OS"
 	@mkdir -p release
 	@cd release; \
@@ -60,7 +70,7 @@ release:
 	$(build) -tags "netgo osusergo" -ldflags "-s -w -X github.com/root-gg/wigo/src/wigo.Version=$(RELEASE_VERSION)" -o current/wigocli $(BASE_DIR)/src/cmd/wigocli/main.go; \
 	$(build) -o current/generate_cert $(BASE_DIR)/src/cmd/generate_cert/main.go
 
-debs:
+debs: releases
 	@echo "Building Wigo Debian packages"
 	@mkdir -p $(DEBSRC)
 	@mkdir -p $(DEBSRC)/etc/wigo/conf.d
@@ -106,7 +116,7 @@ publish-debs:
 		done \
 	done
 
-lint:
+lint: fmt
 	@FAIL=0 ;echo -n " - go fmt :" ; OUT=`gofmt -l . | grep -v ^vendor` ; \
 	if [[ -z "$$OUT" ]]; then echo " OK" ; else echo " FAIL"; echo "$$OUT"; FAIL=1 ; fi ;\
 	echo -n " - go vet :" ; OUT=`go vet ./...` ; \
@@ -120,7 +130,44 @@ clean:
 	@echo "Cleaning all files"
 	@rm -rf release
 	@rm -rf $(DEBROOT)
+	@rm -rf dev
 
-deps:
-	@echo "Installing dependencies"
-	go mod download -x
+build-dev: deps
+	@echo "Building Wigo for development"
+	@mkdir -p release/current
+	@go build -o release/current/wigo $(BASE_DIR)/src/cmd/wigo/main.go
+	@go build -o release/current/wigocli $(BASE_DIR)/src/cmd/wigocli/main.go
+	@go build -o release/current/generate_cert $(BASE_DIR)/src/cmd/generate_cert/main.go
+
+
+run-dev: build-dev
+	@echo "Starting Wigo development server"
+	@trap 'kill $$WIGO_PID $$TAIL_PID 2>/dev/null; wait $$WIGO_PID $$TAIL_PID 2>/dev/null; exit' INT TERM; \
+	mkdir -p $(BASE_DIR)/dev; \
+	mkdir -p $(BASE_DIR)/dev/probes/; \
+	if [ ! -d $(BASE_DIR)/dev/probes/60 ]; then mkdir -p $(BASE_DIR)/dev/probes/60; fi; \
+	for probe in hardware_load_average hardware_disks hardware_memory ifstat supervisord needrestart check_mdadm check_process haproxy lm-sensors iostat check_uptime smart check_ntp packages-apt; do \
+		if [ ! -e $(BASE_DIR)/dev/probes/60/$$probe ]; then \
+			ln -s $(BASE_DIR)/probes/examples/$$probe $(BASE_DIR)/dev/probes/60/$$probe; \
+		fi; \
+	done; \
+	if [ ! -d $(BASE_DIR)/dev/probes/300 ]; then mkdir -p $(BASE_DIR)/dev/probes/300; fi; \
+	for probe in smart check_ntp packages-apt; do \
+		if [ ! -e $(BASE_DIR)/dev/probes/300/$$probe ]; then \
+			ln -s $(BASE_DIR)/probes/examples/$$probe $(BASE_DIR)/dev/probes/300/$$probe; \
+		fi; \
+	done; \
+	ln -s $(BASE_DIR)/lib $(BASE_DIR)/dev/lib; \
+	if [ ! -e $(BASE_DIR)/dev/wigo.crt ]; then \
+		(cd $(BASE_DIR)/dev && $(BASE_DIR)/release/current/generate_cert -ca=true -duration=87600h0m0s -host "127.0.0.1" --rsa-bits=4096;) \
+	fi; \
+	sudo $(BASE_DIR)/release/current/wigo --config $(BASE_DIR)/etc/wigo-dev.conf & \
+	WIGO_PID=$$!; \
+	sleep 1; \
+	tail -f $(BASE_DIR)/dev/wigo.log 2>/dev/null & \
+	TAIL_PID=$$!; \
+	cd $(BASE_DIR)/src/public && npm run watch; \
+	EXIT_CODE=$$?; \
+	kill $$WIGO_PID $$TAIL_PID 2>/dev/null; \
+	wait $$WIGO_PID $$TAIL_PID 2>/dev/null; \
+	exit $$EXIT_CODE

README.md

@@ -88,15 +88,20 @@ The directory name is the interval of check in seconds
 ### Building from sources
 
 ##### Environment
-To build from sources, you need `golang` and `gcc` installed.
-The `$GOPATH` environment variable should also be set on your system.
+To build from sources, you need:
+- `golang` and `gcc` installed
+- `node.js` and `npm` for the frontend
+- The `$GOPATH` environment variable should also be set on your system
 
 ##### Dependencies
+
+Install all dependencies:
 ```sh
 make deps
 ```
 
-##### Building for your system
+##### Building
+
 ```sh
 make clean release
 ```
@@ -113,6 +118,20 @@ You will need `dpkg-deb`
 make debs
 ```
 
+##### Development mode
+
+To run Wigo in development mode with hot-reload for both backend and frontend:
+
+```sh
+make run-dev
+```
+
+The web interface will be available at `http://localhost:4400/` (or the port configured in `etc/wigo-dev.conf`).
+
+To stop the development server, press `Ctrl+C` - this will gracefully stop both the Go server and the frontend watcher.
+
+**Note:** The development mode requires `sudo` privileges to run the Wigo server. The development files are stored in the `dev/` directory.
+
 ### Usage
 
 ##### Wigo web interface

etc/wigo-dev.conf

@@ -0,0 +1,132 @@
+#
+## What Is Going On
+#
+
+# General parameters
+#
+# ListenAddress             -> Address on which wigo will listen
+# ListenPort                -> Port on which wigo will listen
+# Group                     -> Group of current machine (webserver, loadbalancer,...).
+# AliveTimeout              -> Number of seconds before setting remote wigo in error 
+#                           If provided, a tag group will be added on OpenTSDB puts
+#
+[Global]
+Hostname                    = ""
+Group                       = ""
+LogFile                     = "dev/wigo.log"
+ProbesDirectory             = "dev/probes"
+ProbesConfigDirectory       = "etc/conf.d"
+UuidFile                    = "dev/uuid"
+Database                    = "dev/wigo.db"
+AliveTimeout                = 60
+Debug                       = true
+
+[Http]
+Enabled                     = true
+Address                     = "0.0.0.0"
+Port                        = 4400
+SslEnabled                  = false
+SslCert                     = "dev/http.crt"
+SslKey                      = "dev/http.key"
+Login                       = ""
+Password                    = ""
+
+[PushServer]
+Enabled                     = true
+Address                     = "0.0.0.0"
+Port                        = 4401
+SslEnabled                  = true
+SslCert                     = "dev/wigo.crt"
+SslKey                      = "dev/wigo.key"
+AllowedClientsFile          = "dev/allowed_clients"
+AutoAcceptClients           = false
+
+[PushClient]
+Enabled                     = false
+Address                     = ""
+Port                        = 4401
+SslEnabled                  = true
+SslCert                     = "dev/master.crt"
+UuidSig                     = "dev/uuid.sig"
+PushInterval                = 10
+
+# OpenTSDB
+#
+# You can specify an OpenTSDB instance to graph all probes metrics
+#
+# Params :
+#   OpenTSDBEnabled         -> Wether or not OpenTSDB graphing is enabled (true/false)
+#   OpenTSDBAddress         -> Ip of OpenTSDB instance
+#   OpenTSDBPort            -> Port of OpenTSDB instance
+#   OpenTSDBMetricPrefix    -> Prefix added before metric name (a dot will be added between prefix and probe name)
+#
+[OpenTSDB]
+Enabled                     = false
+Address                     = ["localhost"]
+SslEnabled                  = false
+MetricPrefix                = "wigo"
+Deduplication               = 600
+BufferSize                  = 10000
+
+# RemoteWigos
+#
+# You can configure remoteWigos to monitore them from that instance of Wigo
+#
+# CheckInterval      -> Number of seconds between remote wigo checks (do not set a value lower than AliveTimeout/2)
+#
+
+[RemoteWigos]
+CheckInterval               = 10
+SslEnabled		            = false
+Login			            = ""
+Password		            = ""
+
+# Simple mode (you just define hostname and port, which is optional)
+# List                        = [
+#     "ip",                        -> IP (mandatory)  : Hostname of remoteWigo to check
+#     "ip:port",                   -> port (optional) : Port to connect to on remote host (default is local ListenPort)
+# ]
+#
+List                        = []
+
+# Full mode (every configuration parameter is customizable by remote wigo)
+# [[AdvancedList]]
+#    Hostname          = "ip"      -> mandatory: Hostname of remoteWigo to check
+#    Port              = 4000      -> optional : Port of remoteWigo to check (default is local ListenPort)
+#    CheckInterval     = 10        -> optional : Number of seconds between remote wigo checks (default is RemoteWigosCheckInterval)
+#    CheckRemotesDepth = 0         -> optional : Depth level for remoteWigos of remoteWigo checking (default is 0 -> all levels)
+#
+#[[AdvancedList]]
+#    Hostname        = "ip2"
+#    CheckRemotes    = 1
+#
+
+
+# Notifications
+#
+# You can configure notifications (http,email) when a probe/host status changes
+#
+[Notifications]
+
+# General
+MinLevelToSend              = 250
+RescueOnly                  = false
+OnWigoChange                = false
+OnProbeChange               = false
+
+# HTTP
+HttpEnabled                 = 0                     # -> 0: disabled, 1: enabled
+HttpUrl                     = ""
+
+# Apprise https://github.com/caronc/apprise
+AppriseEnabled              = 0                     # -> 0: disabled, 1: enabled
+ApprisePath                 = "/usr/local/bin/apprise" # Path to the Apprise binary, you need to install it first
+# List of Apprise URLs to send notifications to, see https://github.com/caronc/apprise/wiki/Notify_urls
+AppriseUrls                 = []
+
+# EMAIL
+EmailEnabled                = 0                     # -> 0: disabled, 1: enabled, 2: only if http failed
+EmailSmtpServer             = "smtp.domain.tld:25"
+EmailRecipients             = ["user@domain.tld","user2@domain.tld"]
+EmailFromName               = "Wigo"
+EmailFromAddress            = "wigo@domain.tld"