import {Fragment} from 'react'; import styled from '@emotion/styled'; import {Alert} from 'sentry/components/alert'; import ExternalLink from 'sentry/components/links/externalLink'; import {StepType} from 'sentry/components/onboarding/gettingStartedDoc/step'; import type { Docs, DocsParams, OnboardingConfig, } from 'sentry/components/onboarding/gettingStartedDoc/types'; import {t, tct} from 'sentry/locale'; type Params = DocsParams; const getConfigureSnippet = (params: Params) => ` import ( "fmt" "net/http" "github.com/getsentry/sentry-go" sentrygin "github.com/getsentry/sentry-go/gin" "github.com/gin-gonic/gin" ) // To initialize Sentry's handler, you need to initialize Sentry itself beforehand if err := sentry.Init(sentry.ClientOptions{ Dsn: "${params.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) } // Then create your app app := gin.Default() // Once it's done, you can attach the handler as one of your middleware app.Use(sentrygin.New(sentrygin.Options{})) // Set up routes app.GET("/", func(ctx *gin.Context) { ctx.String(http.StatusOK, "Hello world!") }) // And run it app.Run(":3000")`; const getOptionsSnippet = () => ` // Whether Sentry should repanic after recovery, in most cases it should be set to true, // as gin.Default includes its own Recovery middleware that handles http responses. Repanic bool // Whether you want to block the request before moving forward with the response. // Because Gin's default "Recovery" 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`; const getUsageSnippet = () => ` app := gin.Default() app.Use(sentrygin.New(sentrygin.Options{ Repanic: true, })) app.Use(func(ctx *gin.Context) { if hub := sentrygin.GetHubFromContext(ctx); hub != nil { hub.Scope().SetTag("someRandomTag", "maybeYouNeedIt") } ctx.Next() }) app.GET("/", func(ctx *gin.Context) { if hub := sentrygin.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") }) } ctx.Status(http.StatusOK) }) app.GET("/foo", func(ctx *gin.Context) { // sentrygin 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.Run(":3000")`; const getBeforeSendSnippet = params => ` sentry.Init(sentry.ClientOptions{ Dsn: "${params.dsn}", 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 }, })`; const onboarding: OnboardingConfig = { install: () => [ { type: StepType.INSTALL, description: tct('Install our Go Gin SDK using [code:go get]:', { code: , }), configurations: [ { language: 'bash', code: 'go get github.com/getsentry/sentry-go/gin', }, ], }, ], configure: params => [ { type: StepType.CONFIGURE, description: t( "Import and initialize the Sentry SDK early in your application's setup:" ), configurations: [ { language: 'go', code: getConfigureSnippet(params), }, { description: ( {t('Options')}

{tct( '[sentryGinCode:sentrygin] accepts a struct of [optionsCode:Options] that allows you to configure how the handler will behave.', {sentryGinCode: , optionsCode: } )}

{t('Currently it respects 3 options:')}
), language: 'go', code: getOptionsSnippet(), }, ], }, { title: t('Usage'), description: (

{tct( "[sentryGinCode:sentrygin] attaches an instance of [sentryHubLink:*sentry.Hub] to the [ginContextCode:*gin.Context], which makes it available throughout the rest of the request's lifetime. You can access it by using the [getHubFromContextCode:sentrygin.GetHubFromContext()] method on the context itself in any of your proceeding middleware and routes. And it should be used instead of the global [captureMessageCode:sentry.CaptureMessage], [captureExceptionCode:sentry.CaptureException], or any other calls, as it keeps the separation of data between the requests.", { sentryGinCode: , sentryHubLink: ( ), ginContextCode: , getHubFromContextCode: , captureMessageCode: , captureExceptionCode: , } )}

{tct( "Keep in mind that [sentryHubCode:*sentry.Hub] won't be available in middleware attached before [sentryGinCode:sentrygin]!", {sentryGinCode: , sentryHubCode: } )}
), configurations: [ { language: 'go', code: getUsageSnippet(), }, { description: ( {tct('Accessing Request in [beforeSendCode:BeforeSend] callback', { beforeSendCode: , })} ), language: 'go', code: getBeforeSendSnippet(params), }, ], }, ], verify: () => [], }; const docs: Docs = { onboarding, }; export default docs; const AlertWithoutMarginBottom = styled(Alert)` margin-bottom: 0; `;