import ExternalLink from 'sentry/components/links/externalLink';
import {StepType} from 'sentry/components/onboarding/gettingStartedDoc/step';
import {
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 {t, tct} from 'sentry/locale';
type Params = DocsParams;
const getInstallSnippet = () => `pip install --upgrade sentry-sdk[django]`;
const getSdkSetupSnippet = (params: Params) => `
# settings.py
import sentry_sdk
sentry_sdk.init(
dsn="${params.dsn}",${
params.isPerformanceSelected
? `
# Set traces_sample_rate to 1.0 to capture 100%
# of transactions for performance monitoring.
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 = {
introduction: () =>
tct('The Django integration adds support for the [link:Django Web Framework].', {
link:
{tct(
'Install [code:sentry-sdk] from PyPI with the [sentryDjangoCode:django] extra:',
{
code: ,
sentryDjangoCode:
,
}
)}
,
codeSettings:
,
}
),
configurations: [
{
language: 'python',
code: `
${getSdkSetupSnippet(params)}
api = falcon.API()
`,
},
],
},
],
verify: () => [
{
type: StepType.VERIFY,
description: t(
'You can easily verify your Sentry installation by creating a route that triggers an error:'
),
configurations: [
{
language: 'python',
code: `# urls.py
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/] a transaction in the Performance section of Sentry will be created.',
{
link:
{t( 'Additionally, an error event will be sent to Sentry and will be connected to the transaction.' )}
{t('It takes a couple of moments for the data to appear in Sentry.')}