Merge pull request #19 from bcdevtools/feat/monitoring

feat: add new API for internal monitoring

Author: 0xbcdev

cmd/start_web.go

@@ -13,6 +13,7 @@ import (
 const (
 	flagPort               = "port"
 	flagAuthorizationToken = "authorization-token"
+	flagDisks              = "disks"
 	flagDebug              = "debug"
 
 	flagBrand               = "brand"
@@ -52,6 +53,7 @@ func GetStartWebCmd() *cobra.Command {
 			nodeHomeDirectory := strings.TrimSpace(args[0])
 			port, _ := cmd.Flags().GetUint16(flagPort)
 			authorizationToken, _ := cmd.Flags().GetString(flagAuthorizationToken)
+			disks, _ := cmd.Flags().GetStringSlice(flagDisks)
 			debug, _ := cmd.Flags().GetBool(flagDebug)
 
 			brand, _ := cmd.Flags().GetString(flagBrand)
@@ -82,6 +84,35 @@ func GetStartWebCmd() *cobra.Command {
 				return
 			}
 
+			if disks == nil || len(disks) == 0 {
+				utils.ExitWithErrorMsgf("ERR: disks is required, use --%s flag to set it\n", flagDisks)
+				return
+			}
+			for _, disk := range disks {
+				disk := strings.TrimSpace(disk)
+				if !strings.HasPrefix(disk, "/") {
+					utils.ExitWithErrorMsgf("ERR: disk must be absolute path, correct the --%s flag\n", flagDisks)
+					return
+				}
+				if strings.HasPrefix(disk, "/dev") {
+					utils.ExitWithErrorMsgf("ERR: disk must be path, not device, correct the --%s flag\n", flagDisks)
+					return
+				}
+				_, exists, isDir, err := utils.FileInfo(disk)
+				if err != nil {
+					utils.ExitWithErrorMsgf("ERR: disk %s is invalid, correct the --%s flag\n", disk, flagDisks)
+					return
+				}
+				if !exists {
+					utils.ExitWithErrorMsgf("ERR: disk %s does not exists, correct the --%s flag\n", disk, flagDisks)
+					return
+				}
+				if !isDir {
+					utils.ExitWithErrorMsgf("ERR: disk %s is not a directory, correct the --%s flag\n", disk, flagDisks)
+					return
+				}
+			}
+
 			brand = strings.TrimSpace(brand)
 			if brand == "" {
 				utils.ExitWithErrorMsgf("ERR: brand is required, use --%s flag to set it\n", flagBrand)
@@ -170,6 +201,7 @@ func GetStartWebCmd() *cobra.Command {
 			web_server.StartWebServer(webtypes.Config{
 				Port:           port,
 				AuthorizeToken: authorizationToken,
+				Disks:          disks,
 				NodeHome:       nodeHomeDirectory,
 				Debug:          debug,
 
@@ -195,6 +227,7 @@ func GetStartWebCmd() *cobra.Command {
 
 	cmd.Flags().Uint16(flagPort, defaultWebPort, "port to bind Web service to")
 	cmd.Flags().StringP(flagAuthorizationToken, "a", "", "authorization token")
+	cmd.Flags().StringSlice(flagDisks, []string{"/"}, "disks to monitor, must be path, mount-point, not device")
 	cmd.Flags().Bool(flagDebug, false, "enable debug mode")
 
 	cmd.Flags().String(flagBrand, defaultBrand, "brand")

services/web_server/download-addrbook.go services/web_server/download_addrbook.goservices/web_server/download-addrbook.go renamed to services/web_server/download_addrbook.go

@@ -38,3 +38,17 @@ func (w GinWrapper) Binder() *GinBinder {
 func (w GinWrapper) Config() types.Config {
 	return w.c.MustGet(constants.GinConfig).(types.Config)
 }
+
+func (w GinWrapper) IsAuthorizedRequest() bool {
+	cfg := w.Config()
+	if cfg.AuthorizeToken == "" {
+		return false
+	}
+
+	token := w.c.GetHeader("VN-Authorization")
+	if token == "" {
+		return false
+	}
+
+	return token == cfg.AuthorizeToken
+}

services/web_server/gin_wrapper/gin_wrapper.go

@@ -0,0 +1,73 @@
+package web_server
+
+import (
+	"github.com/bcdevtools/node-management/utils"
+	"github.com/gin-gonic/gin"
+	"github.com/shirou/gopsutil/v3/cpu"
+	"github.com/shirou/gopsutil/v3/disk"
+	"github.com/shirou/gopsutil/v3/mem"
+	"math"
+)
+
+func HandleApiInternalMonitoringStats(c *gin.Context) {
+	w := wrapGin(c)
+
+	cfg := w.Config()
+
+	cpuInfo := make(map[string]any)
+	vmInfo := make(map[string]any)
+	disks := make([]map[string]any, 0)
+
+	pCore, errPCore := cpu.Counts(false)
+	if errPCore == nil {
+		cpuInfo["physical_cores"] = pCore
+	}
+
+	lCore, errLCore := cpu.Counts(true)
+	if errLCore == nil {
+		cpuInfo["logical_cores"] = lCore
+	}
+
+	cpusPercent, errCpuPercent := cpu.Percent(0, false)
+	if errCpuPercent == nil {
+		cpuInfo["used_percent"] = normalizePercentage(cpusPercent[0])
+	}
+
+	vm, errVm := mem.VirtualMemory()
+	if errVm == nil {
+		vmInfo["total"] = convertByteToGb(vm.Total)
+		vmInfo["used"] = convertByteToGb(vm.Used)
+		vmInfo["used_percent"] = normalizePercentage(vm.UsedPercent)
+	}
+
+	for _, _disk := range cfg.Disks {
+		du, err := disk.Usage(_disk)
+		if err != nil {
+			utils.PrintlnStdErr("ERR: failed to get disk spec", "disk", _disk, "error", err.Error())
+			continue
+		}
+
+		disks = append(disks, map[string]any{
+			"mount":        _disk,
+			"total":        convertByteToGb(du.Total),
+			"used":         convertByteToGb(du.Used),
+			"used_percent": normalizePercentage(du.UsedPercent),
+		})
+	}
+
+	w.PrepareDefaultSuccessResponse(map[string]any{
+		"cpu":   cpuInfo,
+		"ram":   vmInfo,
+		"disks": disks,
+	}).SendResponse()
+}
+
+func convertByteToGb(byteCount uint64) float64 {
+	result := float64(byteCount) / 1024 / 1024 / 1024
+	result = math.Round(result*100) / 100
+	return result
+}
+
+func normalizePercentage(percent float64) float64 {
+	return float64(int(percent*100)) / 100
+}

services/web_server/handle_api_internal_monitoring_stats.go

@@ -5,6 +5,7 @@ import "path"
 type Config struct {
 	Port           uint16
 	AuthorizeToken string
+	Disks          []string
 	NodeHome       string
 	Debug          bool
 

services/web_server/handle_node_peers.go …ices/web_server/handle_api_node_peers.goservices/web_server/handle_node_peers.go renamed to services/web_server/handle_api_node_peers.go services/web_server/handle_node_peers.go renamed to services/web_server/handle_api_node_peers.go

@@ -12,6 +12,7 @@ import (
 	statikfs "github.com/rakyll/statik/fs"
 	"html/template"
 	"net/http"
+	"strings"
 )
 
 func StartWebServer(cfg webtypes.Config) {
@@ -31,6 +32,21 @@ func StartWebServer(cfg webtypes.Config) {
 	r.Use(func(c *gin.Context) {
 		c.Set(constants.GinConfig, cfg)
 	})
+	r.Use(func(c *gin.Context) {
+		if strings.HasPrefix(strings.TrimPrefix(c.Request.URL.Path, "/"), "api/internal") {
+			w := wrapGin(c)
+			if !w.IsAuthorizedRequest() {
+				w.PrepareDefaultErrorResponse().
+					WithHttpStatusCode(http.StatusForbidden).
+					WithResult("invalid authentication token").
+					SendResponse()
+				c.Abort()
+				return
+			}
+		}
+
+		c.Next()
+	})
 
 	const (
 		engineDelimsLeft  = "{[{"
@@ -57,6 +73,7 @@ func StartWebServer(cfg webtypes.Config) {
 
 	// API
 	r.GET("/api/node/live-peers", HandleApiNodeLivePeers)
+	r.GET("/api/internal/monitoring/stats", HandleApiInternalMonitoringStats)
 
 	// Web
 	r.GET("/", HandleWebIndex)