123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137 |
- import {Layout, LayoutProps} from 'sentry/components/onboarding/gettingStartedDoc/layout';
- import {ModuleProps} from 'sentry/components/onboarding/gettingStartedDoc/sdkDocumentation';
- import {StepProps, StepType} from 'sentry/components/onboarding/gettingStartedDoc/step';
- import {getUploadSourceMapsStep} from 'sentry/components/onboarding/gettingStartedDoc/utils';
- import {t, tct} from 'sentry/locale';
- import {
- getDefaultInitParams,
- getDefaultNodeImports,
- getInstallSnippet,
- getProductInitParams,
- getProductIntegrations,
- getProductSelectionMap,
- joinWithIndentation,
- } from 'sentry/utils/gettingStartedDocs/node';
- interface StepsParams {
- importContent: string;
- initContent: string;
- installSnippet: string;
- sourceMapStep: StepProps;
- }
- export const steps = ({
- installSnippet,
- importContent,
- initContent,
- sourceMapStep,
- }: StepsParams): LayoutProps['steps'] => [
- {
- type: StepType.INSTALL,
- description: t('Add the Sentry Node SDK as a dependency:'),
- configurations: [
- {
- language: 'bash',
- code: installSnippet,
- },
- ],
- },
- {
- type: StepType.CONFIGURE,
- description: (
- <p>
- {tct(
- "Initialize Sentry as early as possible in your application's lifecycle, for example in your [code:index.ts/js] entry point:",
- {code: <code />}
- )}
- </p>
- ),
- configurations: [
- {
- language: 'javascript',
- code: `
- ${importContent}
- Sentry.init({
- ${initContent}
- });
- `,
- },
- ],
- },
- sourceMapStep,
- {
- 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: `
- const transaction = Sentry.startTransaction({
- op: "test",
- name: "My First Test Transaction",
- });
- setTimeout(() => {
- try {
- foo();
- } catch (e) {
- Sentry.captureException(e);
- } finally {
- transaction.finish();
- }
- }, 99);
- `,
- },
- ],
- },
- ];
- export function GettingStartedWithNode({
- dsn,
- newOrg,
- platformKey,
- activeProductSelection = [],
- organization,
- projectId,
- }: ModuleProps) {
- const productSelection = getProductSelectionMap(activeProductSelection);
- const installSnippet = getInstallSnippet({productSelection});
- const imports = getDefaultNodeImports({productSelection});
- const integrations = getProductIntegrations({productSelection});
- const integrationParam =
- integrations.length > 0
- ? `integrations: [\n${joinWithIndentation(integrations)}\n],`
- : null;
- const initContent = joinWithIndentation([
- ...getDefaultInitParams({dsn}),
- ...(integrationParam ? [integrationParam] : []),
- ...getProductInitParams({productSelection}),
- ]);
- return (
- <Layout
- steps={steps({
- installSnippet,
- importContent: imports.join('\n'),
- initContent,
- sourceMapStep: getUploadSourceMapsStep({
- guideLink: 'https://docs.sentry.io/platforms/node/sourcemaps/',
- organization,
- platformKey,
- projectId,
- newOrg,
- }),
- })}
- newOrg={newOrg}
- platformKey={platformKey}
- />
- );
- }
- export default GettingStartedWithNode;
|