Skip to content

feat: add sentry trace id to logs #831

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
mohammad-alisafaee wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

feat: add sentry trace id to logs #831

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions internal/login/login_server_routes.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ func (l *LoginServer) GetCallback(c echo.Context, params GetCallbackParams) erro
// Exchange the authorization code for credentials
err = echo.WrapHandler(handler(tokenCallback))(c)
if err != nil {
slog.Error("code exchange handler failed", "error", err, "requestID", utils.GetRequestID(c))
slog.Error("code exchange handler failed", "error", err, "requestID", utils.GetRequestID(c), "traceID", utils.GetTraceID(c))
return err
}
// Continue to the next authentication step
Expand Down Expand Up @@ -215,7 +215,7 @@ func (l *LoginServer) nextAuthStep(
if url == "" {
url = l.config.RenkuBaseURL.String()
}
slog.Info("login completed", "requestID", utils.GetRequestID(c), "appRedirectURL", url)
slog.Info("login completed", "requestID", utils.GetRequestID(c), "traceID", utils.GetTraceID(c), "appRedirectURL", url)
// Save the session: ensure we save the session before sending redirects
l.sessions.Save(c)
// send product metrics
Expand All @@ -235,7 +235,7 @@ func (l *LoginServer) nextAuthStep(
// Handle the login
handler, err := l.providerStore.AuthHandler(providerID, session.LoginState)
if err != nil {
slog.Error("auth handler failed", "error", err, "requestID", utils.GetRequestID(c))
slog.Error("auth handler failed", "error", err, "requestID", utils.GetRequestID(c), "traceID", utils.GetTraceID(c))
return err
}
// Save the session: ensure we save the session before sending redirects
Expand Down
5 changes: 3 additions & 2 deletions internal/oidc/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (

"github.com/SwissDataScienceCenter/renku-gateway/internal/config"
"github.com/SwissDataScienceCenter/renku-gateway/internal/models"
"github.com/SwissDataScienceCenter/renku-gateway/internal/utils"
"github.com/labstack/echo/v4"
"github.com/zitadel/oidc/v3/pkg/client/rp"
httphelper "github.com/zitadel/oidc/v3/pkg/http"
Expand Down Expand Up @@ -36,7 +37,7 @@ func (c *oidcClient) getCodeExchangeCallback(callback TokenSetCallback) func(
) {
id, err := models.ULIDGenerator{}.ID()
if err != nil {
slog.Error("generating token ID failed in token exchange", "error", err, "requestID", r.Header.Get(echo.HeaderXRequestID))
slog.Error("generating token ID failed in token exchange", "error", err, "requestID", r.Header.Get(echo.HeaderXRequestID), "traceID", utils.GetTraceIDFromHTTPRequest(r))
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}
Expand Down Expand Up @@ -70,7 +71,7 @@ func (c *oidcClient) getCodeExchangeCallback(callback TokenSetCallback) func(
}
err = callback(tokenSet)
if err != nil {
slog.Error("error when running tokens callback", "error", err, "requestID", r.Header.Get(echo.HeaderXRequestID))
slog.Error("error when running tokens callback", "error", err, "requestID", r.Header.Get(echo.HeaderXRequestID), "traceID", utils.GetTraceIDFromHTTPRequest(r))
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}
Expand Down
17 changes: 17 additions & 0 deletions internal/redirects/redirect_store.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import (
"time"

"github.com/SwissDataScienceCenter/renku-gateway/internal/config"
"github.com/SwissDataScienceCenter/renku-gateway/internal/utils"
"github.com/labstack/echo/v4"
)

Expand Down Expand Up @@ -168,6 +169,10 @@ func (rs *RedirectStore) Middleware() echo.MiddlewareFunc {
redirectUrl.String(),
"error",
err.Error(),
"requestID",
utils.GetRequestID(c),
"traceID",
utils.GetTraceID(c),
)
return c.NoContent(http.StatusNotFound)
}
Expand All @@ -176,6 +181,10 @@ func (rs *RedirectStore) Middleware() echo.MiddlewareFunc {
"REDIRECT_STORE MIDDLEWARE",
"message", "nil redirect found for url (this should not happen), returning 404",
"from", redirectUrl.String(),
"requestID",
utils.GetRequestID(c),
"traceID",
utils.GetTraceID(c),
)
return c.NoContent(http.StatusNotFound)
}
Expand All @@ -184,6 +193,10 @@ func (rs *RedirectStore) Middleware() echo.MiddlewareFunc {
"REDIRECT_STORE MIDDLEWARE",
"message", "no redirect found for url, returning 404",
"from", redirectUrl.String(),
"requestID",
utils.GetRequestID(c),
"traceID",
utils.GetTraceID(c),
)
return c.NoContent(http.StatusNotFound)
}
Expand All @@ -192,6 +205,10 @@ func (rs *RedirectStore) Middleware() echo.MiddlewareFunc {
"message", "redirecting request",
"from", redirectUrl.String(),
"to", entry.TargetUrl,
"requestID",
utils.GetRequestID(c),
"traceID",
utils.GetTraceID(c),
)
return c.Redirect(http.StatusMovedPermanently, entry.TargetUrl)
}
Expand Down
32 changes: 32 additions & 0 deletions internal/revproxy/auth.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ func InjectInHeader(headerKey string) AuthOption {
token.String(),
"requestID",
utils.GetRequestID(c),
"traceID",
utils.GetTraceID(c),
)
return nil
}
Expand All @@ -48,6 +50,8 @@ func InjectInHeader(headerKey string) AuthOption {
token.String(),
"requestID",
utils.GetRequestID(c),
"traceID",
utils.GetTraceID(c),
)
c.Request().Header.Set(headerKey, token.Value)
return nil
Expand All @@ -70,6 +74,8 @@ func InjectBearerToken() AuthOption {
token.String(),
"requestID",
utils.GetRequestID(c),
"traceID",
utils.GetTraceID(c),
)
return nil
}
Expand All @@ -85,6 +91,8 @@ func InjectBearerToken() AuthOption {
token.String(),
"requestID",
utils.GetRequestID(c),
"traceID",
utils.GetTraceID(c),
)
c.Request().Header.Set(echo.HeaderAuthorization, fmt.Sprintf("Bearer %s", token.Value))
return nil
Expand Down Expand Up @@ -156,6 +164,8 @@ func (a *Auth) Middleware() echo.MiddlewareFunc {
a.tokenType,
"requestID",
utils.GetRequestID(c),
"traceID",
utils.GetTraceID(c),
)
return next(c)
}
Expand Down Expand Up @@ -185,6 +195,8 @@ func (a *Auth) Middleware() echo.MiddlewareFunc {
a.tokenType,
"requestID",
utils.GetRequestID(c),
"traceID",
utils.GetTraceID(c),
)
return next(c)
case gwerrors.ErrTokenExpired:
Expand All @@ -200,6 +212,8 @@ func (a *Auth) Middleware() echo.MiddlewareFunc {
a.tokenType,
"requestID",
utils.GetRequestID(c),
"traceID",
utils.GetTraceID(c),
)
return next(c)
default:
Expand All @@ -217,6 +231,8 @@ func (a *Auth) Middleware() echo.MiddlewareFunc {
a.tokenType,
"requestID",
utils.GetRequestID(c),
"traceID",
utils.GetTraceID(c),
)
return next(c)
}
Expand Down Expand Up @@ -244,6 +260,8 @@ var notebooksGitlabAccessTokenInjector TokenInjector = func(c echo.Context, acce
accessToken.String(),
"requestID",
utils.GetRequestID(c),
"traceID",
utils.GetTraceID(c),
)
return nil
}
Expand Down Expand Up @@ -291,6 +309,8 @@ var notebooksGitlabAccessTokenInjector TokenInjector = func(c echo.Context, acce
accessToken.String(),
"requestID",
utils.GetRequestID(c),
"traceID",
utils.GetTraceID(c),
)
c.Request().Header.Set(headerKey, headerVal)
return nil
Expand All @@ -310,6 +330,8 @@ var coreSvcRenkuIdTokenInjector TokenInjector = func(c echo.Context, idToken mod
idToken.String(),
"requestID",
utils.GetRequestID(c),
"traceID",
utils.GetTraceID(c),
)
return nil
}
Expand All @@ -333,6 +355,8 @@ var coreSvcRenkuIdTokenInjector TokenInjector = func(c echo.Context, idToken mod
idToken.String(),
"requestID",
utils.GetRequestID(c),
"traceID",
utils.GetTraceID(c),
)
c.Request().Header.Set(headerKey, idToken.Value)
slog.Debug(
Expand All @@ -343,6 +367,8 @@ var coreSvcRenkuIdTokenInjector TokenInjector = func(c echo.Context, idToken mod
userId,
"requestID",
utils.GetRequestID(c),
"traceID",
utils.GetTraceID(c),
)
c.Request().Header.Set("Renku-user-id", userId)
c.Request().Header.Set("Renku-user-email", base64.StdEncoding.EncodeToString([]byte(email)))
Expand Down Expand Up @@ -375,6 +401,8 @@ var dataServiceGitlabAccessTokenInjector TokenInjector = func(c echo.Context, ac
accessToken.String(),
"requestID",
utils.GetRequestID(c),
"traceID",
utils.GetTraceID(c),
)
return nil
}
Expand All @@ -391,6 +419,8 @@ var dataServiceGitlabAccessTokenInjector TokenInjector = func(c echo.Context, ac
accessToken.String(),
"requestID",
utils.GetRequestID(c),
"traceID",
utils.GetTraceID(c),
)
c.Request().Header.Set(headerKey, accessToken.Value)
if accessToken.ExpiresAt.IsZero() {
Expand All @@ -407,6 +437,8 @@ var dataServiceGitlabAccessTokenInjector TokenInjector = func(c echo.Context, ac
accessToken.ExpiresAt,
"requestID",
utils.GetRequestID(c),
"traceID",
utils.GetTraceID(c),
)
return nil
}
6 changes: 3 additions & 3 deletions internal/revproxy/middlewares.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ func UiServerPathRewrite() echo.MiddlewareFunc {
}
c.Request().URL = newUrl
c.Request().RequestURI = newUrl.String()
slog.Debug("PATH REWRITE", "message", "matched /ui-server/auth", "originalURL", originalURL, "newUrl", newUrl.String(), "requestID", utils.GetRequestID(c))
slog.Debug("PATH REWRITE", "message", "matched /ui-server/auth", "originalURL", originalURL, "newUrl", newUrl.String(), "requestID", utils.GetRequestID(c), "traceID", utils.GetTraceID(c))
}
// For notebooks rewrite to go to the data service
if strings.HasPrefix(path, "/ui-server/api/notebooks") {
Expand All @@ -102,7 +102,7 @@ func UiServerPathRewrite() echo.MiddlewareFunc {
}
c.Request().URL = newUrl
c.Request().RequestURI = newUrl.String()
slog.Debug("PATH REWRITE", "message", "matched /ui-server/api/notebooks", "originalURL", originalURL, "newUrl", newUrl.String(), "requestID", utils.GetRequestID(c))
slog.Debug("PATH REWRITE", "message", "matched /ui-server/api/notebooks", "originalURL", originalURL, "newUrl", newUrl.String(), "requestID", utils.GetRequestID(c), "traceID", utils.GetTraceID(c))
}
// For all other endpoints the gateway will fully bypass the UI server routing things directly to the proper
// Renku component.
Expand All @@ -116,7 +116,7 @@ func UiServerPathRewrite() echo.MiddlewareFunc {
}
c.Request().URL = newUrl
c.Request().RequestURI = newUrl.String()
slog.Debug("PATH REWRITE", "message", "matched /ui-server/api", "originalURL", originalURL, "newUrl", newUrl.String(), "requestID", utils.GetRequestID(c))
slog.Debug("PATH REWRITE", "message", "matched /ui-server/api", "originalURL", originalURL, "newUrl", newUrl.String(), "requestID", utils.GetRequestID(c), "traceID", utils.GetTraceID(c))
}
return next(c)
}
Expand Down
2 changes: 1 addition & 1 deletion internal/revproxy/proxies.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ func proxyFromURL(url *url.URL) echo.MiddlewareFunc {
mwConfig := middleware.ProxyConfig{
// the skipper is used to log only
Skipper: func(c echo.Context) bool {
slog.Info("PROXY", "requestID", utils.GetRequestID(c), "destination", url.String())
slog.Info("PROXY", "requestID", utils.GetRequestID(c), "traceID", utils.GetTraceID(c), "destination", url.String())
return false
},
Balancer: middleware.NewRoundRobinBalancer([]*middleware.ProxyTarget{
Expand Down
4 changes: 4 additions & 0 deletions internal/sessions/session_store.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ func (sessions *SessionStore) Middleware() echo.MiddlewareFunc {
loadErr,
"requestID",
utils.GetRequestID(c),
"traceID",
utils.GetTraceID(c),
)
}
err := next(c)
Expand All @@ -64,6 +66,8 @@ func (sessions *SessionStore) Middleware() echo.MiddlewareFunc {
sessionID,
"requestID",
utils.GetRequestID(c),
"traceID",
utils.GetTraceID(c),
)
}
return err
Expand Down
11 changes: 11 additions & 0 deletions internal/utils/trace_id.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
package utils

import (
"net/http"

"github.com/getsentry/sentry-go"
sentryecho "github.com/getsentry/sentry-go/echo"
"github.com/labstack/echo/v4"
)
Expand All @@ -11,3 +14,11 @@ func GetTraceID(c echo.Context) string {
}
return ""
}

// GetTraceIDFromHTTPRequest extracts the trace ID from an http.Request.
func GetTraceIDFromHTTPRequest(r *http.Request) string {
if hub := sentry.GetHubFromContext(r.Context()); hub != nil {
return hub.GetTraceparent()
}
return ""
}
Loading