import ExternalLink from 'sentry/components/links/externalLink';
import {StepType} from 'sentry/components/onboarding/gettingStartedDoc/step';
import type {
Docs,
DocsParams,
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 {crashReportOnboardingPython} from 'sentry/gettingStartedDocs/python/python';
import {t, tct} from 'sentry/locale';
type Params = DocsParams;
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
? `
# 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 onboarding: OnboardingConfig = {
install: () => [
{
type: StepType.INSTALL,
description: tct('Install [code:sentry-sdk] from PyPI:', {
code: ,
}),
configurations: [
{
language: 'bash',
code: getInstallSnippet(),
},
],
},
],
configure: (params: Params) => [
{
type: StepType.CONFIGURE,
description: tct(
'Initialize the Sentry SDK in your Django [codeSettings:settings.py] file:',
{
codeDjango:
,
codeSettings:
,
}
),
configurations: [
{
code: [
{
label: 'settings.py',
value: 'settings.py',
language: 'python',
code: getSdkSetupSnippet(params),
},
],
},
],
},
],
verify: () => [
{
type: StepType.VERIFY,
description: t(
'You can easily verify your Sentry installation by creating a route that triggers an error:'
),
configurations: [
{
code: [
{
label: 'urls.py',
value: 'urls.py',
language: 'python',
code: `
from django.urls import path
def trigger_error(request):
division_by_zero = 1 / 0
urlpatterns = [
path('sentry-debug/', trigger_error),
# ...
]
`,
},
],
},
],
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.' )}