SENTRY.md

ca-go/sentry

The sentry package enables you to configure Sentry for error reporting. A general ReportError function is provided for ad-hoc reporting, as well as several options for middleware. These middleware detect and report errors automatically.

Examples

See the examples below and on individual functions for more details on usage.

Example Init

You configure and initialise sentry using Init():

	err := sentry.Init(
	         sentry.WithDSN(os.Getenv("SENTRY_DSN")),
	         sentry.WithRelease(os.Getenv("APP"), os.Getenv("APP_VERSION")),
	         sentry.WithEnvironment(os.Getenv("AWS_ENVIRONMENT_NAME")))
	if err != nil {
	  // handle initialisation error
	}

Example ReportError

Ad-hoc errors can be reported using ReportError():

	sentry.ReportError(ctx, errors.New("We hit a snag!"))

Example Middleware

For application without middleware, Panic can be captured and reported to sentry in main before the program exits in main.

	defer func() {
	  if err := recover(); err != nil {
	    sentry.GracefullyShutdown(err, timeout)
	}()

For application with middleware, HTTP middleware can be used. Passing in nil uses the default panic handler. See the OnRequestPanicHandler type if you wish to supply your own.

	mw := middleware.NewHTTPMiddleware(nil)
	mw(myHTTPHandler)

Example GOA usage

Goa middleware can be used, allowing errors to be reported automatically from Goa applications:

	mw := sentry.NewGoaMiddleware()
	mw(myGoaEndpoint)

This is recommended when using Goa, as it offers reporting of all errors returned from the generated logic types.

Example Lambda usage

This package also supports middleware for Lambda functions:

	mw := sentry.NewLambdaMiddleware(errorreport.LambdaErrorOptions{})