feat: ✨ telemetry added

Author: AkashRajpurohit

.claude/settings.local.json

@@ -0,0 +1,7 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(gh api:*)"
+    ]
+  }
+}

cmd/root.go

@@ -12,6 +12,7 @@ import (
 	"github.com/AkashRajpurohit/git-sync/pkg/gitlab"
 	"github.com/AkashRajpurohit/git-sync/pkg/logger"
 	"github.com/AkashRajpurohit/git-sync/pkg/raw"
+	"github.com/AkashRajpurohit/git-sync/pkg/telemetry"
 	ch "github.com/robfig/cron/v3"
 	"github.com/spf13/cobra"
 )
@@ -77,6 +78,9 @@ var rootCmd = &cobra.Command{
 			logger.Fatalf("Error validating config: %s", err)
 		}
 
+		telemetry.Init(cfg.Telemetry)
+		defer telemetry.Close()
+
 		// Create backup directory if it doesn't exist
 		os.MkdirAll(cfg.BackupDir, os.ModePerm)
 

go.mod

@@ -5,7 +5,9 @@ go 1.24.5
 require (
 	codeberg.org/mvdkleijn/forgejo-sdk/forgejo v1.2.0
 	github.com/google/go-github/v82 v82.0.0
+	github.com/google/uuid v1.6.0
 	github.com/ktrysmt/go-bitbucket v0.9.86
+	github.com/posthog/posthog-go v1.10.0
 	github.com/robfig/cron/v3 v3.0.1
 	github.com/spf13/cobra v1.10.2
 	github.com/spf13/viper v1.21.0
@@ -20,10 +22,12 @@ require (
 	github.com/fsnotify/fsnotify v1.9.0 // indirect
 	github.com/go-fed/httpsig v1.1.0 // indirect
 	github.com/go-viper/mapstructure/v2 v2.4.0 // indirect
+	github.com/goccy/go-json v0.10.5 // indirect
 	github.com/google/go-querystring v1.2.0 // indirect
 	github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
 	github.com/hashicorp/go-retryablehttp v0.7.7 // indirect
 	github.com/hashicorp/go-version v1.7.0 // indirect
+	github.com/hashicorp/golang-lru/v2 v2.0.7 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/mitchellh/mapstructure v1.5.0 // indirect
 	github.com/pelletier/go-toml/v2 v2.2.4 // indirect

go.sum

@@ -17,13 +17,17 @@ github.com/go-fed/httpsig v1.1.0 h1:9M+hb0jkEICD8/cAiNqEB66R87tTINszBRTjwjQzWcI=
 github.com/go-fed/httpsig v1.1.0/go.mod h1:RCMrTZvN1bJYtofsG4rd5NaO5obxQ5xBkdiS7xsT7bM=
 github.com/go-viper/mapstructure/v2 v2.4.0 h1:EBsztssimR/CONLSZZ04E8qAkxNYq4Qp9LvH92wZUgs=
 github.com/go-viper/mapstructure/v2 v2.4.0/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM=
+github.com/goccy/go-json v0.10.5 h1:Fq85nIqj+gXn/S5ahsiTlK3TmC85qgirsdTP/+DeaC4=
+github.com/goccy/go-json v0.10.5/go.mod h1:oq7eo15ShAhp70Anwd5lgX2pLfOS3QCiwU/PULtXL6M=
 github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
 github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
 github.com/google/go-github/v82 v82.0.0 h1:OH09ESON2QwKCUVMYmMcVu1IFKFoaZHwqYaUtr/MVfk=
 github.com/google/go-github/v82 v82.0.0/go.mod h1:hQ6Xo0VKfL8RZ7z1hSfB4fvISg0QqHOqe9BP0qo+WvM=
 github.com/google/go-querystring v1.2.0 h1:yhqkPbu2/OH+V9BfpCVPZkNmUXhb2gBxJArfhIxNtP0=
 github.com/google/go-querystring v1.2.0/go.mod h1:8IFJqpSRITyJ8QhQ13bmbeMBDfmeEJZD5A0egEOmkqU=
+github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
+github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/hashicorp/go-cleanhttp v0.5.2 h1:035FKYIWjmULyFRBKPs8TBQoi0x6d9G4xc9neXJWAZQ=
 github.com/hashicorp/go-cleanhttp v0.5.2/go.mod h1:kO/YDlP8L1346E6Sodw+PrpBSV4/SoxCXGY6BqNFT48=
 github.com/hashicorp/go-hclog v1.6.3 h1:Qr2kF+eVWjTiYmU7Y31tYlP1h0q/X3Nl3tPGdaB11/k=
@@ -32,6 +36,8 @@ github.com/hashicorp/go-retryablehttp v0.7.7 h1:C8hUCYzor8PIfXHa4UrZkU4VvK8o9ISH
 github.com/hashicorp/go-retryablehttp v0.7.7/go.mod h1:pkQpWZeYWskR+D1tR2O5OcBFOxfA7DoAO6xtkuQnHTk=
 github.com/hashicorp/go-version v1.7.0 h1:5tqGy27NaOTB8yJKUZELlFAS/LTKJkrmONwQKeRZfjY=
 github.com/hashicorp/go-version v1.7.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA=
+github.com/hashicorp/golang-lru/v2 v2.0.7 h1:a+bsQ5rvGLjzHuww6tVxozPZFVghXaHOwFs4luLUK2k=
+github.com/hashicorp/golang-lru/v2 v2.0.7/go.mod h1:QeFd9opnmA6QUJc5vARoKUSoFhyfM2/ZepoAG6RGpeM=
 github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
 github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
 github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
@@ -50,6 +56,8 @@ github.com/pelletier/go-toml/v2 v2.2.4 h1:mye9XuhQ6gvn5h28+VilKrrPoQVanw5PMw/TB0
 github.com/pelletier/go-toml/v2 v2.2.4/go.mod h1:2gIqNv+qfxSVS7cM2xJQKtLSTLUE9V8t9Stt+h56mCY=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/posthog/posthog-go v1.10.0 h1:wfoy7Jfb4LigCoHYyMZoiJmmEoCLOkSaYfDxM/NtCqY=
+github.com/posthog/posthog-go v1.10.0/go.mod h1:wB3/9Q7d9gGb1P/yf/Wri9VBlbP8oA8z++prRzL5OcY=
 github.com/robfig/cron/v3 v3.0.1 h1:WdRxkvbJztn8LMz/QEvLN5sBU+xKpSqwwUO1Pjr4qDs=
 github.com/robfig/cron/v3 v3.0.1/go.mod h1:eQICP3HwyT7UooqI/z+Ov+PtYAWygg1TEWWzGIFLtro=
 github.com/rogpeppe/go-internal v1.9.0 h1:73kH8U+JUqXU8lRuOHeVHaa/SZPifC7BkcraZVejAe8=

pkg/config/config.go

@@ -42,6 +42,10 @@ type GotifyConfig struct {
 	Priority int    `mapstructure:"priority"`
 }
 
+type TelemetryConfig struct {
+	Enabled bool `mapstructure:"enabled"`
+}
+
 type Config struct {
 	Username      string             `mapstructure:"username"`
 	Token         string             `mapstructure:"token"`  // Deprecated: Use Tokens instead
@@ -63,6 +67,7 @@ type Config struct {
 	Concurrency   int                `mapstructure:"concurrency"`
 	Retry         RetryConfig        `mapstructure:"retry"`
 	Notification  NotificationConfig `mapstructure:"notification"`
+	Telemetry     TelemetryConfig    `mapstructure:"telemetry"`
 }
 
 func expandPath(path string) string {
@@ -73,6 +78,10 @@ func expandPath(path string) string {
 	return path
 }
 
+func GetDefaultConfigDir() string {
+	return filepath.Join(os.Getenv("HOME"), ".config", "git-sync")
+}
+
 func GetConfigFile(cfgFile string) string {
 	if cfgFile != "" {
 		logger.Debug("Using config file: ", cfgFile)
@@ -113,6 +122,8 @@ func LoadConfig(cfgFile string) (Config, error) {
 	viper.SetConfigFile(configFile)
 	viper.SetConfigType("yaml")
 
+	viper.SetDefault("telemetry.enabled", true)
+
 	if err := viper.ReadInConfig(); err != nil {
 		return config, err
 	}
@@ -150,6 +161,7 @@ func SaveConfig(config Config, cfgFile string) error {
 	viper.Set("concurrency", config.Concurrency)
 	viper.Set("retry", config.Retry)
 	viper.Set("notification", config.Notification)
+	viper.Set("telemetry", config.Telemetry)
 
 	return viper.WriteConfig()
 }
@@ -180,6 +192,9 @@ func GetInitialConfig() Config {
 			Count: 3,
 			Delay: 5,
 		},
+		Telemetry: TelemetryConfig{
+			Enabled: true,
+		},
 		Notification: NotificationConfig{
 			Enabled:      false,
 			OnlyFailures: true,

pkg/sync/stats.go

@@ -2,11 +2,14 @@ package sync
 
 import (
 	"fmt"
+	"runtime"
 	"sync"
 
 	"github.com/AkashRajpurohit/git-sync/pkg/config"
 	"github.com/AkashRajpurohit/git-sync/pkg/logger"
 	"github.com/AkashRajpurohit/git-sync/pkg/notification"
+	"github.com/AkashRajpurohit/git-sync/pkg/telemetry"
+	"github.com/AkashRajpurohit/git-sync/pkg/version"
 )
 
 type SyncStats struct {
@@ -108,6 +111,24 @@ func LogSyncSummary(cfg *config.Config) {
 		logger.Errorf("Failed to send notifications: %v", err)
 	}
 
+	telemetry.CaptureEvent("sync_completed", map[string]interface{}{
+		"platform":       cfg.Platform,
+		"clone_type":     cfg.CloneType,
+		"concurrency":    cfg.Concurrency,
+		"include_wiki":   cfg.IncludeWiki,
+		"include_issues": cfg.IncludeIssues,
+		"include_forks":  cfg.IncludeForks,
+		"repos_success":  stats.ReposSuccess,
+		"repos_failed":   len(stats.ReposFailed),
+		"wikis_success":  stats.WikisSuccess,
+		"wikis_failed":   len(stats.WikisFailed),
+		"issues_success": stats.IssuesSuccess,
+		"issues_failed":  len(stats.IssuesFailed),
+		"app_version":    version.Version,
+		"os":             runtime.GOOS,
+		"arch":           runtime.GOARCH,
+	})
+
 	// Reset stats for next sync
 	stats = &SyncStats{}
 }

pkg/telemetry/telemetry.go

@@ -0,0 +1,118 @@
+package telemetry
+
+import (
+	"os"
+	"path/filepath"
+	"sync"
+
+	"github.com/AkashRajpurohit/git-sync/pkg/config"
+	"github.com/AkashRajpurohit/git-sync/pkg/logger"
+	"github.com/google/uuid"
+	"github.com/posthog/posthog-go"
+)
+
+const posthogAPIKey = "phc_IUI4rNyfkWwpSNPvWyrO0bOQkI0byAGyDQRKIQMGc7w"
+
+var (
+	client   posthog.Client
+	deviceID string
+	disabled bool
+	once     sync.Once
+)
+
+func Init(cfg config.TelemetryConfig) {
+	once.Do(func() {
+		if isOptedOut(cfg) {
+			disabled = true
+			logger.Debug("Telemetry is disabled")
+			return
+		}
+
+		id, err := getOrCreateDeviceID()
+		if err != nil {
+			logger.Debug("Failed to get device ID, disabling telemetry: ", err)
+			disabled = true
+			return
+		}
+		deviceID = id
+
+		c, err := posthog.NewWithConfig(posthogAPIKey, posthog.Config{
+			Endpoint: "https://us.i.posthog.com",
+		})
+		if err != nil {
+			logger.Debug("Failed to create PostHog client, disabling telemetry: ", err)
+			disabled = true
+			return
+		}
+
+		client = c
+		logger.Debug("Telemetry initialized")
+	})
+}
+
+func CaptureEvent(event string, properties map[string]interface{}) {
+	if disabled || client == nil {
+		return
+	}
+
+	props := posthog.NewProperties()
+	for k, v := range properties {
+		props.Set(k, v)
+	}
+
+	client.Enqueue(posthog.Capture{
+		DistinctId: deviceID,
+		Event:      event,
+		Properties: props,
+	})
+}
+
+func Close() {
+	if client != nil {
+		client.Close()
+	}
+}
+
+func isOptedOut(cfg config.TelemetryConfig) bool {
+	if !cfg.Enabled {
+		return true
+	}
+
+	if os.Getenv("GIT_SYNC_NO_TELEMETRY") == "1" {
+		return true
+	}
+
+	return false
+}
+
+func getOrCreateDeviceID() (string, error) {
+	configDir := config.GetDefaultConfigDir()
+	idFile := filepath.Join(configDir, ".device-id")
+
+	data, err := os.ReadFile(idFile)
+	if err == nil && len(data) > 0 {
+		return string(data), nil
+	}
+
+	id := uuid.New().String()
+
+	if err := os.MkdirAll(configDir, os.ModePerm); err != nil {
+		return "", err
+	}
+
+	if err := os.WriteFile(idFile, []byte(id), 0600); err != nil {
+		return "", err
+	}
+
+	return id, nil
+}
+
+func Reset() {
+	if client != nil {
+		client.Close()
+		client = nil
+	}
+	deviceID = ""
+	disabled = false
+	once = sync.Once{}
+}

pkg/telemetry/telemetry_test.go

@@ -0,0 +1,81 @@
+package telemetry
+
+import (
+	"os"
+	"path/filepath"
+	"testing"
+
+	"github.com/AkashRajpurohit/git-sync/pkg/config"
+	"github.com/AkashRajpurohit/git-sync/pkg/logger"
+)
+
+func TestMain(m *testing.M) {
+	logger.InitLogger("fatal")
+	os.Exit(m.Run())
+}
+
+func TestIsOptedOut_ConfigDisabled(t *testing.T) {
+	cfg := config.TelemetryConfig{Enabled: false}
+	if !isOptedOut(cfg) {
+		t.Error("expected opt-out when config.Enabled is false")
+	}
+}
+
+func TestIsOptedOut_ConfigEnabled(t *testing.T) {
+	cfg := config.TelemetryConfig{Enabled: true}
+	if isOptedOut(cfg) {
+		t.Error("expected opt-in when config.Enabled is true and no env vars set")
+	}
+}
+
+func TestIsOptedOut_GitSyncNoTelemetryEnv(t *testing.T) {
+	t.Setenv("GIT_SYNC_NO_TELEMETRY", "1")
+	cfg := config.TelemetryConfig{Enabled: true}
+	if !isOptedOut(cfg) {
+		t.Error("expected opt-out when GIT_SYNC_NO_TELEMETRY=1")
+	}
+}
+
+func TestGetOrCreateDeviceID(t *testing.T) {
+	tmpDir := t.TempDir()
+	t.Setenv("HOME", tmpDir)
+
+	id1, err := getOrCreateDeviceID()
+	if err != nil {
+		t.Fatalf("unexpected error: %v", err)
+	}
+	if id1 == "" {
+		t.Fatal("expected non-empty device ID")
+	}
+
+	// Second call should return the same ID
+	id2, err := getOrCreateDeviceID()
+	if err != nil {
+		t.Fatalf("unexpected error on second call: %v", err)
+	}
+	if id1 != id2 {
+		t.Errorf("expected same device ID, got %q and %q", id1, id2)
+	}
+
+	// Verify the file exists
+	idFile := filepath.Join(tmpDir, ".config", "git-sync", ".device-id")
+	data, err := os.ReadFile(idFile)
+	if err != nil {
+		t.Fatalf("expected device ID file to exist: %v", err)
+	}
+	if string(data) != id1 {
+		t.Errorf("file content %q doesn't match returned ID %q", string(data), id1)
+	}
+}
+
+func TestCaptureEventWhenDisabled(t *testing.T) {
+	Reset()
+	defer Reset()
+
+	Init(config.TelemetryConfig{Enabled: false})
+
+	// Should not panic or cause any side effects
+	CaptureEvent("test_event", map[string]interface{}{
+		"key": "value",
+	})
+}