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 {getPythonMetricsOnboarding} from 'sentry/components/onboarding/gettingStartedDoc/utils/metricsOnboarding'; import replayOnboardingJsLoader from 'sentry/gettingStartedDocs/javascript/jsLoader/jsLoader'; import {crashReportOnboardingPython} from 'sentry/gettingStartedDocs/python/python'; import {t, tct} from 'sentry/locale'; type Params = DocsParams; const getInstallSnippet = () => `pip install --upgrade 'sentry-sdk[sanic]'`; const getSdkSetupSnippet = (params: Params) => `from sanic import Sanic import sentry_sdk sentry_sdk.init( dsn="${params.dsn}", ) `; const onboarding: OnboardingConfig = { introduction: () => tct('The Sanic integration adds support for the [link:Sanic Web Framework].', { link: , }), install: () => [ { type: StepType.INSTALL, description: tct( 'Install [sentrySdkCode:sentry-sdk] from PyPI with the [sentrySanicCode:sanic] extra:', { sentrySdkCode: , sentrySanicCode: , } ), configurations: [ { language: 'bash', code: getInstallSnippet(), }, { description: (

{tct( "f you're on Python 3.6, you also need the [code:aiocontextvars] package:", { code: , } )}

), language: 'bash', code: 'pip install --upgrade aiocontextvars', }, ], }, ], configure: (params: Params) => [ { type: StepType.CONFIGURE, description: tct( 'If you have the [codeSanic:sanic] package in your dependencies, the Sanic integration will be enabled automatically when you initialize the Sentry SDK. Initialize the Sentry SDK before your app has been initialized:', { codeSanic: , } ), configurations: [ { language: 'python', code: `${getSdkSetupSnippet(params)} app = Sanic(__name__) `, }, ], }, ], verify: (params: Params) => [ { type: StepType.VERIFY, description: t( 'You can easily verify your Sentry installation by creating a route that triggers an error:' ), configurations: [ { language: 'python', code: `from sanic.response import text ${getSdkSetupSnippet(params)} app = Sanic(__name__) @app.get("/") async def hello_world(request): 1 / 0 # raises an error return text("Hello, world.") `, }, ], additionalInfo: tct( 'When you point your browser to [link:http://localhost:8000/] an error will be sent to Sentry.', { link: , } ), }, ], nextSteps: () => [], }; const docs: Docs = { onboarding, replayOnboardingJsLoader, customMetricsOnboarding: getPythonMetricsOnboarding({ installSnippet: getInstallSnippet(), }), crashReportOnboarding: crashReportOnboardingPython, }; export default docs;