123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188 |
- 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()}
- // All other imports below
- ${getSentryImportSnippet('node')}
- const Hapi = require('@hapi/hapi');
- const init = async () => {
- const server = Hapi.server({
- port: 3030,
- host: 'localhost',
- });
- // All your routes live here
- await Sentry.setupHapiErrorHandler(server);
- await server.start();
- };
- init();
- `;
- 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 Node SDK as a dependency:'),
- configurations: getInstallConfig(params),
- },
- ],
- 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 />}
- ),
- code: [
- {
- label: 'JavaScript',
- value: 'javascript',
- language: 'javascript',
- filename: 'instrument.(js|mjs)',
- code: getSdkInitSnippet(params, 'node'),
- },
- ],
- },
- {
- description: tct(
- "Make sure to import [code1:instrument.js/mjs] at the top of your file. Set up the error handler. This setup is typically done in your application's entry point file, which is usually [code2:index.(js|ts)]. If you're running your application in ESM mode, or looking for alternative ways to set up Sentry, read about [docs:installation methods in our docs].",
- {
- code1: <code />,
- code2: <code />,
- docs: (
- <ExternalLink href="https://docs.sentry.io/platforms/javascript/guides/hapi/install/" />
- ),
- }
- ),
- code: [
- {
- label: 'JavaScript',
- value: 'javascript',
- language: 'javascript',
- filename: 'index.(js|mjs)',
- code: getSdkSetupSnippet(),
- },
- ],
- },
- ],
- },
- getUploadSourceMapsStep({
- guideLink: 'https://docs.sentry.io/platforms/javascript/guides/hapi/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/hapi/user-feedback/configuration/#crash-report-modal',
- }),
- },
- ],
- verify: () => [],
- nextSteps: () => [],
- };
- const docs: Docs = {
- onboarding,
- feedbackOnboardingCrashApi: feedbackOnboardingNode,
- customMetricsOnboarding: getJSServerMetricsOnboarding(),
- crashReportOnboarding,
- };
- export default docs;
|