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 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 performanceConfiguration = ` # Set traces_sample_rate to 1.0 to capture 100% # of transactions for performance monitoring. # We recommend adjusting this value in production. traces_sample_rate=1.0,`; const introduction = tct( 'The Starlette integration adds support for the Starlette Framework.', { link: , } ); export const steps = ({ sentryInitContent, }: { sentryInitContent: string; }): LayoutProps['steps'] => [ { type: StepType.INSTALL, description: (

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

), configurations: [ { language: 'bash', code: "pip install --upgrade 'sentry-sdk[starlette]'", }, ], }, { type: StepType.CONFIGURE, description: (

{tct( 'To configure the SDK, initialize it before your app has been initialized. The Sentry SDK automatically enables support for Starlette if you have the [code:starlette] Python package installed in your project. There are no configuration options you need to add when initializing the Sentry SDK as everything works out of the box:', {code: } )}

), configurations: [ { language: 'python', code: ` from starlette.applications import Starlette import sentry_sdk sentry_sdk.init( ${sentryInitContent} ) app = Starlette(routes=[...]) `, }, ], additionalInfo: (

{tct( 'The above configuration captures both error and performance data. To reduce the volume of performance data captured, change [code:traces_sample_rate] to a value between 0 and 1.', { code: , } )}

), }, { 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 starlette.applications import Starlette from starlette.routing import Route async def trigger_error(request): division_by_zero = 1 / 0 app = Starlette(routes=[ Route("/sentry-debug", trigger_error), ]) `, additionalInfo: t( 'Visiting this route will trigger an error that will be captured by Sentry.' ), }, ], }, ]; // Configuration End export function GettingStartedWithStarlette({ 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 GettingStartedWithStarlette;