123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187 |
- 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 {ProductSolution} from 'sentry/components/onboarding/productSelection';
- import {t, tct} from 'sentry/locale';
- import type {ProductSelectionMap} from 'sentry/utils/gettingStartedDocs/node';
- import {
- getDefaulServerlessImports,
- getInstallConfig,
- } from 'sentry/utils/gettingStartedDocs/node';
- type Params = DocsParams;
- const productSelection = (params: Params): ProductSelectionMap => {
- return {
- [ProductSolution.ERROR_MONITORING]: true,
- [ProductSolution.PROFILING]: params.isProfilingSelected,
- [ProductSolution.PERFORMANCE_MONITORING]: params.isPerformanceSelected,
- [ProductSolution.SESSION_REPLAY]: params.isReplaySelected,
- };
- };
- const getSdkSetupSnippet = (params: Params) => `
- ${getDefaulServerlessImports({productSelection: productSelection(params)}).join('\n')}
- Sentry.AWSLambda.init({
- dsn: "${params.dsn}",
- integrations: [${
- params.isProfilingSelected
- ? `
- new ProfilingIntegration(),`
- : ''
- }
- ],${
- params.isPerformanceSelected
- ? `
- // Performance Monitoring
- tracesSampleRate: 1.0, // Capture 100% of the transactions`
- : ''
- }${
- params.isProfilingSelected
- ? `
- // Set sampling rate for profiling - this is relative to tracesSampleRate
- profilesSampleRate: 1.0,`
- : ''
- }
- });
- exports.handler = Sentry.AWSLambda.wrapHandler(async (event, context) => {
- // Your handler code
- });`;
- const getVerifySnippet = () => `
- exports.handler = Sentry.AWSLambda.wrapHandler(async (event, context) => {
- throw new Error("This should show up in Sentry!")
- });`;
- const getMetricsConfigureSnippet = (params: DocsParams) => `
- Sentry.AWSLambda.init({
- dsn: "${params.dsn}",
- _experiments: {
- metricsAggregator: true,
- },
- });`;
- const onboarding: OnboardingConfig = {
- install: params => [
- {
- type: StepType.INSTALL,
- description: t('Add the Sentry Serverless SDK as a dependency:'),
- configurations: getInstallConfig(params, {
- basePackage: '@sentry/serverless',
- }),
- },
- ],
- configure: params => [
- {
- type: StepType.CONFIGURE,
- description: tct(
- "Wrap your lambda handler with Sentry's [code:wraphandler] function:",
- {
- code: <code />,
- }
- ),
- configurations: [
- {
- language: 'javascript',
- code: getSdkSetupSnippet(params),
- },
- ],
- },
- getUploadSourceMapsStep({
- guideLink: 'https://docs.sentry.io/platforms/node/guides/aws-lambda/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:7.91.0] of [codePackage:@sentry/serverless]:',
- {
- codeVersion: <code />,
- codePackage: <code />,
- }
- ),
- configurations: getInstallConfig(params, {
- basePackage: '@sentry/serverless',
- }),
- },
- ],
- configure: params => [
- {
- type: StepType.CONFIGURE,
- description: tct(
- 'To enable capturing metrics, you first need to add the [codeIntegration:metricsAggregator] experiment to your [codeNamespace:Sentry.init] call in your main process.',
- {
- codeIntegration: <code />,
- codeNamespace: <code />,
- }
- ),
- configurations: [
- {
- code: [
- {
- label: 'JavaScript',
- value: 'javascript',
- language: 'javascript',
- code: getMetricsConfigureSnippet(params),
- },
- ],
- },
- ],
- },
- ],
- 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/node/guides/aws-lambda/user-feedback/configuration/#crash-report-modal',
- }),
- },
- ],
- verify: () => [],
- nextSteps: () => [],
- };
- const docs: Docs = {
- onboarding,
- customMetricsOnboarding,
- crashReportOnboarding,
- };
- export default docs;
|