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 {crashReportOnboardingPython} from 'sentry/gettingStartedDocs/python/python'; import {t, tct} from 'sentry/locale'; type Params = DocsParams; const getInstallSnippet = () => `pip install --upgrade sentry-sdk`; const getSdkSetupSnippet = (params: Params) => ` import sentry_sdk from sentry_sdk.integrations.asgi import SentryAsgiMiddleware from myapp import asgi_app sentry_sdk.init( dsn="${params.dsn}",${ params.isPerformanceSelected ? ` # Set traces_sample_rate to 1.0 to capture 100% # of transactions for performance monitoring. traces_sample_rate=1.0,` : '' }${ params.isProfilingSelected ? ` # Set profiles_sample_rate to 1.0 to profile 100% # of sampled transactions. # We recommend adjusting this value in production. profiles_sample_rate=1.0,` : '' } ) asgi_app = SentryAsgiMiddleware(asgi_app)`; const getVerifySnippet = () => ` import sentry_sdk from sentry_sdk.integrations.asgi import SentryAsgiMiddleware from myapp import asgi_app sentry_sdk.init(...) # same as above def app(scope): async def get_body(): return f"The number is: {1/0}" # raises an error! async def asgi(receive, send): await send( { "type": "http.response.start", "status": 200, "headers": [[b"content-type", b"text/plain"]], } ) await send({"type": "http.response.body", "body": await get_body()}) return asgi app = SentryAsgiMiddleware(app)`; const onboarding: OnboardingConfig = { introduction: () => tct( 'The ASGI middleware can be used to instrument any bare bones ASGI application. If you have a ASGI based web framework (like FastAPI, Starlette, or others), please use the specific integration for the framework.', { link: , } ), install: (params: Params) => [ { type: StepType.INSTALL, description: tct('Install [code:sentry-sdk] from PyPI:', { code: , }), configurations: [ { description: params.isProfilingSelected ? tct( 'You need a minimum version [codeVersion:1.18.0] of the [codePackage:sentry-python] SDK for the profiling feature.', { codeVersion: , codePackage: , } ) : undefined, language: 'bash', code: getInstallSnippet(), }, ], }, ], configure: (params: Params) => [ { type: StepType.CONFIGURE, description: tct('Wrap your ASGI application with [code: SentryAsgiMiddleware]:', { code: , }), configurations: [ { language: 'python', code: getSdkSetupSnippet(params), }, ], additionalInfo: t('The middleware supports both ASGI 2 and ASGI 3 transparently.'), }, ], verify: () => [ { type: StepType.VERIFY, description: t('To verify that everything is working trigger an error on purpose:'), configurations: [ { language: 'python', code: getVerifySnippet(), }, ], additionalInfo: (

{tct( 'Run your ASGI app with uvicorn ([code:uvicorn main:app --port 8000]) and point your browser to [link:http://localhost:8000]. A transaction in the Performance section of Sentry will be created.', { code: , link: , } )}

{t( 'Additionally, an error event will be sent to Sentry and will be connected to the transaction.' )}

{t('It takes a couple of moments for the data to appear in Sentry.')}

), }, ], }; const docs: Docs = { onboarding, customMetricsOnboarding: getPythonMetricsOnboarding({ installSnippet: getInstallSnippet(), }), crashReportOnboarding: crashReportOnboardingPython, }; export default docs;