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 {t, tct} from 'sentry/locale';
type Params = DocsParams;
const getInstallSnippet = () => `pip install --upgrade sentry-sdk[fastapi]`;
const getSdkSetupSnippet = (params: Params) => `
from fastapi import FastAPI
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 FastAPI integration adds support for the [link:FastAPI Framework].', {
link: ,
sentryFastApiCode:
,
}
),
configurations: [
{
language: 'bash',
code: getInstallSnippet(),
},
],
},
],
configure: (params: Params) => [
{
type: StepType.CONFIGURE,
description: tct(
'If you have the [codeFastAPI:fastapi] package in your dependencies, the FastAPI integration will be enabled automatically when you initialize the Sentry SDK. Initialize the Sentry SDK before your app has been initialized:',
{
codeFastAPI:
,
}
),
configurations: [
{
language: 'python',
code: `
${getSdkSetupSnippet(params)}
app = FastAPI()
`,
},
],
additionalInfo: tct(
'The above configuration captures both error and performance data. To reduce the volume of performance data captured, change [code:traces_sample_rate] to a value between 0 and 1.',
{
code:
,
}
),
},
],
verify: (params: Params) => [
{
type: StepType.VERIFY,
description: t(
'You can easily verify your Sentry installation by creating a route that triggers an error:'
),
configurations: [
{
language: 'python',
code: `
${getSdkSetupSnippet(params)}
app = FastAPI()
@app.get("/sentry-debug")
async def trigger_error():
division_by_zero = 1 / 0
`,
},
],
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.')}