Add light optional telemetry (#19)

* Add light telemetry

* Make sure old telemetry config is preserved

Author: ivpusic

.github/workflows/release.yml

@@ -30,3 +30,4 @@ jobs:
           args: release --clean
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          AMPLITUDE_KEY: ${{ secrets.AMPLITUDE_KEY }}

.goreleaser.yml

@@ -2,6 +2,9 @@ version: 2
 
 project_name: dune-cli
 
+env:
+  - AMPLITUDE_KEY={{ if index .Env "AMPLITUDE_KEY" }}{{ .Env.AMPLITUDE_KEY }}{{ end }}
+
 before:
   hooks:
     - go mod tidy
@@ -16,6 +19,7 @@ builds:
       - -X main.version={{.Version}}
       - -X main.commit={{.Commit}}
       - -X main.date={{.Date}}
+      - -X main.amplitudeKey={{ .Env.AMPLITUDE_KEY }}
     goos:
       - linux
       - darwin

authconfig/authconfig.go

@@ -12,7 +12,8 @@ import (
 
 // Config holds the persisted CLI configuration.
 type Config struct {
-	APIKey string `yaml:"api_key"`
+	APIKey    string `yaml:"api_key"`
+	Telemetry *bool  `yaml:"telemetry,omitempty"`
 }
 
 // configDirFunc allows tests to override the config directory.

cli/root.go

@@ -5,16 +5,19 @@ import (
 	"fmt"
 	"os"
 	"strings"
+	"time"
 
 	"github.com/charmbracelet/fang"
 	"github.com/duneanalytics/cli/authconfig"
 	"github.com/duneanalytics/cli/cmd/auth"
+	duneconfig "github.com/duneanalytics/cli/cmd/config"
 	"github.com/duneanalytics/cli/cmd/dataset"
 	"github.com/duneanalytics/cli/cmd/docs"
 	"github.com/duneanalytics/cli/cmd/execution"
 	"github.com/duneanalytics/cli/cmd/query"
 	"github.com/duneanalytics/cli/cmd/usage"
 	"github.com/duneanalytics/cli/cmdutil"
+	"github.com/duneanalytics/cli/tracking"
 	"github.com/duneanalytics/duneapi-client-go/config"
 	"github.com/duneanalytics/duneapi-client-go/dune"
 	"github.com/spf13/cobra"
@@ -37,6 +40,8 @@ var rootCmd = &cobra.Command{
 		"Authenticate with an API key via --api-key, the DUNE_API_KEY environment variable,\n" +
 		"or by running `dune auth`.",
 	PersistentPreRunE: func(cmd *cobra.Command, _ []string) error {
+		cmdutil.SetStartTime(cmd, time.Now())
+
 		if cmd.Annotations["skipAuth"] == "true" {
 			return nil
 		}
@@ -68,13 +73,32 @@ var rootCmd = &cobra.Command{
 
 		client := dune.NewDuneClient(env)
 		cmdutil.SetClient(cmd, client)
+
+		return nil
+	},
+	PersistentPostRunE: func(cmd *cobra.Command, _ []string) error {
+		tr := cmdutil.TrackerFromCmd(cmd)
+		if tr == nil {
+			return nil
+		}
+		start := cmdutil.StartTimeFromCmd(cmd)
+		durationMs := time.Since(start).Milliseconds()
+
+		commandPath := cmd.CommandPath()
+		// Strip the root command name for cleaner paths.
+		if parts := strings.SplitN(commandPath, " ", 2); len(parts) == 2 {
+			commandPath = parts[1]
+		}
+
+		tr.Track(commandPath, tracking.StatusSuccess, "", durationMs)
 		return nil
 	},
 }
 
 func init() {
 	rootCmd.PersistentFlags().StringVar(&apiKeyFlag, "api-key", "", "Dune API key (overrides DUNE_API_KEY env var)")
 	rootCmd.AddCommand(auth.NewAuthCmd())
+	rootCmd.AddCommand(duneconfig.NewConfigCmd())
 	rootCmd.AddCommand(dataset.NewDatasetCmd())
 	rootCmd.AddCommand(docs.NewDocsCmd())
 	rootCmd.AddCommand(query.NewQueryCmd())
@@ -83,12 +107,27 @@ func init() {
 }
 
 // Execute runs the root command via Fang.
-func Execute(version, commit, date string) {
+func Execute(version, commit, date, amplitudeKey string) {
 	versionStr := fmt.Sprintf("%s (commit: %s, built: %s)", version, commit, date)
 
-	if err := fang.Execute(context.Background(), rootCmd,
+	telemetryEnabled := duneconfig.IsTelemetryEnabled()
+	configDir, _ := authconfig.Dir()
+	tracker := tracking.New(tracking.Config{
+		AmplitudeKey: amplitudeKey,
+		CLIVersion:   version,
+		ConfigDir:    configDir,
+		Enabled:      telemetryEnabled,
+	})
+	defer tracker.Shutdown()
+
+	rootCmd.SetContext(context.Background())
+	cmdutil.SetTracker(rootCmd, tracker)
+
+	if err := fang.Execute(rootCmd.Context(), rootCmd,
 		fang.WithVersion(versionStr),
 	); err != nil {
+		tracker.Track("unknown", tracking.StatusError, err.Error(), 0)
+
 		fmt.Fprintln(os.Stderr, err)
 		os.Exit(1)
 	}

cmd/auth/auth.go

@@ -40,7 +40,15 @@ func runAuth(cmd *cobra.Command, _ []string) error {
 		return fmt.Errorf("no API key provided")
 	}
 
-	if err := authconfig.Save(&authconfig.Config{APIKey: key}); err != nil {
+	cfg, err := authconfig.Load()
+	if err != nil {
+		return fmt.Errorf("loading existing config: %w", err)
+	}
+	if cfg == nil {
+		cfg = &authconfig.Config{}
+	}
+	cfg.APIKey = key
+	if err := authconfig.Save(cfg); err != nil {
 		return fmt.Errorf("saving config: %w", err)
 	}
 

cmd/config/config.go

@@ -0,0 +1,13 @@
+package config
+
+import "github.com/spf13/cobra"
+
+func NewConfigCmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:         "config",
+		Short:       "Manage CLI configuration",
+		Annotations: map[string]string{"skipAuth": "true"},
+	}
+	cmd.AddCommand(newTelemetryCmd())
+	return cmd
+}

cmd/config/telemetry.go

@@ -0,0 +1,99 @@
+package config
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/duneanalytics/cli/authconfig"
+	"github.com/spf13/cobra"
+)
+
+func newTelemetryCmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "telemetry",
+		Short: "Manage anonymous usage telemetry",
+	}
+	cmd.AddCommand(
+		newTelemetryEnableCmd(),
+		newTelemetryDisableCmd(),
+		newTelemetryStatusCmd(),
+	)
+	return cmd
+}
+
+func newTelemetryEnableCmd() *cobra.Command {
+	return &cobra.Command{
+		Use:         "enable",
+		Short:       "Enable anonymous usage telemetry",
+		Annotations: map[string]string{"skipAuth": "true"},
+		RunE: func(cmd *cobra.Command, _ []string) error {
+			return setTelemetry(cmd, true)
+		},
+	}
+}
+
+func newTelemetryDisableCmd() *cobra.Command {
+	return &cobra.Command{
+		Use:         "disable",
+		Short:       "Disable anonymous usage telemetry",
+		Annotations: map[string]string{"skipAuth": "true"},
+		RunE: func(cmd *cobra.Command, _ []string) error {
+			return setTelemetry(cmd, false)
+		},
+	}
+}
+
+func newTelemetryStatusCmd() *cobra.Command {
+	return &cobra.Command{
+		Use:         "status",
+		Short:       "Show current telemetry status",
+		Annotations: map[string]string{"skipAuth": "true"},
+		RunE: func(cmd *cobra.Command, _ []string) error {
+			enabled := IsTelemetryEnabled()
+			if enabled {
+				fmt.Fprintln(cmd.OutOrStdout(), "Telemetry is enabled.")
+			} else {
+				fmt.Fprintln(cmd.OutOrStdout(), "Telemetry is disabled.")
+			}
+			return nil
+		},
+	}
+}
+
+func setTelemetry(cmd *cobra.Command, enabled bool) error {
+	cfg, err := authconfig.Load()
+	if err != nil {
+		return fmt.Errorf("loading config: %w", err)
+	}
+	if cfg == nil {
+		cfg = &authconfig.Config{}
+	}
+	cfg.Telemetry = &enabled
+	if err := authconfig.Save(cfg); err != nil {
+		return fmt.Errorf("saving config: %w", err)
+	}
+	if enabled {
+		fmt.Fprintln(cmd.OutOrStdout(), "Telemetry enabled.")
+	} else {
+		fmt.Fprintln(cmd.OutOrStdout(), "Telemetry disabled.")
+	}
+	return nil
+}
+
+// IsTelemetryEnabled checks env vars and config to determine if telemetry is on.
+func IsTelemetryEnabled() bool {
+	if os.Getenv("DUNE_NO_TELEMETRY") == "1" {
+		return false
+	}
+	if os.Getenv("CI") != "" {
+		return false
+	}
+	cfg, err := authconfig.Load()
+	if err != nil || cfg == nil {
+		return true // default: enabled
+	}
+	if cfg.Telemetry == nil {
+		return true // nil = default opt-in
+	}
+	return *cfg.Telemetry
+}

cmd/main.go

@@ -9,14 +9,15 @@ import (
 
 // Set by GoReleaser or Makefile via ldflags.
 var (
-	version = ""
-	commit  = ""
-	date    = ""
+	version      = ""
+	commit       = ""
+	date         = ""
+	amplitudeKey = ""
 )
 
 func main() {
 	resolveVersion()
-	cli.Execute(version, commit, date)
+	cli.Execute(version, commit, date, amplitudeKey)
 }
 
 // resolveVersion fills in version/commit/date from Go build info

cmdutil/client.go

@@ -2,12 +2,16 @@ package cmdutil
 
 import (
 	"context"
+	"time"
 
+	"github.com/duneanalytics/cli/tracking"
 	"github.com/duneanalytics/duneapi-client-go/dune"
 	"github.com/spf13/cobra"
 )
 
 type clientKey struct{}
+type trackerKey struct{}
+type startTimeKey struct{}
 
 // SetClient stores a DuneClient in the command's context.
 func SetClient(cmd *cobra.Command, client dune.DuneClient) {
@@ -22,3 +26,33 @@ func SetClient(cmd *cobra.Command, client dune.DuneClient) {
 func ClientFromCmd(cmd *cobra.Command) dune.DuneClient {
 	return cmd.Context().Value(clientKey{}).(dune.DuneClient)
 }
+
+// SetTracker stores a Tracker in the command's context.
+func SetTracker(cmd *cobra.Command, t *tracking.Tracker) {
+	ctx := cmd.Context()
+	if ctx == nil {
+		ctx = context.Background()
+	}
+	cmd.SetContext(context.WithValue(ctx, trackerKey{}, t))
+}
+
+// TrackerFromCmd extracts the Tracker stored in the command's context.
+func TrackerFromCmd(cmd *cobra.Command) *tracking.Tracker {
+	v, _ := cmd.Context().Value(trackerKey{}).(*tracking.Tracker)
+	return v
+}
+
+// SetStartTime stores the command start time in the command's context.
+func SetStartTime(cmd *cobra.Command, t time.Time) {
+	ctx := cmd.Context()
+	if ctx == nil {
+		ctx = context.Background()
+	}
+	cmd.SetContext(context.WithValue(ctx, startTimeKey{}, t))
+}
+
+// StartTimeFromCmd extracts the command start time from the command's context.
+func StartTimeFromCmd(cmd *cobra.Command) time.Time {
+	v, _ := cmd.Context().Value(startTimeKey{}).(time.Time)
+	return v
+}

go.mod

@@ -3,6 +3,7 @@ module github.com/duneanalytics/cli
 go 1.25.6
 
 require (
+	github.com/amplitude/analytics-go v1.3.0
 	github.com/charmbracelet/fang v0.4.4
 	github.com/duneanalytics/duneapi-client-go v0.4.3
 	github.com/modelcontextprotocol/go-sdk v1.4.0
@@ -25,6 +26,7 @@ require (
 	github.com/clipperhouse/uax29/v2 v2.3.0 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/google/jsonschema-go v0.4.2 // indirect
+	github.com/google/uuid v1.3.0 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/lucasb-eyer/go-colorful v1.3.0 // indirect
 	github.com/mattn/go-runewidth v0.0.19 // indirect