-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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.
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
Update Go docs #9992
Merged
Merged
Update Go docs #9992
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| --- | ||
| title: Fiber | ||
| description: "Learn how to add Sentry instrumentation to programs using the Fiber package." | ||
| --- | ||
|
|
||
| package. | ||
|
|
||
| The Sentry Go SDK repository has a [complete | ||
| example](https://github.com/getsentry/sentry-go/tree/master/_examples/fiber) | ||
| of how to set up Sentry for a Fiber app. | ||
|
|
||
| For additional reference, see the [`sentryfiber` API | ||
| documentation](https://godoc.org/github.com/getsentry/sentry-go/fiber). | ||
|
|
||
| ## Install | ||
|
|
||
| ```shell | ||
| go get github.com/getsentry/sentry-go/fiber | ||
| ``` | ||
|
|
||
| <Break /> | ||
|
|
||
| <SignInNote /> | ||
|
|
||
| ```go | ||
| import ( | ||
| "fmt" | ||
| "net/http" | ||
|
|
||
| "github.com/getsentry/sentry-go" | ||
| sentryfiber "github.com/getsentry/sentry-go/fiber" | ||
| ) | ||
|
|
||
| // To initialize Sentry's handler, you need to initialize Sentry itself beforehand | ||
| if err := sentry.Init(sentry.ClientOptions{ | ||
| Dsn: "___PUBLIC_DSN___", | ||
| EnableTracing: true, | ||
| // Set TracesSampleRate to 1.0 to capture 100% | ||
| // of transactions for performance monitoring. | ||
| // We recommend adjusting this value in production, | ||
| TracesSampleRate: 1.0, | ||
| }); err != nil { | ||
| fmt.Printf("Sentry initialization failed: %v\n", err) | ||
| } | ||
|
|
||
| // Later in the code | ||
| sentryHandler := sentryfiber.New(sentryfiber.Options{ | ||
| Repanic: true, | ||
| WaitForDelivery: true, | ||
| }) | ||
|
|
||
| enhanceSentryEvent := func(ctx *fiber.Ctx) error { | ||
| if hub := sentryfiber.GetHubFromContext(ctx); hub != nil { | ||
| hub.Scope().SetTag("someRandomTag", "maybeYouNeedIt") | ||
| } | ||
| return ctx.Next() | ||
| } | ||
|
|
||
| app := fiber.New() | ||
|
|
||
| app.Use(sentryHandler) | ||
|
|
||
| app.All("/foo", enhanceSentryEvent, func(c *fiber.Ctx) error { | ||
| panic("y tho") | ||
| }) | ||
|
|
||
| app.All("/", func(ctx *fiber.Ctx) error { | ||
| if hub := sentryfiber.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.SendStatus(fiber.StatusOK) | ||
| }) | ||
|
|
||
| if err := app.Listen(":3000"); err != nil { | ||
| panic(err) | ||
| } | ||
| ``` | ||
|
|
||
| ## Configure | ||
|
|
||
| `sentryfiber` accepts a struct of `Options` that allows you to configure how the handler will behave. | ||
|
|
||
| Currently, it respects three options: | ||
|
|
||
| ```go | ||
| // Repanic configures whether Sentry should repanic after recovery, in most cases it should be set to true, | ||
| // as fiber 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 Fiber'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 | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| `sentryfiber` attaches an instance of `*sentry.Hub` (https://godoc.org/github.com/getsentry/sentry-go#Hub) to the request's context, which makes it available throughout the rest of the request's lifetime. | ||
| You can access it by using the `sentryfiber.GetHubFromContext()` method on the context itself in any of your proceeding middleware and routes. | ||
| This method should be used instead of the global `sentry.CaptureMessage`, `sentry.CaptureException`, or any other calls, as it maintains the separation of data between the requests. | ||
|
|
||
| **Keep in mind that `*sentry.Hub` won't be available in middleware attached before `sentryfiber`!** | ||
|
|
||
| ```go | ||
| func enhanceSentryEvent := func(ctx *fiber.Ctx) error { | ||
| if hub := sentryfiber.GetHubFromContext(ctx); hub != nil { | ||
| hub.Scope().SetTag("someRandomTag", "maybeYouNeedIt") | ||
| } | ||
| return ctx.Next() | ||
| } | ||
|
|
||
| // Later in the code | ||
| sentryHandler := sentryfiber.New(sentryfiber.Options{ | ||
| Repanic: true, | ||
| WaitForDelivery: true, | ||
| }) | ||
|
|
||
| defaultHandler := func(ctx *fiber.Ctx) error { | ||
| if hub := sentryfiber.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.SendStatus(fiber.StatusOK) | ||
| } | ||
|
|
||
| fooHandler := enhanceSentryEvent(func(ctx *fiber.Ctx) { | ||
| panic("y tho") | ||
| }) | ||
|
|
||
| app.All("/foo", fooHandler) | ||
| app.All("/", defaultHandler) | ||
|
|
||
| if err := app.Listen(":3000"); err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| fmt.Println("Listening and serving HTTP on :3000") | ||
| ``` | ||
|
|
||
| ### Accessing Context in `BeforeSend` callback | ||
|
|
||
| <SignInNote /> | ||
|
|
||
| ```go | ||
| sentry.Init(sentry.ClientOptions{ | ||
| Dsn: "___PUBLIC_DSN___", | ||
| BeforeSend: func(event *sentry.Event, hint *sentry.EventHint) *sentry.Event { | ||
| if hint.Context != nil { | ||
| if ctx, ok := hint.Context.Value(sentry.RequestContextKey).(*fiber.Ctx); ok { | ||
| // You have access to the original Context if it panicked | ||
| fmt.Println(utils.CopyString(ctx.Hostname())) | ||
| } | ||
| } | ||
| return event | ||
| }, | ||
| }) | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One of these should be removed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed