import ExternalLink from 'sentry/components/links/externalLink'; import {Layout, LayoutProps} from 'sentry/components/onboarding/gettingStartedDoc/layout'; import {ModuleProps} from 'sentry/components/onboarding/gettingStartedDoc/sdkDocumentation'; import {StepType} from 'sentry/components/onboarding/gettingStartedDoc/step'; import {ProductSolution} from 'sentry/components/onboarding/productSelection'; import {t, tct} from 'sentry/locale'; // Configuration Start const performanceConfiguration = ` # Set traces_sample_rate to 1.0 to capture 100% # of transactions for performance monitoring. traces_sample_rate=1.0,`; const profilingConfiguration = ` # 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,`; const introduction = (

{tct('The Tornado integration adds support for the [link:Tornado Web Framework].', { link: , })}

); export const steps = ({ sentryInitContent, }: { sentryInitContent: string; }): LayoutProps['steps'] => [ { type: StepType.INSTALL, description: (

{tct( 'Install [sentrySdkCode:sentry-sdk] from PyPI with the [sentryTornadoCode:tornado] extra:', { sentrySdkCode: , sentryTornadoCode: , } )}

), configurations: [ { language: 'bash', code: '$ pip install --upgrade sentry-sdk', }, { description: (

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

), language: 'bash', code: '$ pip install --upgrade aiocontextvars', }, ], }, { type: StepType.CONFIGURE, description: (

{tct( 'If you have the [codeTornado:tornado] package in your dependencies, the Tornado integration will be enabled automatically when you initialize the Sentry SDK. Initialize the Sentry SDK before your app has been initialized:', { codeTornado: , } )}

), configurations: [ { language: 'python', code: `import sentry_sdk sentry_sdk.init( ${sentryInitContent} ) class MainHandler(tornado.web.RequestHandler): # ... `, }, ], }, { type: StepType.VERIFY, description: t( 'You can easily verify your Sentry installation by creating a route that triggers an error:' ), configurations: [ { language: 'python', code: `import asyncio import tornado import sentry_sdk sentry_sdk.init( ${sentryInitContent} ) class MainHandler(tornado.web.RequestHandler): def get(self): 1/0 # raises an error self.write("Hello, world") def make_app(): return tornado.web.Application([ (r"/", MainHandler), ]) async def main(): app = make_app() app.listen(8888) await asyncio.Event().wait() asyncio.run(main()) `, additionalInfo: (

{tct( 'When you point your browser to [link:http://localhost:8888/] 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.')}

), }, ], }, ]; // Configuration End export function GettingStartedWithTornado({ dsn, activeProductSelection = [], ...props }: ModuleProps) { const otherConfigs: string[] = []; let sentryInitContent: string[] = [` dsn="${dsn}",`]; if (activeProductSelection.includes(ProductSolution.PERFORMANCE_MONITORING)) { otherConfigs.push(performanceConfiguration); } if (activeProductSelection.includes(ProductSolution.PROFILING)) { otherConfigs.push(profilingConfiguration); } sentryInitContent = sentryInitContent.concat(otherConfigs); return ( ); } export default GettingStartedWithTornado;