Migrate to sentry-go

Overview

The github.com/getsentry/raven-go was deprecated in favor of github.com/getsentry/sentry-go. Update the dependency to the latest a version of github.com/getsentry/sentry-go and remove raven-go as a dependency, following the migration guide.

This update does not break any downstream clients to keep backward compatibility. We cannot completely remove the raven-go dependency since we have correlation/raven package (deprecated) that exposes raven specific information.

Testing

I've used the following code snippet to test the changes in labkit

main.go

func main() {
	errortracking.Initialize(errortracking.WithSentryDSN("https://0f1ec4d29b3e4172ae8a8554f5a2efbb@sentry.io/1467104"))

	req, err := http.NewRequest("GET", "http://example.com?test=here", nil)
	ctx := labkitctx.ContextWithCorrelation(req.Context(), "thisIsContextID")

	req.Header.Add("test", "another")

	err = errors.New("some error")

	// Send the error to the error tracking system
	errortracking.Capture(err,
		errortracking.WithContext(ctx),                          // Extract details such as correlation-id from context
		errortracking.WithRequest(req),                          // Extract additional details from request
		errortracking.WithField("domain", "http://example.com"), // Add additional custom details
		errortracking.WithField("steve", "test"),
	)

	time.Sleep(time.Minute)
}

If we look at the screenshot below the new sentry-go library finds more information out of the box as well.

raven-go	sentry-go

Breaking Change

We had to change the signature of CapatureOption since we can't use the old raven structs for this.

If anyone using the default CaptureOption that we provide they will not see any changes, but if they build their own CaptureOption this will break since the signature changed.

Closes #5 (closed)

errortracking/capture_request.go

@@ -3,29 +3,35 @@ package errortracking
 import (
 	"net/http"
 
-	"github.com/getsentry/raven-go"
+	"github.com/getsentry/sentry-go"
+
 	"gitlab.com/gitlab-org/labkit/mask"
 )
 
 // WithRequest will capture details of the request along with the error
 func WithRequest(r *http.Request) CaptureOption {
-	return func(interfaces ravenInterfaces, _ raven.Extra) ravenInterfaces {
-		cleanHeadersForRaven(r)
-		return append(interfaces, raven.NewHttp(r))
+	return func(event *sentry.Event) {
+		event.Request = redactRequestInfo(r)
+		event.Request.URL = r.URL.String()
+		event.Request.Headers["host"] = r.URL.Hostname()
+		event.Request.Method = r.Method
 	}
 }
 
-// cleanHeadersForRaven strips out information
-// that shouldn't be send by the client
-func cleanHeadersForRaven(r *http.Request) *raven.Http {
+// redactRequestInfo strips out information that shouldn't be send by the client
+func redactRequestInfo(r *http.Request) sentry.Request {
 	if r == nil {
-		return nil
+		return sentry.Request{}
+	}
+
+	req := sentry.Request{
+		Headers: make(map[string]string),
 	}
 
-	report := raven.NewHttp(r)
-	for header := range report.Headers {
+	for header, v := range r.Header {
+		req.Headers[header] = v[0]
 		if mask.IsSensitiveHeader(header) {
-			report.Headers[header] = mask.RedactionString
+			req.Headers[header] = mask.RedactionString
 		}
 	}
 
@@ -37,7 +43,7 @@ func cleanHeadersForRaven(r *http.Request) *raven.Http {
 			}
 		}
 	}
-	report.Query = params.Encode()
+	req.QueryString = params.Encode()
 
-	return report
+	return req
 }