Merge pull request #141 from coveooss/feature/sentry-logger

Log exceptions to Sentry if configured properly

README.md

@@ -43,6 +43,13 @@ Valid levels are `debug`, `info`, `warning` and `error`.
 
 ![example](https://raw.githubusercontent.com/coveooss/credentials-sync/main/example.png)
 
+## Monitoring with Sentry
+
+To send errors to Sentry, set the following environment variables:
+- `SENTRY_DSN`
+- `SENTRY_RELEASE`
+- `SENTRY_ENVIRONMENT`
+
 ## Configuration file
 
 A configuration file must be given to the application. Its path can either be a local path or a S3 path

cli/credentialslist.go

@@ -3,7 +3,8 @@ package cli
 import (
 	"fmt"
 
-	log "github.com/sirupsen/logrus"
+	"github.com/coveooss/credentials-sync/logger"
+
 	"github.com/spf13/cobra"
 )
 
@@ -16,7 +17,7 @@ var listCredentialsCmd = &cobra.Command{
 	Short: "Resolves and lists all configured credentials",
 	Run: func(cmd *cobra.Command, args []string) {
 		if err := configuration.Sources.ValidateConfiguration(); err != nil {
-			log.Fatalf("The sources section of the config file is invalid: %v", err)
+			logger.Log.Fatalf("The sources section of the config file is invalid: %v", err)
 		}
 		allCredentials, err := configuration.Sources.Credentials()
 		if err != nil {

cli/root.go

@@ -12,13 +12,14 @@ import (
 	"github.com/aws/aws-sdk-go/aws/session"
 	"github.com/aws/aws-sdk-go/service/s3"
 	"github.com/mitchellh/mapstructure"
+	"github.com/sirupsen/logrus"
 
 	"gopkg.in/yaml.v2"
 
 	"github.com/coveooss/credentials-sync/credentials"
+	"github.com/coveooss/credentials-sync/logger"
 	"github.com/coveooss/credentials-sync/sync"
 	"github.com/coveooss/credentials-sync/targets"
-	log "github.com/sirupsen/logrus"
 
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
@@ -41,11 +42,11 @@ var rootCmd = &cobra.Command{
 			fileContent       []byte
 		)
 
-		level, err := log.ParseLevel(viper.GetString("log-level"))
+		level, err := logrus.ParseLevel(viper.GetString("log-level"))
 		if err != nil {
 			return fmt.Errorf("Invalid log level: %s", err)
 		}
-		log.SetLevel(level)
+		logger.Log.SetLevel(level)
 
 		if configurationFile == "" {
 			return fmt.Errorf("A configuration file must be defined")
@@ -109,15 +110,15 @@ var rootCmd = &cobra.Command{
 }
 
 func init() {
-	log.SetFormatter(&log.TextFormatter{FullTimestamp: true})
+	logger.Log.SetFormatter(&logrus.TextFormatter{FullTimestamp: true})
 
 	viper.AutomaticEnv()
 	viper.SetEnvPrefix("sync")
 	viper.SetEnvKeyReplacer(strings.NewReplacer("-", "_"))
 	rootCmd.PersistentFlags().StringP("config", "c", "", "configuration file")
 	viper.BindPFlag("config", rootCmd.PersistentFlags().Lookup("config"))
 
-	rootCmd.PersistentFlags().StringP("log-level", "l", log.InfoLevel.String(), `"debug", "info", "warning" or "error"`)
+	rootCmd.PersistentFlags().StringP("log-level", "l", logrus.InfoLevel.String(), `"debug", "info", "warning" or "error"`)
 	viper.BindPFlag("log-level", rootCmd.PersistentFlags().Lookup("log-level"))
 
 	initListCredentials()
@@ -129,6 +130,7 @@ func Execute(commit string, date string, version string) {
 	rootCmd.Version = fmt.Sprintf("%s %s (%s)", version, commit, date)
 	if err := rootCmd.Execute(); err != nil {
 		fmt.Println(err)
+		logger.Log.Error(err)
 		os.Exit(1)
 	}
 }

cli/sync.go

@@ -1,7 +1,7 @@
 package cli
 
 import (
-	log "github.com/sirupsen/logrus"
+	"github.com/coveooss/credentials-sync/logger"
 	"github.com/spf13/cobra"
 )
 
@@ -10,13 +10,13 @@ var syncCmd = &cobra.Command{
 	Short: "Fetches credentials and syncs them to targets",
 	Run: func(cmd *cobra.Command, args []string) {
 		if err := configuration.Sources.ValidateConfiguration(); err != nil {
-			log.Fatalf("The sources section of the config file is invalid: %v", err)
+			logger.Log.Fatalf("The sources section of the config file is invalid: %v", err)
 		}
 		if err := configuration.Targets.ValidateConfiguration(); err != nil {
-			log.Fatalf("The targets section of the config file is invalid: %v", err)
+			logger.Log.Fatalf("The targets section of the config file is invalid: %v", err)
 		}
 		if err := configuration.Sync(); err != nil {
-			log.Fatalf("The synchronization process failed: %v", err)
+			logger.Log.Fatalf("The synchronization process failed: %v", err)
 		}
 	},
 }

cli/targetslist.go

@@ -2,8 +2,8 @@ package cli
 
 import (
 	"fmt"
+	"github.com/coveooss/credentials-sync/logger"
 
-	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
@@ -12,7 +12,7 @@ var listTargetsCmd = &cobra.Command{
 	Short: "Resolves and lists all configured targets",
 	Run: func(cmd *cobra.Command, args []string) {
 		if err := configuration.Targets.ValidateConfiguration(); err != nil {
-			log.Fatalf("The targets section of the config file is invalid: %v", err)
+			logger.Log.Fatalf("The targets section of the config file is invalid: %v", err)
 		}
 		for _, target := range configuration.Targets.AllTargets() {
 			fmt.Println(target.ToString())

cli/validate.go

@@ -1,8 +1,7 @@
 package cli
 
 import (
-	log "github.com/sirupsen/logrus"
-
+	"github.com/coveooss/credentials-sync/logger"
 	"github.com/spf13/cobra"
 )
 
@@ -11,11 +10,11 @@ var validateCmd = &cobra.Command{
 	Short: "Parses and validates the given configuration",
 	Run: func(cmd *cobra.Command, args []string) {
 		if err := configuration.Sources.ValidateConfiguration(); err != nil {
-			log.Fatalf("The sources section of the config file is invalid: %v", err)
+			logger.Log.Fatalf("The sources section of the config file is invalid: %v", err)
 		}
 		if err := configuration.Targets.ValidateConfiguration(); err != nil {
-			log.Fatalf("The targets section of the config file is invalid: %v", err)
+			logger.Log.Fatalf("The targets section of the config file is invalid: %v", err)
 		}
-		log.Info("The config file is valid!")
+		logger.Log.Info("The config file is valid!")
 	},
 }

credentials/credentials.go

@@ -3,9 +3,9 @@ package credentials
 import (
 	"fmt"
 
+	"github.com/coveooss/credentials-sync/logger"
 	"github.com/hashicorp/go-multierror"
 	"github.com/mitchellh/mapstructure"
-	log "github.com/sirupsen/logrus"
 )
 
 // Credentials defines the methods that can be called by all types of credentials
@@ -106,7 +106,7 @@ func (credBase *Base) ShouldSync(targetName string, targetTags map[string]string
 						return true
 					}
 				} else {
-					log.Warningf("%s ignored. Its value should either be a string or a list of string", key)
+					logger.Log.Warningf("%s ignored. Its value should either be a string or a list of string", key)
 				}
 			}
 		}

credentials/sources.go

@@ -4,8 +4,8 @@ import (
 	"fmt"
 	"sort"
 
+	"github.com/coveooss/credentials-sync/logger"
 	"github.com/hashicorp/go-multierror"
-	log "github.com/sirupsen/logrus"
 	"gopkg.in/yaml.v2"
 )
 
@@ -110,10 +110,10 @@ func getCredentialsFromBytes(byteArray []byte) ([]Credentials, error) {
 	}
 
 	if !success {
-		log.Warning("Failed to get credential from data using all known formats (details below)")
+		logger.Log.Warning("Failed to get credential from data using all known formats (details below)")
 		for _, err := range errors {
 			if err != nil {
-				log.Warning(err)
+				logger.Log.Warning(err)
 			}
 		}
 	}

go.mod

@@ -5,6 +5,10 @@ go 1.12
 require (
 	github.com/aws/aws-sdk-go v1.36.28
 	github.com/bndr/gojenkins v1.0.1
+	github.com/certifi/gocertifi v0.0.0-20210507211836-431795d63e8d // indirect
+	github.com/evalphobia/logrus_sentry v0.8.2
+	github.com/getsentry/raven-go v0.2.0 // indirect
+	github.com/getsentry/sentry-go v0.11.0
 	github.com/golang/mock v1.4.4
 	github.com/hashicorp/go-multierror v1.1.0
 	github.com/mitchellh/mapstructure v1.4.1