123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118 |
- 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 = (
- <p>
- {tct(
- 'The Tornado integration adds support for the [link:Tornado Web Framework]. A Tornado version of 5 or greater and Python 3.6 or greater is required.',
- {
- link: <ExternalLink href="https://www.tornadoweb.org/en/stable/" />,
- }
- )}
- </p>
- );
- export const steps = ({
- sentryInitContent,
- }: {
- sentryInitContent: string;
- }): LayoutProps['steps'] => [
- {
- type: StepType.INSTALL,
- description: <p>{tct('Install [code:sentry-sdk] from PyPI:', {code: <code />})}</p>,
- configurations: [
- {
- language: 'bash',
- code: '$ pip install --upgrade sentry-sdk',
- },
- {
- description: (
- <p>
- {tct(
- "If you're on Python 3.6, you also need the [code:aiocontextvars] package:",
- {
- code: <code />,
- }
- )}
- </p>
- ),
- language: 'bash',
- code: '$ pip install --upgrade aiocontextvars',
- },
- ],
- },
- {
- type: StepType.CONFIGURE,
- description: t('Initialize the SDK before starting the server:'),
- configurations: [
- {
- language: 'python',
- code: `
- import sentry_sdk
- from sentry_sdk.integrations.tornado import TornadoIntegration
- sentry_sdk.init(
- ${sentryInitContent}
- )
- # Your app code here, without changes
- class MyHandler(...):
- ...
- `,
- },
- ],
- },
- ];
- // Configuration End
- export function GettingStartedWithTornado({
- dsn,
- activeProductSelection = [],
- ...props
- }: ModuleProps) {
- const otherConfigs: string[] = [];
- let sentryInitContent: string[] = [
- ` dsn="${dsn}",`,
- ` integrations=[TornadoIntegration()],`,
- ];
- if (activeProductSelection.includes(ProductSolution.PERFORMANCE_MONITORING)) {
- otherConfigs.push(performanceConfiguration);
- }
- if (activeProductSelection.includes(ProductSolution.PROFILING)) {
- otherConfigs.push(profilingConfiguration);
- }
- sentryInitContent = sentryInitContent.concat(otherConfigs);
- return (
- <Layout
- introduction={introduction}
- steps={steps({
- sentryInitContent: sentryInitContent.join('\n'),
- })}
- {...props}
- />
- );
- }
- export default GettingStartedWithTornado;
|