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 {getUploadSourceMapsStep} from 'sentry/components/onboarding/gettingStartedDoc/utils'; import { getCrashReportApiIntroduction, getCrashReportInstallDescription, getCrashReportJavaScriptInstallStep, getCrashReportModalConfigDescription, getCrashReportModalIntroduction, } from 'sentry/components/onboarding/gettingStartedDoc/utils/feedbackOnboarding'; import {getJSServerMetricsOnboarding} from 'sentry/components/onboarding/gettingStartedDoc/utils/metricsOnboarding'; import {t, tct} from 'sentry/locale'; import { getImportInstrumentSnippet, getInstallConfig, getSdkInitSnippet, getSentryImportSnippet, } from 'sentry/utils/gettingStartedDocs/node'; type Params = DocsParams; const getSdkSetupSnippet = () => ` ${getImportInstrumentSnippet('esm')} // All other imports below ${getSentryImportSnippet('nestjs', 'esm')} import { BaseExceptionFilter, HttpAdapterHost, NestFactory } from '@nestjs/core'; import { AppModule } from './app.module'; async function bootstrap() { const app = await NestFactory.create(AppModule); const { httpAdapter } = app.get(HttpAdapterHost); Sentry.setupNestErrorHandler(app, new BaseExceptionFilter(httpAdapter)); await app.listen(3000); } bootstrap(); `; const getVerifySnippet = () => ` app.use(async function () { throw new Error("My first Sentry error!"); }); `; const onboarding: OnboardingConfig = { install: params => [ { type: StepType.INSTALL, description: t('Add the Sentry NestJS SDK as a dependency:'), configurations: getInstallConfig(params, { basePackage: '@sentry/nestjs', }), }, ], configure: params => [ { type: StepType.CONFIGURE, description: t( "Initialize Sentry as early as possible in your application's lifecycle. Otherwise, auto-instrumentation will not work." ), configurations: [ { description: tct( 'To initialize the SDK before everything else, create an external file called [code:instrument.js/mjs].', {code: } ), code: [ { label: 'JavaScript', value: 'javascript', language: 'javascript', filename: 'instrument.(js|ts)', code: getSdkInitSnippet(params, 'nestjs', 'esm'), }, ], }, { description: tct( 'Make sure to import [code1:instrument.js/mjs] at the top of your [code2:main.ts/js] file. Set up the error handler by passing the [code3:BaseExceptionFilter].', { code1: , code2: , code3: , docs: ( ), } ), code: [ { label: 'JavaScript', value: 'javascript', language: 'javascript', filename: 'main.(js|ts)', code: getSdkSetupSnippet(), }, ], }, ], }, getUploadSourceMapsStep({ guideLink: 'https://docs.sentry.io/platforms/javascript/guides/nestjs/sourcemaps/', ...params, }), ], verify: () => [ { 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: getVerifySnippet(), }, ], }, ], }; const feedbackOnboardingNode: OnboardingConfig = { introduction: () => getCrashReportApiIntroduction(), install: () => [ { type: StepType.INSTALL, description: getCrashReportInstallDescription(), configurations: [ { code: [ { label: 'JavaScript', value: 'javascript', language: 'javascript', code: `import * as Sentry from "@sentry/node"; const eventId = Sentry.captureMessage("User Feedback"); // OR: const eventId = Sentry.lastEventId(); const userFeedback = { event_id: eventId, name: "John Doe", email: "john@doe.com", comments: "I really like your App, thanks!", }; Sentry.captureUserFeedback(userFeedback); `, }, ], }, ], }, ], configure: () => [], verify: () => [], nextSteps: () => [], }; const crashReportOnboarding: OnboardingConfig = { introduction: () => getCrashReportModalIntroduction(), install: (params: Params) => getCrashReportJavaScriptInstallStep(params), configure: () => [ { type: StepType.CONFIGURE, description: getCrashReportModalConfigDescription({ link: 'https://docs.sentry.io/platforms/javascript/guides/nestjs/user-feedback/configuration/#crash-report-modal', }), }, ], verify: () => [], nextSteps: () => [], }; const docs: Docs = { onboarding, feedbackOnboardingCrashApi: feedbackOnboardingNode, customMetricsOnboarding: getJSServerMetricsOnboarding(), crashReportOnboarding, }; export default docs;