Implement configuration via Viper

Author: Roberto Sora

cli/daemon/daemon.go

@@ -56,8 +56,10 @@ var daemonize bool
 
 func runDaemonCommand(cmd *cobra.Command, args []string) {
 
-	telemetry.Activate("daemon")
-	defer telemetry.Engine.Flush()
+	if viper.GetBool("telemetry.enabled") {
+		telemetry.Activate("daemon", viper.GetString("installation.id"))
+		defer telemetry.Engine.Flush()
+	}
 
 	port := viper.GetString("daemon.port")
 	s := grpc.NewServer()
@@ -91,7 +93,6 @@ func runDaemonCommand(cmd *cobra.Command, args []string) {
 		go func() {
 			// stdin is closed when the controlling parent process ends
 			_, _ = io.Copy(ioutil.Discard, os.Stdin)
-			telemetry.Engine.Flush()
 			os.Exit(0)
 		}()
 	}

commands/compile/compile.go

@@ -47,7 +47,7 @@ func Compile(ctx context.Context, req *rpc.CompileReq, outStream, errStream io.W
 
 	tags := map[string]string{
 		"fqbn":            req.Fqbn,
-		"sketchPath":      req.SketchPath,
+		"sketchPath":      telemetry.SanitizeSketchPath(req.SketchPath),
 		"showProperties":  strconv.FormatBool(req.ShowProperties),
 		"preprocess":      strconv.FormatBool(req.Preprocess),
 		"buildProperties": strings.Join(req.BuildProperties, ","),

configuration/defaults.go

@@ -18,6 +18,7 @@ package configuration
 import (
 	"path/filepath"
 
+	"github.com/gofrs/uuid"
 	"github.com/spf13/viper"
 )
 
@@ -35,4 +36,17 @@ func setDefaults(dataDir, userDir string) {
 
 	// daemon settings
 	viper.SetDefault("daemon.port", "50051")
+
+	//telemetry settings
+	viper.SetDefault("telemetry.enabled", true)
+	viper.SetDefault("telemetry.addr", ":2112")
+	viper.SetDefault("telemetry.pattern", "/metrics")
+
+	//Installation ID
+	// FIXME: how should I treat this error?
+	installationID, _ := uuid.NewV4()
+	installationSecret, _ := uuid.NewV4()
+	viper.SetDefault("installation.id", installationID.String())
+	viper.SetDefault("installation.secret", installationSecret.String())
+
 }

go.mod

@@ -17,6 +17,7 @@ require (
 	github.com/fluxio/multierror v0.0.0-20160419044231-9c68d39025e5 // indirect
 	github.com/fsnotify/fsnotify v1.4.7
 	github.com/go-errors/errors v1.0.1
+	github.com/gofrs/uuid v3.2.0+incompatible
 	github.com/golang/protobuf v1.3.2
 	github.com/h2non/filetype v1.0.8 // indirect
 	github.com/juju/errors v0.0.0-20181118221551-089d3ea4e4d5 // indirect

go.sum

@@ -41,6 +41,8 @@ github.com/fsnotify/fsnotify v1.4.7 h1:IXs+QLmnXW2CcXuY+8Mzv/fWEsPGWxqefPtCP5CnV
 github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
 github.com/go-errors/errors v1.0.1 h1:LUHzmkK3GUKUrL/1gfBUxAHzcev3apQlezX/+O7ma6w=
 github.com/go-errors/errors v1.0.1/go.mod h1:f4zRHt4oKfwPJE5k8C9vpYG+aDHdBFUsgrm6/TyX73Q=
+github.com/gofrs/uuid v3.2.0+incompatible h1:y12jRkkFxsd7GpqdSZ+/KCs/fJbqpEXSGd4+jfEaewE=
+github.com/gofrs/uuid v3.2.0+incompatible/go.mod h1:b2aQJv3Z4Fp6yNu3cdSllBxTCLRxnplIgP/c0N/04lM=
 github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b h1:VKtxabqXZkF25pY9ekfRL6a582T4P37/31XEstQ5p58=
 github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q=
 github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A=

telemetry/telemetry.go

@@ -1,36 +1,52 @@
 package telemetry
 
 import (
+	"crypto/hmac"
+	"crypto/sha256"
+	"encoding/hex"
 	"net/http"
+	"path/filepath"
 
 	"github.com/segmentio/stats/v4"
 	"github.com/segmentio/stats/v4/prometheus"
 	"github.com/sirupsen/logrus"
+	"github.com/spf13/viper"
 )
 
 // Engine is the engine used by global helper functions for this module.
 var Engine = stats.DefaultEngine
 
-var serverAddr = ":2112"
-var serverPattern = "/metrics"
-
-//Activate configure and starts the telemetry server exposing a Prometheus resource
-func Activate(metricPrefix string) {
+// Activate configure and starts the telemetry server exposing a Prometheus resource
+func Activate(metricPrefix, installationID string) {
 	// Configure telemetry engine
 	// Create a Prometheus default handler
 	ph := prometheus.DefaultHandler
-	// Replace the default stats engine with an engine that prepends the "daemon" prefix to all metrics
-	Engine = stats.WithPrefix(metricPrefix)
+	// Create a new stats engine with an engine that prepends the "daemon" prefix to all metrics
+	// and includes the installationID as a tag
+	Engine = stats.WithPrefix(metricPrefix, stats.T("installationID", installationID))
 	// Register the handler so it receives metrics from the default engine.
 	Engine.Register(ph)
-	// Flush the default stats engine on return to ensure all buffered
-	// metrics are sent to the server.
-	defer Engine.Flush()
-	// move everything inside commands and search for setting up a common prefix for all metrics sent!
+
+	// Configure using viper settings
+	serverAddr := viper.GetString("telemetry.addr")
+	serverPattern := viper.GetString("telemetry.pattern")
 	logrus.Infof("Setting up Prometheus telemetry on %s%s", serverAddr, serverPattern)
 	go func() {
 		http.Handle(serverPattern, ph)
 		logrus.Error(http.ListenAndServe(serverAddr, nil))
 	}()
 
 }
+
+// SanitizeSketchPath uses config generated UUID (installation.secret) as an HMAC secret to sanitize and anonymize the sketch
+// name maintaining it distinguishable from a different sketch from the same Installation
+func SanitizeSketchPath(sketchPath string) string {
+	installationSecret := viper.GetString("installation.secret")
+	sketchName := filepath.Base(sketchPath)
+	// Create a new HMAC by defining the hash type and the key (as byte array)
+	h := hmac.New(sha256.New, []byte(installationSecret))
+	// Write Data to it
+	h.Write([]byte(sketchName))
+	// Get result and encode as hexadecimal string
+	return hex.EncodeToString(h.Sum(nil))
+}