Adding analytics for usage metrics

This adds metrics to chamber so we can track internal company usage of the tool. Chamber built for open source will not have the linked analytics key
segmentio · Sep 19, 2018 · 47c82aa · 47c82aa
1 parent e61fff1
commit 47c82aa
Show file tree

Hide file tree

Showing 13 changed files with 193 additions and 9 deletions.
diff --git a/Makefile b/Makefile
@@ -5,7 +5,8 @@
 # This makefile is meant for humans
 
 VERSION := $(shell git describe --tags --always --dirty="-dev")
-LDFLAGS := -ldflags='-X "main.Version=$(VERSION)"'
+ANALYTICS_WRITE_KEY ?=
+LDFLAGS := -ldflags='-X "main.Version=$(VERSION)" -X "main.AnalyticsWriteKey=$(ANALYTICS_WRITE_KEY)"'
 
 test: | govendor
 	govendor sync

diff --git a/cmd/delete.go b/cmd/delete.go
@@ -4,6 +4,7 @@ import (
 	"strings"
 
 	"github.com/pkg/errors"
+	analytics "github.com/segmentio/analytics-go"
 	"github.com/segmentio/chamber/store"
 	"github.com/spf13/cobra"
 )
@@ -31,6 +32,19 @@ func delete(cmd *cobra.Command, args []string) error {
 		return errors.Wrap(err, "Failed to validate key")
 	}
 
