fix: sentry request logging

chore: attach release version info to sentry events

config/config.go

@@ -470,13 +470,14 @@ func Get() *Config {
 
 func Load(configFlag string, version string) *Config {
 	config := &Config{}
-
 	if err := configor.New(&configor.Config{}).Load(config, configFlag); err != nil {
 		Log().Fatal("failed to read config", "error", err)
 	}
 
 	env = config.Env
 
+	InitLogger(config.IsDev())
+
 	config.Version = strings.TrimSpace(version)
 	tagVersionMatch, _ := regexp.MatchString(`\d+\.\d+\.\d+`, version)
 	if tagVersionMatch {
@@ -514,7 +515,7 @@ func Load(configFlag string, version string) *Config {
 			config.Sentry.Environment = config.Env
 		}
 		slog.Info("enabling sentry integration", "environment", config.Sentry.Environment)
-		initSentry(config.Sentry, config.IsDev())
+		initSentry(config.Sentry, config.IsDev(), config.Version)
 	}
 
 	if config.App.DataRetentionMonths <= 0 {

config/logging.go

@@ -0,0 +1,16 @@
+package config
+
+import (
+	"log/slog"
+	"os"
+)
+
+func InitLogger(isDev bool) {
+	var handler slog.Handler
+	if isDev {
+		handler = slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{Level: slog.LevelDebug})
+	} else {
+		handler = slog.NewJSONHandler(os.Stdout, &slog.HandlerOptions{Level: slog.LevelInfo})
+	}
+	slog.SetDefault(slog.New(handler))
+}

config/sentry.go

@@ -45,7 +45,11 @@ func (l *SentryLogger) Fatal(msg string, args ...any) {
 }
 
 func (l *SentryLogger) Request(r *http.Request) *slog.Logger {
-	return l.Logger.With(slog.Any("http_request", r))
+	l.Logger = l.Logger.With("request", r)
+	if uid := getPrincipal(r); uid != "" {
+		l.Logger = l.Logger.With(slog.Group("user", slog.String("id", uid)))
+	}
+	return l.Logger
 }
 
 var excludedRoutes = []string{
@@ -55,11 +59,12 @@ var excludedRoutes = []string{
 	"GET /docs",
 }
 
-func initSentry(config sentryConfig, debug bool) {
+func initSentry(config sentryConfig, debug bool, releaseVersion string) {
 	if err := sentry.Init(sentry.ClientOptions{
 		Dsn:              config.Dsn,
 		Debug:            debug,
 		Environment:      config.Environment,
+		Release:          releaseVersion,
 		AttachStacktrace: true,
 		EnableTracing:    config.EnableTracing,
 		TracesSampler: func(ctx sentry.SamplingContext) float64 {
@@ -75,12 +80,7 @@ func initSentry(config sentryConfig, debug bool) {
 			return float64(config.SampleRate)
 		},
 		BeforeSend: func(event *sentry.Event, hint *sentry.EventHint) *sentry.Event {
-			r, ok := event.Contexts["extra"]["http_request"]
-			if ok {
-				if uid := getPrincipal(r.(*http.Request)); uid != "" {
-					event.User.ID = uid
-				}
-			}
+			// optional pre-processing before sending the event off
 			return event
 		},
 	}); err != nil {

go.mod

@@ -42,11 +42,6 @@ require (
 	gorm.io/gorm v1.25.11
 )
 
-require (
-	github.com/samber/lo v1.44.0 // indirect
-	github.com/samber/slog-common v0.17.0 // indirect
-)
-
 require (
 	filippo.io/edwards25519 v1.1.0 // indirect
 	github.com/BurntSushi/toml v1.4.0 // indirect
@@ -79,6 +74,8 @@ require (
 	github.com/ncruces/go-strftime v0.1.9 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec // indirect
+	github.com/samber/lo v1.44.0 // indirect
+	github.com/samber/slog-common v0.17.0 // indirect
 	github.com/samber/slog-sentry/v2 v2.8.0
 	github.com/stretchr/objx v0.5.2 // indirect
 	github.com/swaggo/files v1.0.1 // indirect

main.go

@@ -124,8 +124,6 @@ func main() {
 	// Configure Swagger docs
 	docs.SwaggerInfo.BasePath = config.Server.BasePath + "/api"
 
-	initLogger()
-
 	slog.Info("Wakapi", "version", version)
 
 	// Set up GORM
@@ -440,14 +438,3 @@ func listen(handler http.Handler) {
 
 	<-make(chan interface{}, 1)
 }
-
-func initLogger() {
-	var handler slog.Handler
-	if config.IsDev() {
-		handler = slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{Level: slog.LevelDebug})
-	} else {
-		handler = slog.NewJSONHandler(os.Stdout, &slog.HandlerOptions{Level: slog.LevelInfo})
-	}
-	l := slog.New(handler)
-	slog.SetDefault(l)
-}

middlewares/logging.go

@@ -1,6 +1,7 @@
 package middlewares
 
 // Borrowed from https://gist.github.com/elithrar/887d162dfd0c539b700ab4049c76e22b
+// Alternatively, we could use https://github.com/samber/slog-chi, however, it pulls in another bunch of dependencies and log messages are more verbose and feel almost little bloated
 
 import (
 	"io"