[#3668] Store rack install & rack update telemetry data (V2)

### What is the feature/fix? ![Screenshot 2023-04-25 at 11 14 26](https://user-images.githubusercontent.com/759623/234304722-24209b72-d129-45bd-8d1e-0756b6554021.png) ### Add screenshot or video (optional) Doc: https://convox602-my.sharepoint.com/:w:/g/personal/yuri_adams_convox_com/ERKCC87MHOxLi6_3F8PqWqIBOWecg2nEg06tIbl9NA6ujQ?e=8bW5AX ### Does it has a breaking change? No
convox · May 3, 2023 · 1b1a540 · 1b1a540
1 parent ae6e5f5
commit 1b1a540
Show file tree

Hide file tree

Showing 3 changed files with 137 additions and 2 deletions.
diff --git a/provider/aws/formation/rack.json b/provider/aws/formation/rack.json
@@ -910,6 +910,12 @@
       "Description": "VPC CIDR Block",
       "Type": "String"
     },
+    "Telemetry": {
+      "AllowedValues": [ "true", "false" ],
+      "Default": "false",
+      "Description": "Activate telemetry data tracking.",
+      "Type": "String"
+    },
     "Tenancy": {
       "Type": "String",
       "Description": "Dedicated Hardware",
@@ -3220,6 +3226,7 @@
               "rack.SyslogDestination": { "Ref": "SyslogDestination" },
               "rack.SyslogFormat": { "Ref": "SyslogFormat" },
               "rack.Version": { "Ref": "Version" },
+              "rack.Telemetry": { "Ref": "Telemetry" },
               "rack.Vpc": { "Fn::If": [ "BlankExistingVpc",
                 { "Ref": "Vpc" },
                 { "Ref": "ExistingVpc" }

diff --git a/provider/aws/telemetry.go b/provider/aws/telemetry.go
@@ -0,0 +1,104 @@
+package aws
+
+import (
+	"crypto/sha256"
+	"encoding/hex"
+	"strings"
+)
+
+var (
+	skipParams = strings.Join([]string{
+		"DefaultAmi",
+		"DefaultAmiArm",
+		"Telemetry",
+	}, ",")
+
+	redactedParams = strings.Join([]string{
+		"Ami",
+		"ApiCount",
+		"ApiCpu",
+		"ApiMonitorMemory",
+		"ApiRouter",
+		"ApiWebMemory",
+		"Autoscale",
+		"AvailabilityZones",
+		"BuildCpu",
+		"BuildImage",
+		"BuildInstance",
+		"BuildInstancePolicy",
+		"BuildMemory",
+		"BuildVolumeSize",
+		"ClientId",
+		"Development",
+		"EcsPollInterval",
+		"EncryptEbs",
+		"Encryption",
+		"ExistingVpc",
+		"HighAvailability",
+		"HttpProxy",
+		"ImagePullBehavior",
+		"IMDSHttpTokens",
+		"Internal",
+		"InternalOnly",
+		"InternalSuffix",
+		"InstanceBootCommand",
+		"InstanceRunCommand",
+		"InstanceType",
+		"InstanceUpdateBatchSize",
+		"InstancePolicy",
+		"InstanceSecurityGroup",
+		"BuildInstanceSecurityGroup",
+		"InternetGateway",
+		"Key",
+		"LogBucket",
+		"LogDriver",
+		"LogRetention",
+		"Password",
+		"Private",
+		"PrivateApi",
+		"PrivateApiSecurityGroup",
+		"PrivateBuild",
+		"RouterInternalSecurityGroup",
+		"RouterSecurityGroup",
+		"ScheduleRackScaleDown",
+		"ScheduleRackScaleUp",
+		"SpotInstanceBid",
+		"SslPolicy",
+		"Subnet0CIDR",
+		"Subnet1CIDR",
+		"Subnet2CIDR",
+		"SubnetPrivate0CIDR",
+		"SubnetPrivate1CIDR",
+		"SubnetPrivate2CIDR",
+		"SwapSize",
+		"SyslogDestination",
+		"SyslogFormat",
+		"Version",
+		"VPCCIDR",
+		"Tenancy",
+		"WhiteList",
+	}, ",")
+)
+
+func (p *Provider) RackParamsToSync(params map[string]string) map[string]string {
+	toSync := make(map[string]string)
+	for k, v := range params {
+		if strings.Contains(skipParams, k) {
+			continue
+		}
+
+		if strings.Contains(redactedParams, k) {
+			v = hashParamValue(v)
+		}
+
+		toSync[k] = v
+	}
+
+	return toSync
+}
+
+func hashParamValue(value string) string {
+	hasher := sha256.New()
+	hasher.Write([]byte(value))
+	return hex.EncodeToString(hasher.Sum(nil))
+}
diff --git a/provider/aws/workers_heartbeat.go b/provider/aws/workers_heartbeat.go
@@ -3,6 +3,7 @@ package aws
 import (
 	"time"
 
+	"github.com/convox/logger"
 	"github.com/convox/rack/pkg/helpers"
 )
 
@@ -11,17 +12,21 @@ func (p *Provider) workerHeartbeat() {
 }
 
 func (p *Provider) heartbeat() {
+	var log = logger.New("ns=workers.heartbeat")
+
 	s, err := p.SystemGet()
 	if err != nil {
+		log.Error(err)
 		return
 	}
 
 	as, err := p.AppList()
 	if err != nil {
+		log.Error(err)
 		return
 	}
 
-	p.Metrics.Post("heartbeat", map[string]interface{}{
+	ms := map[string]interface{}{
 		"id":             coalesces(p.ClientId, p.StackId),
 		"app_count":      len(as),
 		"instance_count": s.Count,
@@ -30,5 +35,24 @@ func (p *Provider) heartbeat() {
 		"rack_id":        p.StackId,
 		"region":         p.Region,
 		"version":        s.Version,
-	})
+	}
+
+	telemetryOn := true
+	_, ok := s.Parameters["Telemetry"]
+	if ok {
+		if s.Parameters["Telemetry"] != "false" {
+			telemetryOn = false
+		}
+	}
+
+	if telemetryOn {
+		params := p.RackParamsToSync(s.Parameters)
+		log.Logf("Rack Params: %v", params)
+		ms["rack_params"] = params
+	}
+
+	if err := p.Metrics.Post("heartbeat", ms); err != nil {
+		log.Error(err)
+		return
+	}
 }