import {IntegrationOptions} from 'sentry/components/events/featureFlags/utils'; 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 { getCrashReportBackendInstallStep, getCrashReportModalConfigDescription, getCrashReportModalIntroduction, } from 'sentry/components/onboarding/gettingStartedDoc/utils/feedbackOnboarding'; import {getPythonMetricsOnboarding} from 'sentry/components/onboarding/gettingStartedDoc/utils/metricsOnboarding'; import {t, tct} from 'sentry/locale'; type Params = DocsParams; type FlagImports = { integration: string; // what's in the integrations array module: string; // what's imported from sentry_sdk.integrations }; const FLAG_OPTION_TO_IMPORT: Record = { [IntegrationOptions.LAUNCHDARKLY]: { module: 'launchdarkly', integration: 'LaunchDarklyIntegration', }, [IntegrationOptions.OPENFEATURE]: { module: 'openfeature', integration: 'OpenFeatureIntegration', }, }; const getInstallSnippet = () => `pip install --upgrade sentry-sdk`; const getSdkSetupSnippet = (params: Params) => ` import sentry_sdk 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' ? ` def slow_function(): import time time.sleep(0.1) return "done" def fast_function(): import time time.sleep(0.05) return "done" # Manually call start_profiler and stop_profiler # to profile the code in between sentry_sdk.profiler.start_profiler() for i in range(0, 10): slow_function() fast_function() # # Calls to stop_profiler are optional - if you don't stop the profiler, it will keep profiling # your application until the process exits or stop_profiler is called. sentry_sdk.profiler.stop_profiler()` : '' }`; const onboarding: OnboardingConfig = { 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: Params) => [ { type: StepType.CONFIGURE, description: t( "Import and initialize the Sentry SDK early in your application's setup:" ), configurations: [ { language: 'python', code: getSdkSetupSnippet(params), }, ], additionalInfo: params.isProfilingSelected && params.profilingOptions?.defaultProfilingMode === 'continuous' && ( ), }, ], verify: () => [ { type: StepType.VERIFY, description: t( 'One way to verify your setup is by intentionally causing an error that breaks your application.' ), configurations: [ { language: 'python', description: t( 'Raise an unhandled Python exception by inserting a divide by zero expression into your application:' ), code: 'division_by_zero = 1 / 0', }, ], }, ], }; export const crashReportOnboardingPython: OnboardingConfig = { introduction: () => getCrashReportModalIntroduction(), install: (params: Params) => getCrashReportBackendInstallStep(params), configure: () => [ { type: StepType.CONFIGURE, description: getCrashReportModalConfigDescription({ link: 'https://docs.sentry.io/platforms/python/user-feedback/configuration/#crash-report-modal', }), }, ], verify: () => [], nextSteps: () => [], }; export const performanceOnboarding: OnboardingConfig = { introduction: () => t( "Adding Performance to your Python project is simple. Make sure you've got these basics down." ), install: onboarding.install, configure: params => [ { type: StepType.CONFIGURE, description: t( "Configuration should happen as early as possible in your application's lifecycle." ), configurations: [ { description: tct( "Once this is done, Sentry's Python SDK captures all unhandled exceptions and transactions. Note that [code:enable_tracing] is available in Sentry Python SDK version [code:≥ 1.16.0]. To enable tracing in older SDK versions ([code:≥ 0.11.2]), use [code:traces_sample_rate=1.0].", {code: } ), language: 'python', code: ` import sentry-sdk sentry_sdk.init( dsn="${params.dsn.public}", enable_tracing=True, )`, additionalInfo: tct( 'Learn more about tracing [linkTracingOptions:options], how to use the [linkTracesSampler:traces_sampler] function, or how to [linkSampleTransactions:sample transactions].', { linkTracingOptions: ( ), linkTracesSampler: ( ), linkSampleTransactions: ( ), } ), }, ], }, ], verify: () => [ { type: StepType.VERIFY, description: tct( 'Verify that performance monitoring is working correctly with our [link:automatic instrumentation] by simply using your Python application.', { link: ( ), } ), additionalInfo: tct( 'You have the option to manually construct a transaction using [link:custom instrumentation].', { link: ( ), } ), }, ], nextSteps: () => [], }; export function AlternativeConfiguration() { return (
{tct( 'Alternatively, you can also explicitly control continuous profiling or use transaction profiling. See our [link:documentation] for more information.', { link: ( ), } )}
); } export const featureFlagOnboarding: OnboardingConfig = { install: () => [], configure: ({featureFlagOptions = {integration: ''}, dsn}) => [ { type: StepType.CONFIGURE, description: tct('Add [name] to your integrations list.', { name: ( {`${FLAG_OPTION_TO_IMPORT[featureFlagOptions.integration].integration}()`} ), }), configurations: [ { language: 'python', code: ` import sentry-sdk from sentry_sdk.integrations.${FLAG_OPTION_TO_IMPORT[featureFlagOptions.integration].module} import ${FLAG_OPTION_TO_IMPORT[featureFlagOptions.integration].integration} sentry_sdk.init( dsn="${dsn.public}", integrations=[ ${FLAG_OPTION_TO_IMPORT[featureFlagOptions.integration].integration}(), ] )`, }, ], }, ], verify: () => [], nextSteps: () => [], }; const docs: Docs = { onboarding, performanceOnboarding, customMetricsOnboarding: getPythonMetricsOnboarding({ installSnippet: getInstallSnippet(), }), crashReportOnboarding: crashReportOnboardingPython, featureFlagOnboarding, }; export default docs;