import ExternalLink from 'sentry/components/links/externalLink';
import {Layout, LayoutProps} from 'sentry/components/onboarding/gettingStartedDoc/layout';
import {ModuleProps} from 'sentry/components/onboarding/gettingStartedDoc/sdkDocumentation';
import {StepType} from 'sentry/components/onboarding/gettingStartedDoc/step';
import {t, tct} from 'sentry/locale';
// Configuration Start
const introduction = (
{tct('The FastAPI integration adds support for the [link:FastAPI Framework].', {
link: ,
})}
);
export const steps = ({
dsn,
}: {
dsn?: string;
} = {}): LayoutProps['steps'] => [
{
type: StepType.INSTALL,
description: (
{tct(
'Install [sentrySdkCode:sentry-sdk] from PyPI with the [sentryFastApiCode:fastapi] extra:',
{
sentrySdkCode:
,
sentryFastApiCode:
,
}
)}
),
configurations: [
{
language: 'bash',
code: "pip install --upgrade 'sentry-sdk[fastapi]'",
},
],
},
{
type: StepType.CONFIGURE,
description: t(
'To configure the Sentry SDK, initialize it before your app has been initialized:'
),
configurations: [
{
language: 'python',
code: `
from fastapi import FastAPI
import sentry_sdk
sentry_sdk.init(
dsn="${dsn}",
# Set traces_sample_rate to 1.0 to capture 100%
# of transactions for performance monitoring.
# We recommend adjusting this value in production,
traces_sample_rate=1.0,
)
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:
,
}
)}
),
},
{
type: StepType.VERIFY,
description: t(
'You can easily verify your Sentry installation by creating a route that triggers an error:'
),
configurations: [
{
language: 'python',
code: `
from fastapi import FastAPI
app = FastAPI()
@app.get("/sentry-debug")
async def trigger_error():
division_by_zero = 1 / 0
`,
},
],
additionalInfo: t(
'Visiting this route will trigger an error that will be captured by Sentry.'
),
},
];
// Configuration End
export function GettingStartedWithFastApi({dsn, ...props}: ModuleProps) {
return ;
}
export default GettingStartedWithFastApi;