Add logrus logs integration

_examples/logrus/main.go

@@ -6,24 +6,47 @@ import (
 	"os"
 	"time"
 
-	"github.com/sirupsen/logrus"
-
 	"github.com/getsentry/sentry-go"
 	sentrylogrus "github.com/getsentry/sentry-go/logrus"
+	"github.com/sirupsen/logrus"
 )
 
 func main() {
+	// Initialize Logrus
 	logger := logrus.New()
 
 	// Log DEBUG and higher level logs to STDERR
 	logger.Level = logrus.DebugLevel
 	logger.Out = os.Stderr
 
-	// Send only ERROR and higher level logs to Sentry
-	sentryLevels := []logrus.Level{logrus.ErrorLevel, logrus.FatalLevel, logrus.PanicLevel}
+	// send logs on InfoLevel
+	logHook, err := sentrylogrus.NewLogHook(
+		[]logrus.Level{logrus.InfoLevel},
+		sentry.ClientOptions{
+			Dsn: "your-public-dsn",
+			BeforeSend: func(event *sentry.Event, hint *sentry.EventHint) *sentry.Event {
+				if hint.Context != nil {
+					if req, ok := hint.Context.Value(sentry.RequestContextKey).(*http.Request); ok {
+						// You have access to the original Request
+						fmt.Println(req)
+					}
+				}
+				fmt.Println(event)
+				return event
+			},
+			// need to have logs enabled
+			EnableLogs:       true,
+			Debug:            true,
+			AttachStacktrace: true,
+		})
 
-	sentryHook, err := sentrylogrus.New(sentryLevels, sentry.ClientOptions{
-		Dsn: "",
+	// send events on Error, Fatal, Panic levels
+	eventHook, err := sentrylogrus.NewEventHook([]logrus.Level{
+		logrus.ErrorLevel,
+		logrus.FatalLevel,
+		logrus.PanicLevel,
+	}, sentry.ClientOptions{
+		Dsn: "your-public-dsn",
 		BeforeSend: func(event *sentry.Event, hint *sentry.EventHint) *sentry.Event {
 			if hint.Context != nil {
 				if req, ok := hint.Context.Value(sentry.RequestContextKey).(*http.Request); ok {
@@ -40,14 +63,19 @@ func main() {
 	if err != nil {
 		panic(err)
 	}
-	defer sentryHook.Flush(5 * time.Second)
-	logger.AddHook(sentryHook)
+	defer eventHook.Flush(5 * time.Second)
+	defer logHook.Flush(5 * time.Second)
+	logger.AddHook(eventHook)
+	logger.AddHook(logHook)
 
 	// Flushes before calling os.Exit(1) when using logger.Fatal
 	// (else all defers are not called, and Sentry does not have time to send the event)
-	logrus.RegisterExitHandler(func() { sentryHook.Flush(5 * time.Second) })
+	logrus.RegisterExitHandler(func() {
+		eventHook.Flush(5 * time.Second)
+		logHook.Flush(5 * time.Second)
+	})
 
-	// Log a InfoLevel entry STDERR which is not sent to Sentry
+	// Log a InfoLevel entry STDERR which is sent as a log to Sentry
 	logger.Infof("Application has started")
 
 	// Log an error to STDERR which is also sent to Sentry

logrus/README.md

@@ -32,32 +32,78 @@ import (
 func main() {
 	// Initialize Logrus
 	logger := logrus.New()
+
+	// Log DEBUG and higher level logs to STDERR
 	logger.Level = logrus.DebugLevel
 	logger.Out = os.Stderr
 
-	// Define log levels to send to Sentry
-	sentryLevels := []logrus.Level{logrus.ErrorLevel, logrus.FatalLevel, logrus.PanicLevel}
-
-	// Initialize Sentry
-	sentryHook, err := sentrylogrus.New(sentryLevels, sentry.ClientOptions{
+	// send logs on InfoLevel
+	logHook, err := sentrylogrus.NewLogHook(
+		[]logrus.Level{logrus.InfoLevel},
+		sentry.ClientOptions{
+			Dsn: "your-public-dsn",
+			BeforeSend: func(event *sentry.Event, hint *sentry.EventHint) *sentry.Event {
+				if hint.Context != nil {
+					if req, ok := hint.Context.Value(sentry.RequestContextKey).(*http.Request); ok {
+						// You have access to the original Request
+						fmt.Println(req)
+					}
+				}
+				fmt.Println(event)
+				return event
+			},
+			// need to have logs enabled
+			EnableLogs:       true,
+			Debug:            true,
+			AttachStacktrace: true,
+		})
+
+	// send events on Error, Fatal, Panic levels
+	eventHook, err := sentrylogrus.NewEventHook([]logrus.Level{
+		logrus.ErrorLevel,
+		logrus.FatalLevel,
+		logrus.PanicLevel,
+	}, sentry.ClientOptions{
 		Dsn: "your-public-dsn",
 		BeforeSend: func(event *sentry.Event, hint *sentry.EventHint) *sentry.Event {
-			fmt.Println(event) // Optional debugging
+			if hint.Context != nil {
+				if req, ok := hint.Context.Value(sentry.RequestContextKey).(*http.Request); ok {
+					// You have access to the original Request
+					fmt.Println(req)
+				}
+			}
+			fmt.Println(event)
 			return event
 		},
-		Debug: true,
+		Debug:            true,
+		AttachStacktrace: true,
 	})
 	if err != nil {
 		panic(err)
 	}
-	defer sentryHook.Flush(5 * time.Second)
-	logger.AddHook(sentryHook)
+	defer eventHook.Flush(5 * time.Second)
+	defer logHook.Flush(5 * time.Second)
+	logger.AddHook(eventHook)
+	logger.AddHook(logHook)
+
+	// Flushes before calling os.Exit(1) when using logger.Fatal
+	// (else all defers are not called, and Sentry does not have time to send the event)
+	logrus.RegisterExitHandler(func() {
+		eventHook.Flush(5 * time.Second)
+		logHook.Flush(5 * time.Second)
+	})
 
-	// Example logging
-	logger.WithField("user", "test-user").Error("An error occurred")
+    // Log a InfoLevel entry STDERR which is sent as a log to Sentry
+    logger.Infof("Application has started")
+
+    // Log an error to STDERR which is also sent to Sentry
+    logger.Errorf("oh no!")
 
-	// Ensure all events are flushed before exit
-	logrus.RegisterExitHandler(func() { sentryHook.Flush(5 * time.Second) })
+    // Log a fatal error to STDERR, which sends an event to Sentry and terminates the application
+    logger.Fatalf("can't continue...")
+
+    // Example of logging with attributes
+	logger.WithField("user", "test-user").Error("An error occurred")
 }
 ```
 

logrus/go.mod

@@ -9,9 +9,14 @@ require (
 	github.com/google/go-cmp v0.6.0
 	github.com/pkg/errors v0.9.1
 	github.com/sirupsen/logrus v1.9.3
+	github.com/stretchr/testify v1.8.4
 )
 
 require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/kr/text v0.2.0 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
 	golang.org/x/sys v0.18.0 // indirect
 	golang.org/x/text v0.14.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

logrus/go.sum

@@ -1,22 +1,29 @@
+github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/go-errors/errors v1.4.2 h1:J6MZopCL4uSllY1OfXM374weqZFFItUbrImctkmUxIA=
 github.com/go-errors/errors v1.4.2/go.mod h1:sIVyrIiJhuEF+Pj9Ebtd6P/rEYROXFi3BopGUQ5a5Og=
 github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
 github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/kr/pretty v0.3.0 h1:WgNl7dwNpEZ6jJ9k1snq4pZsg7DOEN8hP9Xw0Tsjwk0=
+github.com/kr/pretty v0.3.0/go.mod h1:640gp4NfQd8pI5XOwp5fnNeVWj67G7CFk/SaSQn7NBk=
+github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
+github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
 github.com/pingcap/errors v0.11.4 h1:lFuQV/oaUMGcD2tqt+01ROSmJs75VG1ToEOkZIZ4nE4=
 github.com/pingcap/errors v0.11.4/go.mod h1:Oi8TUi2kEtXXLMJk9l1cGmz20kV3TaQ0usTwv5KuLY8=
 github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 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/rogpeppe/go-internal v1.8.0 h1:FCbCCtXNOY3UtUuHUYaghJg4y7Fd14rXifAYUAtL9R8=
+github.com/rogpeppe/go-internal v1.8.0/go.mod h1:WmiCO8CzOY8rg0OYDC4/i/2WRWAB6poM+XZ2dLUbcbE=
 github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=
 github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.8.2 h1:+h33VjcLVPDHtOdpUCuF+7gSuG3yGIftsP1YvFihtJ8=
-github.com/stretchr/testify v1.8.2/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
+github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
+github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
 go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
 go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE=
 golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
@@ -25,6 +32,8 @@ golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
 golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=