import {Fragment} from 'react'; import ExternalLink from 'sentry/components/links/externalLink'; import {StepType} from 'sentry/components/onboarding/gettingStartedDoc/step'; import { type Docs, DocsPageLocation, type DocsParams, type OnboardingConfig, } from 'sentry/components/onboarding/gettingStartedDoc/types'; import {getPythonMetricsOnboarding} from 'sentry/components/onboarding/gettingStartedDoc/utils/metricsOnboarding'; import { AlternativeConfiguration, 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.wsgi import SentryWsgiMiddleware from my_wsgi_app import app sentry_sdk.init( dsn="${params.dsn.public}",${ params.isPerformanceSelected ? ` # Set traces_sample_rate to 1.0 to capture 100% # of transactions for tracing. traces_sample_rate=1.0,` : '' }${ params.isProfilingSelected && params.profilingOptions?.defaultProfilingMode !== 'continuous' ? ` # 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,` : params.isProfilingSelected && params.profilingOptions?.defaultProfilingMode === 'continuous' ? ` _experiments={ # Set continuous_profiling_auto_start to True # to automatically start the profiler on when # possible. "continuous_profiling_auto_start": True, },` : '' } ) app = SentryWsgiMiddleware(app)`; const getVerifySnippet = () => ` import sentry_sdk from sentry_sdk.integrations.wsgi import SentryWsgiMiddleware sentry_sdk.init(...) # same as above def app(env, start_response): start_response('200 OK', [('Content-Type', 'text/plain')]) response_body = 'Hello World' 1/0 # this raises an error return [response_body.encode()] app = SentryWsgiMiddleware(app) # Run the application in a mini WSGI server. from wsgiref.simple_server import make_server make_server('', 8000, app).serve_forever()`; const onboarding: OnboardingConfig = { introduction: () => (

{tct( 'It is recommended to use an [link:integration for your particular WSGI framework if available], as those are easier to use and capture more useful information.', { link: ( ), } )}

{t( 'If you use a WSGI framework not directly supported by the SDK, or wrote a raw WSGI app, you can use this generic WSGI middleware. It captures errors and attaches a basic amount of information for incoming requests.' )}

), install: (params: Params) => [ { type: StepType.INSTALL, description: tct('Install our Python SDK using [code:pip]:', { code: , }), configurations: [ { description: params.docsLocation === DocsPageLocation.PROFILING_PAGE ? tct( 'You need a minimum version [code:1.18.0] of the [code:sentry-python] SDK for the profiling feature.', { code: , } ) : undefined, language: 'bash', code: getInstallSnippet(), }, ], }, ], configure: params => [ { type: StepType.CONFIGURE, description: t( 'Then you can use this generic WSGI middleware. It captures errors and attaches a basic amount of information for incoming requests.' ), configurations: [ { language: 'python', code: getSdkSetupSnippet(params), }, ], additionalInfo: params.isProfilingSelected && params.profilingOptions?.defaultProfilingMode === 'continuous' && ( ), }, ], verify: () => [ { type: StepType.VERIFY, description: t( 'You can easily verify your Sentry installation by creating a route that triggers an error:' ), configurations: [ { language: 'python', code: getVerifySnippet(), }, ], additionalInfo: (

{tct( 'When you point your browser to [link:http://localhost:8000/] a transaction in the Performance section of Sentry will be created.', { 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;