Skip to content
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

Jump to bottom

chore!: Make route path as transaction name in gin performance #675

Merged
merged 11 commits into from
Sep 4, 2023
Merged

chore!: Make route path as transaction name in gin performance #675

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
6683050
Remove http method from transaction name
Jul 27, 2023
2a286b0
Use gin full path as transaction name
Jul 27, 2023
359dd8e
Change transaction source to route
Jul 27, 2023
de4e6e9
Include HTTP Method into transaction name for gin
Jul 27, 2023
5a94ba1
Handle error in sentry gin test
Jul 27, 2023
ba3e92d
Merge branch 'master' into sentry-transaction-improvement
antonsacred Jul 28, 2023
3b50c09
Set real path for gin transaction on 404
antonsacred Aug 14, 2023
c1edc11
Improve gin transaction tests with different paths for router and req…
antonsacred Aug 14, 2023
26eb2af
Merge branch 'master' into sentry-transaction-improvement
antonsacred Aug 21, 2023
67593bd
Choose transaction source and name depending on found route
Sep 1, 2023
0994233
Merge branch 'master' into sentry-transaction-improvement
Sep 1, 2023
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
15 changes: 13 additions & 2 deletions gin/sentrygin.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,14 +60,25 @@ func (h *handler) handle(c *gin.Context) {

hub.Client().SetSDKIdentifier(sdkIdentifier)

var transactionName string
var transactionSource sentry.TransactionSource

if c.FullPath() != "" {
transactionName = c.FullPath()
transactionSource = sentry.SourceRoute
} else {
transactionName = c.Request.URL.Path
transactionSource = sentry.SourceURL
}

options := []sentry.SpanOption{
sentry.WithOpName("http.server"),
sentry.ContinueFromRequest(c.Request),
sentry.WithTransactionSource(sentry.SourceURL),
sentry.WithTransactionSource(transactionSource),
}

transaction := sentry.StartTransaction(ctx,
fmt.Sprintf("%s %s", c.Request.Method, c.Request.URL.Path),
fmt.Sprintf("%s %s", c.Request.Method, transactionName),
options...,
)
defer func() {
Expand Down
108 changes: 70 additions & 38 deletions gin/sentrygin_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,54 +22,79 @@ func TestIntegration(t *testing.T) {
largePayload := strings.Repeat("Large", 3*1024) // 15 KB

tests := []struct {
Path string
Method string
WantStatus int
Body string
Handler gin.HandlerFunc
RequestPath string
RoutePath string
Method string
WantStatus int
Body string
Handler gin.HandlerFunc

WantEvent *sentry.Event
WantTransaction *sentry.Event
}{
{
Path: "/panic",
Method: "GET",
WantStatus: 200,
RequestPath: "/panic/1",
RoutePath: "/panic/:id",
Method: "GET",
WantStatus: 200,
Handler: func(c *gin.Context) {
panic("test")
},
WantTransaction: &sentry.Event{
Level: sentry.LevelInfo,
Type: "transaction",
Transaction: "GET /panic",
Transaction: "GET /panic/:id",
Request: &sentry.Request{
URL: "/panic",
URL: "/panic/1",
Method: "GET",
Headers: map[string]string{
"Accept-Encoding": "gzip",
"User-Agent": "Go-http-client/1.1",
},
},
TransactionInfo: &sentry.TransactionInfo{Source: "url"},
TransactionInfo: &sentry.TransactionInfo{Source: "route"},
},
WantEvent: &sentry.Event{
Level: sentry.LevelFatal,
Message: "test",
Request: &sentry.Request{
URL: "/panic",
URL: "/panic/1",
Method: "GET",
Headers: map[string]string{
"Accept-Encoding": "gzip",
"User-Agent": "Go-http-client/1.1",
},
},
},
},
{
RequestPath: "/404/1",
RoutePath: "",
Method: "GET",
WantStatus: 404,
Handler: nil,
WantTransaction: &sentry.Event{
Level: sentry.LevelInfo,
Type: "transaction",
Transaction: "GET /404/1",
Request: &sentry.Request{
URL: "/404/1",
Method: "GET",
Headers: map[string]string{
"Accept-Encoding": "gzip",
"User-Agent": "Go-http-client/1.1",
},
},
TransactionInfo: &sentry.TransactionInfo{Source: "url"},
},
WantEvent: nil,
},
{
Path: "/post",
Method: "POST",
WantStatus: 200,
Body: "payload",
RequestPath: "/post",
RoutePath: "/post",
Method: "POST",
WantStatus: 200,
Body: "payload",
Handler: func(c *gin.Context) {
hub := sentry.GetHubFromContext(c.Request.Context())
body, err := io.ReadAll(c.Request.Body)
Expand All @@ -93,7 +118,7 @@ func TestIntegration(t *testing.T) {
"User-Agent": "Go-http-client/1.1",
},
},
TransactionInfo: &sentry.TransactionInfo{Source: "url"},
TransactionInfo: &sentry.TransactionInfo{Source: "route"},
},
WantEvent: &sentry.Event{
Level: sentry.LevelInfo,
Expand All @@ -111,9 +136,10 @@ func TestIntegration(t *testing.T) {
},
},
{
Path: "/get",
Method: "GET",
WantStatus: 200,
RequestPath: "/get",
RoutePath: "/get",
Method: "GET",
WantStatus: 200,
Handler: func(c *gin.Context) {
hub := sentry.GetHubFromContext(c.Request.Context())
hub.CaptureMessage("get")
Expand All @@ -131,7 +157,7 @@ func TestIntegration(t *testing.T) {
"User-Agent": "Go-http-client/1.1",
},
},
TransactionInfo: &sentry.TransactionInfo{Source: "url"},
TransactionInfo: &sentry.TransactionInfo{Source: "route"},
},
WantEvent: &sentry.Event{
Level: sentry.LevelInfo,
Expand All @@ -147,10 +173,11 @@ func TestIntegration(t *testing.T) {
},
},
{
Path: "/post/large",
Method: "POST",
WantStatus: 200,
Body: largePayload,
RequestPath: "/post/large",
RoutePath: "/post/large",
Method: "POST",
WantStatus: 200,
Body: largePayload,
Handler: func(c *gin.Context) {
hub := sentry.GetHubFromContext(c.Request.Context())
body, err := io.ReadAll(c.Request.Body)
Expand All @@ -172,7 +199,7 @@ func TestIntegration(t *testing.T) {
"User-Agent": "Go-http-client/1.1",
},
},
TransactionInfo: &sentry.TransactionInfo{Source: "url"},
TransactionInfo: &sentry.TransactionInfo{Source: "route"},
},
WantEvent: &sentry.Event{
Level: sentry.LevelInfo,
Expand All @@ -191,10 +218,11 @@ func TestIntegration(t *testing.T) {
},
},
{
Path: "/post/body-ignored",
Method: "POST",
WantStatus: 200,
Body: "client sends, server ignores, SDK doesn't read",
RequestPath: "/post/body-ignored",
RoutePath: "/post/body-ignored",
Method: "POST",
WantStatus: 200,
Body: "client sends, server ignores, SDK doesn't read",
Handler: func(c *gin.Context) {
hub := sentry.GetHubFromContext(c.Request.Context())
hub.CaptureMessage("body ignored")
Expand All @@ -214,7 +242,7 @@ func TestIntegration(t *testing.T) {
"User-Agent": "Go-http-client/1.1",
},
},
TransactionInfo: &sentry.TransactionInfo{Source: "url"},
TransactionInfo: &sentry.TransactionInfo{Source: "route"},
},
WantEvent: &sentry.Event{
Level: sentry.LevelInfo,
Expand All @@ -233,9 +261,10 @@ func TestIntegration(t *testing.T) {
},
},
{
Path: "/badreq",
Method: "GET",
WantStatus: 400,
RequestPath: "/badreq",
RoutePath: "/badreq",
Method: "GET",
WantStatus: 400,
Handler: func(c *gin.Context) {
c.JSON(http.StatusBadRequest, gin.H{"status": "bad_request"})
},
Expand All @@ -251,7 +280,7 @@ func TestIntegration(t *testing.T) {
"User-Agent": "Go-http-client/1.1",
},
},
TransactionInfo: &sentry.TransactionInfo{Source: "url"},
TransactionInfo: &sentry.TransactionInfo{Source: "route"},
},
WantEvent: nil,
},
Expand Down Expand Up @@ -279,7 +308,7 @@ func TestIntegration(t *testing.T) {
router.Use(sentrygin.New(sentrygin.Options{}))

for _, tt := range tests {
router.Handle(tt.Method, tt.Path, tt.Handler)
router.Handle(tt.Method, tt.RoutePath, tt.Handler)
}

srv := httptest.NewServer(router)
Expand All @@ -304,7 +333,7 @@ func TestIntegration(t *testing.T) {
wanttrans = append(wanttrans, tt.WantTransaction)
wantCodes = append(wantCodes, sentry.HTTPtoSpanStatus(tt.WantStatus))

req, err := http.NewRequest(tt.Method, srv.URL+tt.Path, strings.NewReader(tt.Body))
req, err := http.NewRequest(tt.Method, srv.URL+tt.RequestPath, strings.NewReader(tt.Body))
if err != nil {
t.Fatal(err)
}
Expand All @@ -315,7 +344,10 @@ func TestIntegration(t *testing.T) {
if res.StatusCode != tt.WantStatus {
t.Errorf("Status code = %d expected: %d", res.StatusCode, tt.WantStatus)
}
res.Body.Close()
err = res.Body.Close()
if err != nil {
t.Fatal(err)
}
}

if ok := sentry.Flush(testutils.FlushTimeout()); !ok {
Expand Down