Move analytics collector to root command (#164)

Author: tamalsaha

root.go

@@ -3,27 +3,46 @@ package cmds
 import (
 	"flag"
 	"log"
+	"strings"
 
 	v "github.com/appscode/go/version"
+	"github.com/jpillora/go-ogle-analytics"
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 )
 
+const (
+	gaTrackingCode = "UA-62096468-20"
+)
+
 func NewCmdStash(version string) *cobra.Command {
+	var (
+		enableAnalytics = true
+	)
 	var rootCmd = &cobra.Command{
-		Use:   "stash",
-		Short: `Stash by AppsCode - Backup your Kubernetes Volumes`,
-		Long:  `Stash is a Kubernetes operator for restic. For more information, visit here: https://github.com/appscode/stash/tree/master/docs`,
+		Use:               "stash",
+		Short:             `Stash by AppsCode - Backup your Kubernetes Volumes`,
+		Long:              `Stash is a Kubernetes operator for restic. For more information, visit here: https://github.com/appscode/stash/tree/master/docs`,
+		DisableAutoGenTag: true,
 		PersistentPreRun: func(c *cobra.Command, args []string) {
 			c.Flags().VisitAll(func(flag *pflag.Flag) {
 				log.Printf("FLAG: --%s=%q", flag.Name, flag.Value)
 			})
+			if enableAnalytics && gaTrackingCode != "" {
+				if client, err := ga.NewClient(gaTrackingCode); err == nil {
+					parts := strings.Split(c.CommandPath(), " ")
+					client.Send(ga.NewEvent(parts[0], strings.Join(parts[1:], "/")).Label(version))
+				}
+			}
 		},
 	}
 	rootCmd.PersistentFlags().AddGoFlagSet(flag.CommandLine)
+	// ref: https://github.com/kubernetes/kubernetes/issues/17162#issuecomment-225596212
+	flag.CommandLine.Parse([]string{})
+	rootCmd.PersistentFlags().BoolVar(&enableAnalytics, "analytics", enableAnalytics, "Send analytical events to Google Analytics")
 
 	rootCmd.AddCommand(v.NewCmdVersion())
 	rootCmd.AddCommand(NewCmdRun(version))
-	rootCmd.AddCommand(NewCmdSchedule(version))
+	rootCmd.AddCommand(NewCmdSchedule())
 	return rootCmd
 }

run.go

@@ -9,7 +9,6 @@ import (
 	"github.com/appscode/pat"
 	sapi "github.com/appscode/stash/api"
 	scs "github.com/appscode/stash/client/clientset"
-	"github.com/appscode/stash/pkg/analytics"
 	"github.com/appscode/stash/pkg/controller"
 	"github.com/appscode/stash/pkg/docker"
 	"github.com/appscode/stash/pkg/migrator"
@@ -29,25 +28,16 @@ var (
 
 func NewCmdRun(version string) *cobra.Command {
 	var (
-		masterURL       string
-		kubeconfigPath  string
-		tag             string = stringz.Val(version, "canary")
-		address         string = ":56790"
-		enableAnalytics bool   = true
+		masterURL      string
+		kubeconfigPath string
+		tag            string = stringz.Val(version, "canary")
+		address        string = ":56790"
 	)
 
 	cmd := &cobra.Command{
-		Use:   "run",
-		Short: "Run Stash operator",
-		PreRun: func(cmd *cobra.Command, args []string) {
-			if enableAnalytics {
-				analytics.Enable()
-			}
-			analytics.SendEvent("operator", "started", version)
-		},
-		PostRun: func(cmd *cobra.Command, args []string) {
-			analytics.SendEvent("operator", "stopped", version)
-		},
+		Use:               "run",
+		Short:             "Run Stash operator",
+		DisableAutoGenTag: true,
 		Run: func(cmd *cobra.Command, args []string) {
 			if err := docker.CheckDockerImageVersion(docker.ImageOperator, tag); err != nil {
 				log.Fatalf(`Image %v:%v not found.`, docker.ImageOperator, tag)
@@ -90,7 +80,6 @@ func NewCmdRun(version string) *cobra.Command {
 	cmd.Flags().StringVar(&kubeconfigPath, "kubeconfig", kubeconfigPath, "Path to kubeconfig file with authorization information (the master location is set by the master flag).")
 	cmd.Flags().StringVar(&address, "address", address, "Address to listen on for web interface and telemetry.")
 	cmd.Flags().StringVar(&scratchDir, "scratch-dir", scratchDir, "Directory used to store temporary files. Use an `emptyDir` in Kubernetes.")
-	cmd.Flags().BoolVar(&enableAnalytics, "analytics", enableAnalytics, "Send analytical events to Google Analytics")
 
 	return cmd
 }

schedule.go

@@ -7,7 +7,6 @@ import (
 
 	"github.com/appscode/log"
 	rcs "github.com/appscode/stash/client/clientset"
-	"github.com/appscode/stash/pkg/analytics"
 	"github.com/appscode/stash/pkg/scheduler"
 	"github.com/appscode/stash/pkg/util"
 	"github.com/spf13/cobra"
@@ -17,7 +16,7 @@ import (
 	"k8s.io/client-go/tools/clientcmd"
 )
 
-func NewCmdSchedule(version string) *cobra.Command {
+func NewCmdSchedule() *cobra.Command {
 	var (
 		masterURL      string
 		kubeconfigPath string
@@ -29,21 +28,12 @@ func NewCmdSchedule(version string) *cobra.Command {
 			PushgatewayURL: "http://stash-operator.kube-system.svc:56789",
 			PodLabelsPath:  "/etc/stash/labels",
 		}
-		enableAnalytics bool = true
 	)
 
 	cmd := &cobra.Command{
-		Use:   "schedule",
-		Short: "Run Stash cron daemon",
-		PreRun: func(cmd *cobra.Command, args []string) {
-			if enableAnalytics {
-				analytics.Enable()
-			}
-			analytics.SendEvent("scheduler", "started", version)
-		},
-		PostRun: func(cmd *cobra.Command, args []string) {
-			analytics.SendEvent("scheduler", "stopped", version)
-		},
+		Use:               "schedule",
+		Short:             "Run Stash cron daemon",
+		DisableAutoGenTag: true,
 		Run: func(cmd *cobra.Command, args []string) {
 			config, err := clientcmd.BuildConfigFromFlags(masterURL, kubeconfigPath)
 			if err != nil {
@@ -141,8 +131,6 @@ func NewCmdSchedule(version string) *cobra.Command {
 	cmd.Flags().StringVar(&opt.ScratchDir, "scratch-dir", opt.ScratchDir, "Directory used to store temporary files. Use an `emptyDir` in Kubernetes.")
 	cmd.Flags().StringVar(&opt.PushgatewayURL, "pushgateway-url", opt.PushgatewayURL, "URL of Prometheus pushgateway used to cache backup metrics")
 
-	// Analytics flags
-	cmd.Flags().BoolVar(&enableAnalytics, "analytics", enableAnalytics, "Send analytical events to Google Analytics")
 	return cmd
 }