telemetry.go

// 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 telemetry

import (
	"crypto/sha256"
	"errors"
	"fmt"
	"io"
	"log"
	"log/slog"
	"math/rand"
	"net"
	"os"
	"runtime"
	"strings"
	"time"

	"github.com/gitpod-io/local-app/pkg/prettyprint"
	segment "github.com/segmentio/analytics-go/v3"
	"github.com/spf13/cobra"
	"golang.org/x/exp/slices"
)

var opts struct {
	Enabled  bool
	Identity string
	Version  string

	client segment.Client
}

// Init initializes the telemetry
func Init(enabled bool, identity, version string, logLevel slog.Level, host string) {
	opts.Enabled = enabled
	if !enabled {
		return
	}

	opts.Version = version
	opts.Identity = identity

	var logger segment.Logger
	if logLevel == slog.LevelDebug {
		logger = segment.StdLogger(log.New(os.Stderr, "telemetry ", log.LstdFlags))
	} else {
		// we don't want to log anything
		log := log.New(os.Stderr, "telemetry ", log.LstdFlags)
		log.SetOutput(io.Discard)
		logger = segment.StdLogger(log)
	}
	opts.client, _ = segment.NewWithConfig("untrusted-dummy-key", segment.Config{
		Logger:   logger,
		Endpoint: host + "/analytics",
	})
}

// DoNotTrack returns true if the user opted out of telemetry
// Implements the https://consoledonottrack.com/ proposal.
func DoNotTrack() bool {
	return os.Getenv("DO_NOT_TRACK") == "1"
}

// GenerateIdentity generates an identity using the machine's MAC address or a random value
func GenerateIdentity() string {
	var addr string
	interfaces, err := net.Interfaces()
	if err == nil {
		for _, i := range interfaces {
			addr = i.HardwareAddr.String()
			if i.Flags&net.FlagUp != 0 && addr != "" {
				break
			}
		}
	}
	if addr == "" {
		letters := []rune("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890")
		b := make([]rune, 32)
		for i := range b {
			b[i] = letters[rand.Intn(len(letters))]
		}
		addr = string(b)
	}
	return fmt.Sprintf("%x", sha256.Sum256([]byte(addr)))
}

func Close() {
	if opts.client != nil {
		opts.client.Close()
	}
}

// Identity returns the identity
func Identity() string {
	return opts.Identity
}

// Enabled returns true if the telemetry is enabled
func Enabled() bool {
	return opts.Enabled && opts.Identity != "" && opts.client != nil
}

func track(event string, props segment.Properties) {
	if !Enabled() {
		return
	}
	slog.Debug("tracking telemetry", "props", props, "event", event, "identity", opts.Identity)

	err := opts.client.Enqueue(segment.Track{
		AnonymousId: opts.Identity,
		Event:       event,
		Timestamp:   time.Now(),
		Properties:  props,
	})
	if err != nil {
		slog.Debug("failed to track telemetry", "err", err)
	}
}

// RecordCommand records the execution of a CLI command
func RecordCommand(cmd *cobra.Command) {
	var command []string
	for c := cmd; c != nil; c = c.Parent() {
		command = append(command, c.Name())
	}
	slices.Reverse(command)

	track("gitpodcli_command", defaultProperties().
		Set("command", strings.Join(command, " ")))
}

// RecordError records an exception that occurred
func RecordError(err error) {
	var exception *prettyprint.ErrSystemException
	if !errors.As(err, &exception) {
		return
	}

	track("gitpodcli_exception", defaultProperties().
		Set("context", exception.Context).
		Set("error", exception.Err.Error()))
}

func defaultProperties() segment.Properties {
	return segment.NewProperties().
		Set("goos", runtime.GOOS).
		Set("goarch", runtime.GOARCH).
		Set("version", opts.Version)
}