Echo
Echo is a high-performance web framework for building robust and scalable applications in Go. Learn how to set it up with Sentry.
For a quick reference, there is a complete example at the Go SDK source code repository.
Go Dev-style API documentation is also available.
go get github.com/getsentry/sentry-go
go get github.com/getsentry/sentry-go/echo
err := sentry.Init(sentry.ClientOptions{
Dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
// Enable printing of SDK debug messages.
// Useful when getting started or trying to figure something out.
Debug: true,
// Adds request headers and IP for users,
// visit: https://docs.sentry.io/platforms/go/data-management/data-collected/ for more info
SendDefaultPII: true,
// performance
EnableTracing: true,
// Set TracesSampleRate to 1.0 to capture 100%
// of transactions for tracing.
TracesSampleRate: 1.0,
// performance
// logs
EnableLogs: true,
// logs
})
if err != nil {
log.Fatalf("sentry.Init: %s", err)
}
// Flush buffered events before the program terminates.
// Set the timeout to the maximum duration the program can afford to wait.
defer sentry.Flush(2 * time.Second)
sentryecho
accepts a struct of Options
that allows you to configure how the handler will behave.
// Repanic configures whether Sentry should repanic after recovery, in most cases it should be set to true,
// as echo includes its own Recover middleware that handles http responses.
Repanic bool
// WaitForDelivery configures whether you want to block the request before moving forward with the response.
// Because Echo's `Recover` handler doesn't restart the application,
// it's safe to either skip this option or set it to `false`.
WaitForDelivery bool
// Timeout for the event delivery requests.
Timeout time.Duration
app := echo.New()
app.Use(sentryecho.New(sentryecho.Options{
// you can modify these options
Repanic: true,
WaitForDelivery: false,
Timeout: 5 * time.Second,
}))
app := echo.New()
app.Use(middleware.Logger())
app.Use(middleware.Recover())
// Attach the sentryecho handler as one of your middlewares
app.Use(sentryecho.New(sentryecho.Options{
// specify options here...
}))
// Set up routes
app.GET("/", func(ctx echo.Context) error {
// capturing an error intentionally to simulate usage
sentry.CaptureMessage("It works!")
return ctx.String(http.StatusOK, "Hello, World!")
})
app.Logger.Fatal(app.Start(":3000"))
sentryecho
attaches an instance of *sentry.Hub
(https://pkg.go.dev/github.com/getsentry/sentry-go#Hub) to the echo.Context
, which makes it available throughout the rest of the request's lifetime. You can access it by using the sentryecho.GetHubFromContext()
method on the context itself in any of your proceeding middleware and routes. And it should be used instead of the global sentry.CaptureMessage
, sentry.CaptureException
or any other calls, as it keeps the separation of data between the requests.
Keep in mind that *sentry.Hub
won't be available in middleware attached before sentryecho
!
app := echo.New()
app.Use(middleware.Logger())
app.Use(middleware.Recover())
app.Use(sentryecho.New(sentryecho.Options{
Repanic: true,
}))
app.Use(func(next echo.HandlerFunc) echo.HandlerFunc {
return func(ctx echo.Context) error {
if hub := sentryecho.GetHubFromContext(ctx); hub != nil {
hub.Scope().SetTag("someRandomTag", "maybeYouNeedIt")
}
return next(ctx)
}
})
app.GET("/", func(ctx echo.Context) error {
if hub := sentryecho.GetHubFromContext(ctx); hub != nil {
hub.WithScope(func(scope *sentry.Scope) {
scope.SetExtra("unwantedQuery", "someQueryDataMaybe")
hub.CaptureMessage("User provided unwanted query string, but we recovered just fine")
})
}
return ctx.String(http.StatusOK, "Hello, World!")
})
app.GET("/foo", func(ctx echo.Context) error {
// sentryecho handler will catch it just fine. Also, because we attached "someRandomTag"
// in the middleware before, it will be sent through as well
panic("y tho")
})
app.Logger.Fatal(app.Start(":3000"))
sentry.Init(sentry.ClientOptions{
Dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
BeforeSend: func(event *sentry.Event, hint *sentry.EventHint) *sentry.Event {
if hint.Context != nil {
if req, ok := hint.Context.Value(sentry.RequestContextKey).(*http.Request); ok {
// You have access to the original Request here
}
}
return event
},
})
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").