+	if analyticsEnabled && analyticsClient != nil {
+		analyticsClient.Enqueue(analytics.Track{
+			UserId: username,
+			Event:  "Ran Command",
+			Properties: analytics.NewProperties().
+				Set("command", "delete").
+				Set("chamber-version", chamberVersion).
+				Set("service", service).
+				Set("key", key).
+				Set("backend", backend),
+		})
+	}
+
 	secretStore := getSecretStore()
 	secretId := store.SecretId{
 		Service: service,

diff --git a/cmd/exec.go b/cmd/exec.go
@@ -6,6 +6,7 @@ import (
 	"strings"
 
 	"github.com/pkg/errors"
+	analytics "github.com/segmentio/analytics-go"
 	"github.com/spf13/cobra"
 )
 
@@ -37,6 +38,18 @@ func execRun(cmd *cobra.Command, args []string) error {
 	dashIx := cmd.ArgsLenAtDash()
 	services, command, commandArgs := args[:dashIx], args[dashIx], args[dashIx+1:]
 
+	if analyticsEnabled && analyticsClient != nil {
+		analyticsClient.Enqueue(analytics.Track{
+			UserId: username,
+			Event:  "Ran Command",
+			Properties: analytics.NewProperties().
+				Set("command", "exec").
+				Set("chamber-version", chamberVersion).
+				Set("services", services).
+				Set("backend", backend),
+		})
+	}
+
 	env := environ(os.Environ())
 	secretStore := getSecretStore()
 	envVarKeys := make([]string, 0)

diff --git a/cmd/export.go b/cmd/export.go
@@ -12,6 +12,7 @@ import (
 
 	"github.com/magiconair/properties"
 	"github.com/pkg/errors"
+	analytics "github.com/segmentio/analytics-go"
 	"github.com/spf13/cobra"
 )
 
@@ -37,6 +38,18 @@ func init() {
 func runExport(cmd *cobra.Command, args []string) error {
 	var err error
 
+	if analyticsEnabled && analyticsClient != nil {
+		analyticsClient.Enqueue(analytics.Track{
+			UserId: username,
+			Event:  "Ran Command",
+			Properties: analytics.NewProperties().
+				Set("command", "export").
+				Set("chamber-version", chamberVersion).
+				Set("services", args).
+				Set("backend", backend),
+		})
+	}
+
 	secretStore := getSecretStore()
 	params := make(map[string]string)
 	for _, service := range args {

diff --git a/cmd/history.go b/cmd/history.go
@@ -7,6 +7,7 @@ import (
 	"text/tabwriter"
 
 	"github.com/pkg/errors"
+	analytics "github.com/segmentio/analytics-go"
 	"github.com/segmentio/chamber/store"
 	"github.com/spf13/cobra"
 )
@@ -34,6 +35,19 @@ func history(cmd *cobra.Command, args []string) error {
 		return errors.Wrap(err, "Failed to validate key")
 	}
 
+	if analyticsEnabled && analyticsClient != nil {
+		analyticsClient.Enqueue(analytics.Track{
+			UserId: username,
+			Event:  "Ran Command",
+			Properties: analytics.NewProperties().
+				Set("command", "history").
+				Set("chamber-version", chamberVersion).
+				Set("service", service).
+				Set("key", key).
+				Set("backend", backend),
+		})
+	}
+
 	secretStore := getSecretStore()
 	secretId := store.SecretId{
 		Service: service,

diff --git a/cmd/import.go b/cmd/import.go
@@ -8,6 +8,7 @@ import (
 	"strings"
 
 	"github.com/pkg/errors"
+	analytics "github.com/segmentio/analytics-go"
 	"github.com/segmentio/chamber/store"
 	"github.com/spf13/cobra"
 )
@@ -51,6 +52,18 @@ func importRun(cmd *cobra.Command, args []string) error {
 		return errors.Wrap(err, "Failed to decode input as json")
 	}
 
+	if analyticsEnabled && analyticsClient != nil {
+		analyticsClient.Enqueue(analytics.Track{
+			UserId: username,
+			Event:  "Ran Command",
+			Properties: analytics.NewProperties().
+				Set("command", "import").
+				Set("chamber-version", chamberVersion).
+				Set("service", service).
+				Set("backend", backend),
+		})
+	}
+
 	secretStore := getSecretStore()
 
 	for key, value := range toBeImported {

diff --git a/cmd/list.go b/cmd/list.go
@@ -7,6 +7,7 @@ import (
 	"text/tabwriter"
 
 	"github.com/pkg/errors"
+	analytics "github.com/segmentio/analytics-go"
 	"github.com/spf13/cobra"
 )
 
@@ -33,6 +34,18 @@ func list(cmd *cobra.Command, args []string) error {
 		return errors.Wrap(err, "Failed to validate service")
 	}
 
+	if analyticsEnabled && analyticsClient != nil {
+		analyticsClient.Enqueue(analytics.Track{
+			UserId: username,
+			Event:  "Ran Command",
+			Properties: analytics.NewProperties().
+				Set("command", "list").
+				Set("chamber-version", chamberVersion).
+				Set("service", service).
+				Set("backend", backend),
+		})
+	}
+
 	secretStore := getSecretStore()
 	secrets, err := secretStore.List(service, withValues)
 	if err != nil {

diff --git a/cmd/read.go b/cmd/read.go
@@ -7,6 +7,7 @@ import (
 	"text/tabwriter"
 
 	"github.com/pkg/errors"
+	analytics "github.com/segmentio/analytics-go"
 	"github.com/segmentio/chamber/store"
 	"github.com/spf13/cobra"
 )
@@ -41,6 +42,21 @@ func read(cmd *cobra.Command, args []string) error {
 		return errors.Wrap(err, "Failed to validate key")
 	}
 
+	if analyticsEnabled && analyticsClient != nil {
+		analyticsClient.Enqueue(analytics.Track{
+			UserId: username,
+			Event:  "Ran Command",
+			Properties: analytics.NewProperties().
+				Set("command", "read").
+				Set("chamber-version", chamberVersion).
+				Set("service", service).
+				Set("key", key).
+				Set("backend", backend),
+		})
+	} else {
+		fmt.Println("Not writing!!")
+	}
+
 	secretStore := getSecretStore()
 
 	secretId := store.SecretId{

diff --git a/cmd/root.go b/cmd/root.go
@@ -6,6 +6,7 @@ import (
 	"regexp"
 	"strings"
 
+	analytics "github.com/segmentio/analytics-go"
 	"github.com/segmentio/chamber/store"
 	"github.com/spf13/cobra"
 )
@@ -19,6 +20,12 @@ var (
 	verbose        bool
 	numRetries     int
 	chamberVersion string
+	backend        string
+
+	analyticsEnabled  bool
+	analyticsWriteKey string
+	analyticsClient   analytics.Client
+	username          string
 )
 
 const (
@@ -40,9 +47,11 @@ var Backends = []string{SSMBackend, S3Backend}
 
 // RootCmd represents the base command when called without any subcommands
 var RootCmd = &cobra.Command{
-	Use:          "chamber",
-	Short:        "CLI for storing secrets",
-	SilenceUsage: true,
+	Use:               "chamber",
+	Short:             "CLI for storing secrets",
+	SilenceUsage:      true,
+	PersistentPreRun:  prerun,
+	PersistentPostRun: postrun,
 }
 
 func init() {
@@ -52,8 +61,12 @@ func init() {
 
 // Execute adds all child commands to the root command sets flags appropriately.
 // This is called by main.main(). It only needs to happen once to the rootCmd.
-func Execute(vers string) {
+func Execute(vers string, writeKey string) {
 	chamberVersion = vers
+
+	analyticsWriteKey = writeKey
+	analyticsEnabled = analyticsWriteKey != ""
+
 	if cmd, err := RootCmd.ExecuteC(); err != nil {
 		if strings.Contains(err.Error(), "arg(s)") || strings.Contains(err.Error(), "usage") {
 			cmd.Usage()
@@ -85,8 +98,6 @@ func validateKey(key string) error {
 }
 
 func getSecretStore() store.Store {
-	backend := strings.ToUpper(os.Getenv(BackendEnvVar))
-
 	var s store.Store
 	switch backend {
 	case S3Backend:
@@ -98,3 +109,27 @@ func getSecretStore() store.Store {
 	}
 	return s
 }
+
+func prerun(cmd *cobra.Command, args []string) {
+	backend = strings.ToUpper(os.Getenv(BackendEnvVar))
+
+	if analyticsEnabled {
+		// set up analytics client
+		analyticsClient, _ = analytics.NewWithConfig(analyticsWriteKey, analytics.Config{
+			BatchSize: 1,
+		})
+
+		username = os.Getenv("USER")
+		analyticsClient.Enqueue(analytics.Identify{
+			UserId: username,
+			Traits: analytics.NewTraits().
+				Set("chamber-version", chamberVersion),
+		})
+	}
+}
+
+func postrun(cmd *cobra.Command, args []string) {
+	if analyticsEnabled && analyticsClient != nil {
+		analyticsClient.Close()
+	}
+}
diff --git a/cmd/version.go b/cmd/version.go
@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"os"
 
+	analytics "github.com/segmentio/analytics-go"
 	"github.com/spf13/cobra"
 )
 
@@ -20,5 +21,15 @@ func init() {
 
 func versionRun(cmd *cobra.Command, args []string) error {
 	fmt.Fprintf(os.Stdout, "chamber %s\n", chamberVersion)
+	if analyticsEnabled && analyticsClient != nil {
+		analyticsClient.Enqueue(analytics.Track{
+			UserId: username,
+			Event:  "Ran Command",
+			Properties: analytics.NewProperties().
+				Set("command", "version").
+				Set("chamber-version", chamberVersion).
+				Set("backend", backend),
+		})
+	}
 	return nil
 }
diff --git a/cmd/write.go b/cmd/write.go
@@ -7,6 +7,7 @@ import (
 	"strings"
 
 	"github.com/pkg/errors"
+	analytics "github.com/segmentio/analytics-go"
 	"github.com/segmentio/chamber/store"
 	"github.com/spf13/cobra"
 )
@@ -39,6 +40,19 @@ func write(cmd *cobra.Command, args []string) error {
 		return errors.Wrap(err, "Failed to validate key")
 	}
 
+	if analyticsEnabled && analyticsClient != nil {
+		analyticsClient.Enqueue(analytics.Track{
+			UserId: username,
+			Event:  "Ran Command",
+			Properties: analytics.NewProperties().
+				Set("command", "write").
+				Set("chamber-version", chamberVersion).
+				Set("service", service).
+				Set("backend", backend).
+				Set("key", key),
+		})
+	}
+
 	value := args[2]
 	if value == "-" {
 		// Read value from standard input

diff --git a/main.go b/main.go
@@ -4,9 +4,10 @@ import "github.com/segmentio/chamber/cmd"
 
 var (
 	// This is updated by linker flags during build
-	Version = "dev"
+	Version           = "dev"
+	AnalyticsWriteKey = ""
 )
 
 func main() {
-	cmd.Execute(Version)
+	cmd.Execute(Version, AnalyticsWriteKey)
 }