feat(observabillity): #115 integrate otel for metrics and traces

internal/handler/account.go

@@ -36,6 +36,8 @@ func (h AccountImpl) Handle(r *http.ServeMux) {
 
 func (h AccountImpl) handleAccountPage() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		user := middleware.GetUser(r)
 		if user == nil {
 			utils.DoRedirect(w, r, "/auth/signin")
@@ -55,6 +57,8 @@ func (h AccountImpl) handleAccountPage() http.HandlerFunc {
 
 func (h AccountImpl) handleAccountItemComp() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		user := middleware.GetUser(r)
 		if user == nil {
 			utils.DoRedirect(w, r, "/auth/signin")
@@ -86,6 +90,8 @@ func (h AccountImpl) handleAccountItemComp() http.HandlerFunc {
 
 func (h AccountImpl) handleUpdateAccount() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		user := middleware.GetUser(r)
 		if user == nil {
 			utils.DoRedirect(w, r, "/auth/signin")
@@ -119,6 +125,8 @@ func (h AccountImpl) handleUpdateAccount() http.HandlerFunc {
 
 func (h AccountImpl) handleDeleteAccount() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		user := middleware.GetUser(r)
 		if user == nil {
 			utils.DoRedirect(w, r, "/auth/signin")

internal/handler/auth.go

@@ -59,6 +59,8 @@ var (
 
 func (handler AuthImpl) handleSignInPage() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		user := middleware.GetUser(r)
 		if user != nil {
 			if !user.EmailVerified {
@@ -77,6 +79,8 @@ func (handler AuthImpl) handleSignInPage() http.HandlerFunc {
 
 func (handler AuthImpl) handleSignIn() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		user, err := utils.WaitMinimumTime(securityWaitDuration, func() (*types.User, error) {
 			session := middleware.GetSession(r)
 			email := r.FormValue("email")
@@ -112,6 +116,8 @@ func (handler AuthImpl) handleSignIn() http.HandlerFunc {
 
 func (handler AuthImpl) handleSignUpPage() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		user := middleware.GetUser(r)
 
 		if user != nil {
@@ -130,6 +136,8 @@ func (handler AuthImpl) handleSignUpPage() http.HandlerFunc {
 
 func (handler AuthImpl) handleSignUpVerifyPage() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		user := middleware.GetUser(r)
 		if user == nil {
 			utils.DoRedirect(w, r, "/auth/signin")
@@ -148,6 +156,8 @@ func (handler AuthImpl) handleSignUpVerifyPage() http.HandlerFunc {
 
 func (handler AuthImpl) handleVerifyResendComp() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		user := middleware.GetUser(r)
 		if user == nil {
 			utils.DoRedirect(w, r, "/auth/signin")
@@ -158,13 +168,15 @@ func (handler AuthImpl) handleVerifyResendComp() http.HandlerFunc {
 
 		_, err := w.Write([]byte("<p class=\"mt-8\">Verification email sent</p>"))
 		if err != nil {
-			log.Error("Could not write response: %v", err)
+			log.L.Error("Could not write response", "err", err)
 		}
 	}
 }
 
 func (handler AuthImpl) handleSignUpVerifyResponsePage() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		token := r.URL.Query().Get("token")
 
 		err := handler.service.VerifyUserEmail(token)
@@ -185,17 +197,19 @@ func (handler AuthImpl) handleSignUpVerifyResponsePage() http.HandlerFunc {
 
 func (handler AuthImpl) handleSignUp() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		var email = r.FormValue("email")
 		var password = r.FormValue("password")
 
-		_, err := utils.WaitMinimumTime(securityWaitDuration, func() (interface{}, error) {
-			log.Info("Signing up %v", email)
+		_, err := utils.WaitMinimumTime(securityWaitDuration, func() (any, error) {
+			log.L.Info("signing up", "email", email)
 			user, err := handler.service.SignUp(email, password)
 			if err != nil {
 				return nil, err
 			}
 
-			log.Info("Sending verification email to %v", user.Email)
+			log.L.Info("Sending verification email", "to", user.Email)
 			go handler.service.SendVerificationMail(user.Id, user.Email)
 			return nil, nil
 		})
@@ -221,6 +235,8 @@ func (handler AuthImpl) handleSignUp() http.HandlerFunc {
 
 func (handler AuthImpl) handleSignOut() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		session := middleware.GetSession(r)
 
 		if session != nil {
@@ -248,6 +264,8 @@ func (handler AuthImpl) handleSignOut() http.HandlerFunc {
 
 func (handler AuthImpl) handleDeleteAccountPage() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		user := middleware.GetUser(r)
 		if user == nil {
 			utils.DoRedirect(w, r, "/auth/signin")
@@ -261,6 +279,8 @@ func (handler AuthImpl) handleDeleteAccountPage() http.HandlerFunc {
 
 func (handler AuthImpl) handleDeleteAccountComp() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		user := middleware.GetUser(r)
 		if user == nil {
 			utils.DoRedirect(w, r, "/auth/signin")
@@ -285,6 +305,8 @@ func (handler AuthImpl) handleDeleteAccountComp() http.HandlerFunc {
 
 func (handler AuthImpl) handleChangePasswordPage() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		isPasswordReset := r.URL.Query().Has("token")
 
 		user := middleware.GetUser(r)
@@ -301,6 +323,8 @@ func (handler AuthImpl) handleChangePasswordPage() http.HandlerFunc {
 
 func (handler AuthImpl) handleChangePasswordComp() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		session := middleware.GetSession(r)
 		user := middleware.GetUser(r)
 		if session == nil || user == nil {
@@ -323,6 +347,8 @@ func (handler AuthImpl) handleChangePasswordComp() http.HandlerFunc {
 
 func (handler AuthImpl) handleForgotPasswordPage() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		user := middleware.GetUser(r)
 		if user != nil {
 			utils.DoRedirect(w, r, "/")
@@ -336,13 +362,15 @@ func (handler AuthImpl) handleForgotPasswordPage() http.HandlerFunc {
 
 func (handler AuthImpl) handleForgotPasswordComp() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		email := r.FormValue("email")
 		if email == "" {
 			utils.TriggerToastWithStatus(w, r, "error", "Please enter an email", http.StatusBadRequest)
 			return
 		}
 
-		_, err := utils.WaitMinimumTime(securityWaitDuration, func() (interface{}, error) {
+		_, err := utils.WaitMinimumTime(securityWaitDuration, func() (any, error) {
 			err := handler.service.SendForgotPasswordMail(email)
 			return nil, err
 		})
@@ -357,9 +385,11 @@ func (handler AuthImpl) handleForgotPasswordComp() http.HandlerFunc {
 
 func (handler AuthImpl) handleForgotPasswordResponseComp() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		pageUrl, err := url.Parse(r.Header.Get("Hx-Current-Url"))
 		if err != nil {
-			log.Error("Could not get current URL: %v", err)
+			log.L.Error("Could not get current URL", "err", err)
 			utils.TriggerToastWithStatus(w, r, "error", "Internal Server Error", http.StatusInternalServerError)
 			return
 		}

internal/handler/default.go

@@ -7,6 +7,9 @@ import (
 	"spend-sparrow/internal/service"
 	"spend-sparrow/internal/utils"
 	"strings"
+
+	"go.opentelemetry.io/otel/attribute"
+	"go.opentelemetry.io/otel/trace"
 )
 
 func handleError(w http.ResponseWriter, r *http.Request, err error) {
@@ -33,3 +36,11 @@ func extractErrorMessage(err error) string {
 
 	return strings.SplitN(errMsg, ":", 2)[0]
 }
+
+func updateSpan(r *http.Request) {
+	currentSpan := trace.SpanFromContext(r.Context())
+	if currentSpan != nil {
+		currentSpan.SetAttributes(attribute.String("http.pattern", r.Pattern))
+		currentSpan.SetAttributes(attribute.String("http.pattern.id", r.PathValue("id")))
+	}
+}

internal/handler/middleware/cache_control.go

@@ -3,10 +3,15 @@ package middleware
 import (
 	"net/http"
 	"strings"
+
+	"go.opentelemetry.io/otel"
 )
 
 func CacheControl(next http.Handler) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		counter, _ := otel.Meter("").Int64Counter("spend.sparrow.test")
+		counter.Add(r.Context(), 1)
+
 		shouldCache := strings.HasPrefix(r.URL.Path, "/static")
 
 		if !shouldCache {

internal/handler/middleware/cross_site_request_forgery.go

@@ -46,7 +46,7 @@ func CrossSiteRequestForgery(auth service.Auth) func(http.Handler) http.Handler
 				csrfToken := r.Header.Get("Csrf-Token")
 
 				if session == nil || csrfToken == "" || !auth.IsCsrfTokenValid(csrfToken, session.Id) {
-					log.Info("CSRF-Token \"%s\" not correct", csrfToken)
+					log.L.Info("CSRF-Token not correct", "token", csrfToken)
 					if r.Header.Get("Hx-Request") == "true" {
 						utils.TriggerToastWithStatus(w, r, "error", "CSRF-Token not correct", http.StatusBadRequest)
 					} else {

internal/handler/middleware/gzip.go

@@ -34,7 +34,7 @@ func Gzip(next http.Handler) http.Handler {
 
 		err := gz.Close()
 		if err != nil && !errors.Is(err, http.ErrBodyNotAllowed) {
-			log.Error("Gzip: could not close Writer: %v", err)
+			log.L.Error("Gzip: could not close Writer", "err", err)
 		}
 	})
 }

internal/handler/middleware/logger.go

@@ -2,23 +2,8 @@ package middleware
 
 import (
 	"net/http"
-	"strconv"
-	"time"
-
 	"spend-sparrow/internal/log"
-
-	"github.com/prometheus/client_golang/prometheus"
-	"github.com/prometheus/client_golang/prometheus/promauto"
-)
-
-var (
-	metrics = promauto.NewCounterVec(
-		prometheus.CounterOpts{
-			Name: "mefit_request_total",
-			Help: "The total number of requests processed",
-		},
-		[]string{"path", "method", "status"},
-	)
+	"time"
 )
 
 type WrappedWriter struct {
@@ -35,13 +20,19 @@ func Log(next http.Handler) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		start := time.Now()
 
+		log.L.Info("request pattern", "pattern", r.Pattern)
+
 		wrapped := &WrappedWriter{
 			ResponseWriter: w,
 			StatusCode:     http.StatusOK,
 		}
 		next.ServeHTTP(wrapped, r)
 
-		log.Info(r.RemoteAddr + " " + strconv.Itoa(wrapped.StatusCode) + " " + r.Method + " " + r.URL.Path + " " + time.Since(start).String())
-		metrics.WithLabelValues(r.URL.Path, r.Method, http.StatusText(wrapped.StatusCode)).Inc()
+		log.L.Info("request",
+			"remoteAddr", r.RemoteAddr,
+			"status", wrapped.StatusCode,
+			"method", r.Method,
+			"path", r.URL.Path,
+			"duration", time.Since(start).String())
 	})
 }

internal/handler/render.go

@@ -1,13 +1,12 @@
 package handler
 
 import (
+	"net/http"
 	"spend-sparrow/internal/log"
 	"spend-sparrow/internal/template"
 	"spend-sparrow/internal/template/auth"
 	"spend-sparrow/internal/types"
 
-	"net/http"
-
 	"github.com/a-h/templ"
 )
 
@@ -23,7 +22,7 @@ func (render *Render) RenderWithStatus(r *http.Request, w http.ResponseWriter, c
 	w.WriteHeader(status)
 	err := comp.Render(r.Context(), w)
 	if err != nil {
-		log.Error("Failed to render layout: %v", err)
+		log.L.Error("Failed to render layout", "err", err)
 		http.Error(w, "Internal Server Error", http.StatusInternalServerError)
 	}
 }

internal/handler/root_and_404.go

@@ -29,6 +29,8 @@ func (handler IndexImpl) Handle(router *http.ServeMux) {
 
 func (handler IndexImpl) handleRootAnd404() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		user := middleware.GetUser(r)
 
 		var comp templ.Component
@@ -52,6 +54,8 @@ func (handler IndexImpl) handleRootAnd404() http.HandlerFunc {
 
 func (handler IndexImpl) handleEmpty() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		// Return nothing
 	}
 }

internal/handler/transaction.go

@@ -13,6 +13,8 @@ import (
 
 	"github.com/a-h/templ"
 	"github.com/google/uuid"
+	"go.opentelemetry.io/otel/attribute"
+	"go.opentelemetry.io/otel/trace"
 )
 
 type Transaction interface {
@@ -45,12 +47,17 @@ func (h TransactionImpl) Handle(r *http.ServeMux) {
 
 func (h TransactionImpl) handleTransactionPage() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		user := middleware.GetUser(r)
 		if user == nil {
 			utils.DoRedirect(w, r, "/auth/signin")
 			return
 		}
 
+		currentSpan := trace.SpanFromContext(r.Context())
+		currentSpan.SetAttributes(attribute.String("", "test"))
+
 		filter := types.TransactionItemsFilter{
 			AccountId:       r.URL.Query().Get("account-id"),
 			TreasureChestId: r.URL.Query().Get("treasure-chest-id"),
@@ -89,12 +96,16 @@ func (h TransactionImpl) handleTransactionPage() http.HandlerFunc {
 
 func (h TransactionImpl) handleTransactionItemComp() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		user := middleware.GetUser(r)
 		if user == nil {
 			utils.DoRedirect(w, r, "/auth/signin")
 			return
 		}
 
+		// log.L.Info("request", "pattern", r.Pattern, "path", r.URL.Path, "method", r.Method, "path", r.URL.Path)
+
 		accounts, err := h.account.GetAll(user)
 		if err != nil {
 			handleError(w, r, err)
@@ -133,6 +144,8 @@ func (h TransactionImpl) handleTransactionItemComp() http.HandlerFunc {
 
 func (h TransactionImpl) handleUpdateTransaction() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		user := middleware.GetUser(r)
 		if user == nil {
 			utils.DoRedirect(w, r, "/auth/signin")
@@ -233,6 +246,8 @@ func (h TransactionImpl) handleUpdateTransaction() http.HandlerFunc {
 
 func (h TransactionImpl) handleRecalculate() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		user := middleware.GetUser(r)
 		if user == nil {
 			utils.DoRedirect(w, r, "/auth/signin")
@@ -251,6 +266,8 @@ func (h TransactionImpl) handleRecalculate() http.HandlerFunc {
 
 func (h TransactionImpl) handleDeleteTransaction() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		user := middleware.GetUser(r)
 		if user == nil {
 			utils.DoRedirect(w, r, "/auth/signin")

internal/handler/transaction_recurring.go

@@ -33,6 +33,8 @@ func (h TransactionRecurringImpl) Handle(r *http.ServeMux) {
 
 func (h TransactionRecurringImpl) handleTransactionRecurringItemComp() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		user := middleware.GetUser(r)
 		if user == nil {
 			utils.DoRedirect(w, r, "/auth/signin")
@@ -48,6 +50,8 @@ func (h TransactionRecurringImpl) handleTransactionRecurringItemComp() http.Hand
 
 func (h TransactionRecurringImpl) handleUpdateTransactionRecurring() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		user := middleware.GetUser(r)
 		if user == nil {
 			utils.DoRedirect(w, r, "/auth/signin")
@@ -85,6 +89,8 @@ func (h TransactionRecurringImpl) handleUpdateTransactionRecurring() http.Handle
 
 func (h TransactionRecurringImpl) handleDeleteTransactionRecurring() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		user := middleware.GetUser(r)
 		if user == nil {
 			utils.DoRedirect(w, r, "/auth/signin")

internal/handler/treasure_chest.go

@@ -40,6 +40,8 @@ func (h TreasureChestImpl) Handle(r *http.ServeMux) {
 
 func (h TreasureChestImpl) handleTreasureChestPage() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		user := middleware.GetUser(r)
 		if user == nil {
 			utils.DoRedirect(w, r, "/auth/signin")
@@ -67,6 +69,8 @@ func (h TreasureChestImpl) handleTreasureChestPage() http.HandlerFunc {
 
 func (h TreasureChestImpl) handleTreasureChestItemComp() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		user := middleware.GetUser(r)
 		if user == nil {
 			utils.DoRedirect(w, r, "/auth/signin")
@@ -112,6 +116,8 @@ func (h TreasureChestImpl) handleTreasureChestItemComp() http.HandlerFunc {
 
 func (h TreasureChestImpl) handleUpdateTreasureChest() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		user := middleware.GetUser(r)
 		if user == nil {
 			utils.DoRedirect(w, r, "/auth/signin")
@@ -155,6 +161,8 @@ func (h TreasureChestImpl) handleUpdateTreasureChest() http.HandlerFunc {
 
 func (h TreasureChestImpl) handleDeleteTreasureChest() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
+		updateSpan(r)
+
 		user := middleware.GetUser(r)
 		if user == nil {
 			utils.DoRedirect(w, r, "/auth/signin")