123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209 |
- 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 {getUploadSourceMapsStep} from 'sentry/components/onboarding/gettingStartedDoc/utils';
- import {ProductSolution} from 'sentry/components/onboarding/productSelection';
- import {t, tct} from 'sentry/locale';
- import type {Organization, PlatformKey} from 'sentry/types';
- type StepProps = {
- newOrg: boolean;
- organization: Organization;
- platformKey: PlatformKey;
- projectId: string;
- sentryInitContent: string;
- };
- // Configuration Start
- const replayIntegration = `
- new Sentry.Replay(),
- `;
- const replayOtherConfig = `
- // Session Replay
- replaysSessionSampleRate: 0.1, // This sets the sample rate at 10%. You may want to change it to 100% while in development and then sample at a lower rate in production.
- replaysOnErrorSampleRate: 1.0, // If you're not already sampling the entire session, change the sample rate to 100% when sampling sessions where errors occur.
- `;
- const performanceIntegration = `
- new Sentry.BrowserTracing({
- // Set 'tracePropagationTargets' to control for which URLs distributed tracing should be enabled
- tracePropagationTargets: ["localhost", /^https:\\/\\/yourserver\\.io\\/api/],
- }),
- `;
- const performanceOtherConfig = `
- // Performance Monitoring
- tracesSampleRate: 1.0, // Capture 100% of the transactions`;
- export const steps = ({
- sentryInitContent,
- ...props
- }: Partial<StepProps> = {}): LayoutProps['steps'] => [
- {
- type: StepType.INSTALL,
- description: (
- <p>
- {tct(
- 'Add the Sentry SDK as a dependency using [codeNpm:npm] or [codeYarn:yarn]:',
- {
- codeYarn: <code />,
- codeNpm: <code />,
- }
- )}
- </p>
- ),
- configurations: [
- {
- language: 'bash',
- code: [
- {
- label: 'npm',
- value: 'npm',
- language: 'bash',
- code: 'npm install --save @sentry/react',
- },
- {
- label: 'yarn',
- value: 'yarn',
- language: 'bash',
- code: 'yarn add @sentry/react',
- },
- ],
- },
- ],
- },
- {
- type: StepType.CONFIGURE,
- description: t(
- "Initialize Sentry as early as possible in your application's lifecycle."
- ),
- configurations: [
- {
- language: 'javascript',
- code: `
- //...
- import * as Sentry from "@sentry/react";
- Sentry.init({
- ${sentryInitContent}
- });
- const container = document.getElementById(“app”);
- const root = createRoot(container);
- root.render(<App />);
- `,
- },
- ],
- },
- getUploadSourceMapsStep({
- guideLink: 'https://docs.sentry.io/platforms/javascript/guides/react/sourcemaps/',
- ...props,
- }),
- {
- type: StepType.VERIFY,
- description: t(
- "This snippet contains an intentional error and can be used as a test to make sure that everything's working as expected."
- ),
- configurations: [
- {
- language: 'javascript',
- code: `
- return <button onClick={() => methodDoesNotExist()}>Break the world</button>;
- `,
- },
- ],
- },
- ];
- export const nextSteps = [
- {
- id: 'react-features',
- name: t('React Features'),
- description: t('Learn about our first class integration with the React framework.'),
- link: 'https://docs.sentry.io/platforms/javascript/guides/react/features/',
- },
- {
- id: 'react-router',
- name: t('React Router'),
- description: t(
- 'Configure routing, so Sentry can generate parameterized transaction names for a better overview in Performance Monitoring.'
- ),
- link: 'https://docs.sentry.io/platforms/javascript/guides/react/configuration/integrations/react-router/',
- },
- {
- id: 'performance-monitoring',
- name: t('Performance Monitoring'),
- description: t(
- 'Track down transactions to connect the dots between 10-second page loads and poor-performing API calls or slow database queries.'
- ),
- link: 'https://docs.sentry.io/platforms/javascript/guides/react/performance/',
- },
- {
- id: 'session-replay',
- name: t('Session Replay'),
- description: t(
- 'Get to the root cause of an error or latency issue faster by seeing all the technical details related to that issue in one visual replay on your web application.'
- ),
- link: 'https://docs.sentry.io/platforms/javascript/guides/react/session-replay/',
- },
- ];
- // Configuration End
- export function GettingStartedWithReact({
- dsn,
- activeProductSelection = [],
- organization,
- newOrg,
- platformKey,
- projectId,
- ...props
- }: ModuleProps) {
- const integrations: string[] = [];
- const otherConfigs: string[] = [];
- let nextStepDocs = [...nextSteps];
- if (activeProductSelection.includes(ProductSolution.PERFORMANCE_MONITORING)) {
- integrations.push(performanceIntegration.trim());
- otherConfigs.push(performanceOtherConfig.trim());
- nextStepDocs = nextStepDocs.filter(
- step => step.id !== ProductSolution.PERFORMANCE_MONITORING
- );
- }
- if (activeProductSelection.includes(ProductSolution.SESSION_REPLAY)) {
- integrations.push(replayIntegration.trim());
- otherConfigs.push(replayOtherConfig.trim());
- nextStepDocs = nextStepDocs.filter(
- step => step.id !== ProductSolution.SESSION_REPLAY
- );
- }
- let sentryInitContent: string[] = [`dsn: "${dsn}",`];
- if (integrations.length > 0) {
- sentryInitContent = sentryInitContent.concat('integrations: [', integrations, '],');
- }
- if (otherConfigs.length > 0) {
- sentryInitContent = sentryInitContent.concat(otherConfigs);
- }
- return (
- <Layout
- steps={steps({
- sentryInitContent: sentryInitContent.join('\n'),
- organization,
- newOrg,
- platformKey,
- projectId,
- })}
- nextSteps={nextStepDocs}
- newOrg={newOrg}
- platformKey={platformKey}
- {...props}
- />
- );
- }
- export default GettingStartedWithReact;
|