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 replayOnboardingJsLoader from 'sentry/gettingStartedDocs/javascript/jsLoader/jsLoader';
import {
AlternativeConfiguration,
crashReportOnboardingPython,
} from 'sentry/gettingStartedDocs/python/python';
import {t, tct} from 'sentry/locale';
type Params = DocsParams;
const getInstallSnippet = () => `pip install --upgrade 'sentry-sdk[django]'`;
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'
? `
_experiments={
# Set continuous_profiling_auto_start to True
# to automatically start the profiler on when
# possible.
"continuous_profiling_auto_start": True,
},`
: ''
}
)
`;
const onboarding: OnboardingConfig = {
install: (params: Params) => [
{
type: StepType.INSTALL,
description: tct(
'Install [code:sentry-sdk] from PyPI with the [code:django] extra:',
{
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: tct(
'Initialize the Sentry SDK in your Django [code:settings.py] file:',
{
code:
,
}
),
configurations: [
{
code: [
{
label: 'settings.py',
value: 'settings.py',
language: 'python',
code: getSdkSetupSnippet(params),
},
],
},
],
additionalInfo:
{tct(
'When you point your browser to [link:http://localhost:8000/sentry-debug/] an error with a trace will be created. So you can explore errors and tracing portions of Sentry.',
{
link:
{t( 'It can take a couple of moments for the data to appear in Sentry. Bear with us, the internet is huge.' )}
}
),
configurations: [
{
language: 'python',
code: `
import sentry-sdk
sentry_sdk.init(
dsn: "${params.dsn.public}",
// Set traces_sample_rate to 1.0 to capture 100%
// of transactions for performance monitoring.
traces_sample_rate=1.0,
)`,
additionalInfo: tct(
'Learn more about tracing [linkTracingOptions:options], how to use the [linkTracesSampler:traces_sampler] function, or how to [linkSampleTransactions:sample transactions].',
{
linkTracingOptions: (