[telemetry]: initial commit

Author: Simon Emms

components/telemetry/BUILD.yaml

@@ -0,0 +1,19 @@
+packages:
+  - name: telemetry
+    type: go
+    srcs:
+      - go.mod
+      - go.sum
+      - "**/*.go"
+    env:
+      - CGO_ENABLED=0
+    config:
+      packaging: app
+      buildCommand: [
+          "go",
+          "build",
+          "-trimpath",
+          "-ldflags",
+          # todo(sje): change "commit-${__git_commit}" for the segment token
+          "-buildid= -w -s -X 'github.com/gitpod-io/gitpod/telemetry/cmd.segmentIOToken=commit-${__git_commit}'",
+        ]

components/telemetry/OWNERS

@@ -0,0 +1,9 @@
+
+options:
+  no_parent_owners: true
+
+approvers:
+  - engineering-self-hosted
+
+labels:
+  - "team: self-hosted"

components/telemetry/cmd/root.go

@@ -0,0 +1,21 @@
+// Copyright (c) 2022 Gitpod GmbH. All rights reserved.
+// Licensed under the GNU Affero General Public License (AGPL).
+// See License-AGPL.txt in the project root for license information.
+
+package cmd
+
+import "github.com/spf13/cobra"
+
+// rootCmd represents the base command when called without any subcommands
+var rootCmd = &cobra.Command{
+	Use:   "telemetry",
+	Short: "This service sends telemetry information back to Gitpod",
+}
+
+func Execute() {
+	cobra.CheckErr(rootCmd.Execute())
+}
+
+func init() {
+	rootCmd.AddCommand(runCmd)
+}

components/telemetry/cmd/run.go

@@ -0,0 +1,49 @@
+// Copyright (c) 2022 Gitpod GmbH. All rights reserved.
+// Licensed under the GNU Affero General Public License (AGPL).
+// See License-AGPL.txt in the project root for license information.
+
+package cmd
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/spf13/cobra"
+	"gopkg.in/segmentio/analytics-go.v3"
+)
+
+var segmentIOToken string
+
+var runCmd = &cobra.Command{
+	Use:   "run",
+	Short: "Sends telemetry data",
+	RunE: func(cmd *cobra.Command, args []string) (err error) {
+		if segmentIOToken == "" {
+			return fmt.Errorf("segmentIOToken build variable not set")
+		}
+
+		userId := os.Getenv("GITPOD_INSTALLATION_ID")
+		if userId == "" {
+			return fmt.Errorf("GITPOD_INSTALLATION_ID envvar not set")
+		}
+
+		versionId := os.Getenv("GITPOD_INSTALLATION_VERSION")
+		if versionId == "" {
+			return fmt.Errorf("GITPOD_INSTALLATION_VERSION envvar not set")
+		}
+
+		client, err := analytics.NewWithConfig(segmentIOToken, analytics.Config{})
+		defer func() {
+			err = client.Close()
+		}()
+
+		client.Enqueue(analytics.Track{
+			UserId: userId,
+			Event:  "Installation telemetry",
+			Properties: analytics.NewProperties().
+				Set("version", versionId),
+		})
+
+		return err
+	},
+}

components/telemetry/go.mod

@@ -0,0 +1,15 @@
+module github.com/gitpod-io/gitpod/telemetry
+
+go 1.17
+
+require (
+	github.com/spf13/cobra v1.3.0
+	gopkg.in/segmentio/analytics-go.v3 v3.1.0
+)
+
+require (
+	github.com/inconshreveable/mousetrap v1.0.0 // indirect
+	github.com/segmentio/backo-go v1.0.0 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
+	github.com/xtgo/uuid v0.0.0-20140804021211-a0b114877d4c // indirect
+)

components/telemetry/go.sum

@@ -0,0 +1,8 @@
+# Copyright (c) 2021 Gitpod GmbH. All rights reserved.
+# Licensed under the GNU Affero General Public License (AGPL).
+# See License-AGPL.txt in the project root for license information.
+
+FROM alpine:3.15
+COPY telemetry--app/telemetry telemetry--app/provenance-bundle.jsonl /app/
+ENTRYPOINT [ "/app/telemetry" ]
+CMD [ "help" ]

components/telemetry/leeway.Dockerfile

@@ -0,0 +1,11 @@
+// Copyright (c) 2022 Gitpod GmbH. All rights reserved.
+// Licensed under the GNU Affero General Public License (AGPL).
+// See License-AGPL.txt in the project root for license information.
+
+package main
+
+import "github.com/gitpod-io/gitpod/telemetry/cmd"
+
+func main() {
+	cmd.Execute()
+}