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 { 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 {getInstallConfig, getSdkInitSnippet} from 'sentry/utils/gettingStartedDocs/node'; type Params = DocsParams; const getSdkSetupSnippet = (params: Params) => ` // IMPORTANT: Make sure to import and initialize Sentry at the top of your file. ${getSdkInitSnippet(params, 'gpc')} // Place any other require/import statements here // Use wrapHttpFunction to instrument your http functions exports.helloHttp = Sentry.wrapHttpFunction((req, res) => { /* Your function code */ }); // Use wrapEventFunction to instrument your background functions exports.helloEvents = Sentry.wrapEventFunction( (data, context, callback) => { /* Your function code */ } ); // Use wrapCloudEventFunction to instrument your CloudEvent functions exports.helloEvents = Sentry.wrapCloudEventFunction( (context, callback) => { /* Your function code */ } );`; const getVerifySnippet = () => ` exports.helloHttp = Sentry.wrapHttpFunction((req, res) => { throw new Error("oh, hello there!"); });`; const getMetricsConfigureSnippet = (params: DocsParams) => ` Sentry.init({ dsn: "${params.dsn}", // Only needed for SDK versions < 8.0.0 // _experiments: { // metricsAggregator: true, // }, });`; const onboarding: OnboardingConfig = { install: params => [ { type: StepType.INSTALL, description: tct( 'Add the Sentry Serverless SDK as a dependency to your [code:package.json]:', {code: } ), configurations: [ { language: 'json', configurations: getInstallConfig(params, { basePackage: '@sentry/google-cloud-functions', }), }, ], }, ], configure: params => [ { type: StepType.CONFIGURE, description: tct( 'Ensure that Sentry is imported and initialized at the beginning of your file, prior to any other [require:require] or [import:import] statements. Then, use the Sentry SDK to wrap your functions:', { import: , require: , } ), configurations: [ { language: 'javascript', code: getSdkSetupSnippet(params), }, ], }, getUploadSourceMapsStep({ guideLink: 'https://docs.sentry.io/platforms/javascript/guides/gcp-functions/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 customMetricsOnboarding: OnboardingConfig = { install: params => [ { type: StepType.INSTALL, description: tct( 'You need a minimum version [codeVersion:8.0.0] of [codePackage:@sentry/google-cloud-serverless]:', { codeVersion: , codePackage: , } ), configurations: getInstallConfig(params, { basePackage: '@sentry/google-cloud-functions', }), }, ], configure: params => [ { type: StepType.CONFIGURE, description: t( 'With the default snippet in place, there is no need for any further configuration.' ), configurations: [ { code: getMetricsConfigureSnippet(params), language: 'javascript', }, ], }, ], verify: getJSServerMetricsOnboarding().verify, }; const crashReportOnboarding: OnboardingConfig = { introduction: () => getCrashReportModalIntroduction(), install: (params: Params) => getCrashReportJavaScriptInstallStep(params), configure: () => [ { type: StepType.CONFIGURE, description: getCrashReportModalConfigDescription({ link: 'https://docs.sentry.io/platforms/javascript/guides/gcp-functions/user-feedback/configuration/#crash-report-modal', }), }, ], verify: () => [], nextSteps: () => [], }; const docs: Docs = { onboarding, customMetricsOnboarding, crashReportOnboarding, }; export default docs;