telemetry: support telemetry client os/machine/version (disabled)

Author: fcharlie

pkg/serve/httpserver/config.go

@@ -47,7 +47,7 @@ func NewServerConfig(file string, expandEnv bool) (*ServerConfig, error) {
 		WriteTimeout: serve.Duration{
 			Duration: DefaultWriteTimeout,
 		},
-		BannerVersion: version.GetUserAgent(),
+		BannerVersion: version.GetServerVersion(),
 	}
 	if _, err = toml.NewDecoder(r).Decode(sc); err != nil {
 		return nil, err

pkg/serve/sshserver/config.go

@@ -44,7 +44,7 @@ func NewServerConfig(file string, expandEnv bool) (*ServerConfig, error) {
 		MaxTimeout: serve.Duration{
 			Duration: DefaultMaxTimeout,
 		},
-		BannerVersion: version.GetBannerVersion(),
+		BannerVersion: version.GetServerBannerVersion(),
 	}
 	if _, err = toml.NewDecoder(r).Decode(sc); err != nil {
 		return nil, err

pkg/serve/sshserver/server.go

@@ -8,6 +8,7 @@ import (
 	"database/sql"
 	"errors"
 	"fmt"
+	"strings"
 	"sync/atomic"
 
 	"github.com/antgroup/hugescm/pkg/serve"
@@ -176,7 +177,7 @@ func (s *Server) handleSession(e *Session) int {
 		e.WriteError("unsupport command '\x1b[31m%s\x1b[0m'", args[0])
 		return 1
 	}
-	logrus.Infof("new command: %s", e.RawCommand())
+	logrus.Infof("new command: %s user-agent: %s", e.RawCommand(), strings.TrimPrefix(e.ClientVersion, "SSH-2.0-"))
 	cmd, err := NewCommand(args[1:])
 	if err != nil {
 		e.WriteError("fatal: \x1b[31m%v\x1b[0m", err)

pkg/version/uname.go

@@ -1,5 +1,7 @@
 package version
 
+import "sync"
+
 type SystemInfo struct {
 	Name      string `json:"name"`
 	Node      string `json:"node"`
@@ -10,3 +12,7 @@ type SystemInfo struct {
 	OS        string `json:"os"`
 	Processor string `json:"processor"`
 }
+
+func Uname() (*SystemInfo, error) {
+	return sync.OnceValues(GetSystemInfo)()
+}

pkg/version/uname_test.go

@@ -2,6 +2,7 @@ package version
 
 import (
 	"encoding/json"
+	"fmt"
 	"os"
 	"testing"
 )
@@ -15,3 +16,19 @@ func TestGetSystemInfo(t *testing.T) {
 	enc.SetIndent("", " ")
 	_ = enc.Encode(info)
 }
+
+func TestUname(t *testing.T) {
+	u, err := Uname()
+	if err != nil {
+		return
+	}
+	enc := json.NewEncoder(os.Stderr)
+	enc.SetIndent("", " ")
+	_ = enc.Encode(u)
+}
+
+func TestGetUserAgent(t *testing.T) {
+	telemetry = "true"
+	version = "1.0.0"
+	fmt.Fprintf(os.Stderr, "%s\n%s\n", GetUserAgent(), GetBannerVersion())
+}

pkg/version/uname_windows.go

@@ -80,7 +80,7 @@ func GetSystemInfo() (*SystemInfo, error) {
 	computerName, _ := GetComputerName()
 	major, minor, build := windows.RtlGetNtVersionNumbers()
 	return &SystemInfo{
-		Name:      "WindowsNT",
+		Name:      "Windows",
 		Node:      computerName,
 		Release:   strconv.FormatUint(uint64(major), 10),
 		Version:   fmt.Sprintf("%d.%d.%d", major, minor, build),

pkg/version/verison.go

@@ -13,8 +13,17 @@ var (
 	version     string
 	buildCommit string
 	buildTime   string
+	telemetry   string
 )
 
+func telemetryOn() bool {
+	switch telemetry {
+	case "true", "yes", "on", "1":
+		return true
+	}
+	return false
+}
+
 // GetVersionString returns a standard version header
 func GetVersionString() string {
 	return fmt.Sprintf("%s %v (%s), built %v", filepath.Base(os.Args[0]), version, buildCommit, buildTime)
@@ -29,12 +38,36 @@ func GetVersion() string {
 	return version
 }
 
+func GetServerVersion() string {
+	return "Zeta/" + version
+}
+
+func GetTelemeryUserAgent() string {
+	if u, err := Uname(); err == nil {
+		return fmt.Sprintf("Zeta/%s (%s; %s; %s)", version, u.Name, u.Machine, u.Release)
+	}
+	return "Zeta/" + version
+}
+
 func GetUserAgent() string {
+	if telemetryOn() {
+		return GetTelemeryUserAgent()
+	}
 	return "Zeta/" + version
 }
 
 func GetBannerVersion() string {
-	return "Zeta-" + version
+	if telemetryOn() {
+		if u, err := Uname(); err == nil {
+			// SSH-protoversion-softwareversion SP comments CR LF
+			return fmt.Sprintf("ZETA-%s (%s; %s; %s)", version, u.Name, u.Machine, u.Release)
+		}
+	}
+	return "ZETA-" + version
+}
+
+func GetServerBannerVersion() string {
+	return "ZETA-" + version
 }
 
 // GetBuildTime returns the time at which the build took place