123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112 |
- 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 {ProductSolution} from 'sentry/components/onboarding/productSelection';
- import {t, tct} from 'sentry/locale';
- // Configuration Start
- const profilingConfiguration = ` # 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 performanceConfiguration = ` # 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,`;
- export const steps = ({
- sentryInitContent,
- }: {
- sentryInitContent?: string;
- } = {}): LayoutProps['steps'] => [
- {
- type: StepType.INSTALL,
- description: (
- <p>
- {tct('Install our Python SDK using [code:pip]:', {
- code: <code />,
- })}
- </p>
- ),
- configurations: [
- {
- language: 'bash',
- code: 'pip install --upgrade sentry-sdk',
- },
- ],
- },
- {
- type: StepType.CONFIGURE,
- description: t(
- "Import and initialize the Sentry SDK early in your application's setup:"
- ),
- configurations: [
- {
- language: 'python',
- code: `
- import sentry_sdk
- sentry_sdk.init(
- ${sentryInitContent}
- ) `,
- },
- ],
- additionalInfo: (
- <p>
- {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: <code />}
- )}
- </p>
- ),
- },
- {
- type: StepType.VERIFY,
- description: t(
- 'One way to verify your setup is by intentionally causing an error that breaks your application.'
- ),
- configurations: [
- {
- language: 'python',
- description: t(
- 'Raise an unhandled Python exception by inserting a divide by zero expression into your application:'
- ),
- code: 'division_by_zero = 1 / 0',
- },
- ],
- },
- ];
- // Configuration End
- export function GettingStartedWithPython({
- dsn,
- activeProductSelection = [],
- ...props
- }: ModuleProps) {
- const otherConfigs: string[] = [];
- let sentryInitContent: string[] = [` dsn="${dsn}",`];
- if (activeProductSelection.includes(ProductSolution.PERFORMANCE_MONITORING)) {
- otherConfigs.push(performanceConfiguration);
- }
- if (activeProductSelection.includes(ProductSolution.PROFILING)) {
- otherConfigs.push(profilingConfiguration);
- }
- sentryInitContent = sentryInitContent.concat(otherConfigs);
- return (
- <Layout
- steps={steps({
- sentryInitContent: sentryInitContent.join('\n'),
- })}
- {...props}
- />
- );
- }
- export default GettingStartedWithPython;
|