123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135 |
- import {Layout, LayoutProps} from 'sentry/components/onboarding/gettingStartedDoc/layout';
- import {ModuleProps} from 'sentry/components/onboarding/gettingStartedDoc/sdkDocumentation';
- import {StepType} from 'sentry/components/onboarding/gettingStartedDoc/step';
- import {PlatformKey} from 'sentry/data/platformCategories';
- import {t, tct} from 'sentry/locale';
- import type {Organization} from 'sentry/types';
- type StepProps = {
- newOrg: boolean;
- organization: Organization;
- platformKey: PlatformKey;
- projectId: string;
- sentryInitContent: string;
- };
- const performanceIntegrations: string[] = [
- `// enable HTTP calls tracing
- new Sentry.Integrations.Http({ tracing: true }),`,
- `// enable Express.js middleware tracing
- new Sentry.Integrations.Express({ app }),`,
- `// Automatically instrument Node.js libraries and frameworks
- ...Sentry.autoDiscoverNodePerformanceMonitoringIntegrations(),`,
- ];
- const performanceOtherConfig = `environment: params.INSTANCE_NAME,
- // Performance Monitoring
- // Capture 100% of the transactions, reduce in production!
- tracesSampleRate: 1.0, `;
- export const steps = ({
- sentryInitContent,
- }: Partial<StepProps> = {}): LayoutProps['steps'] => [
- {
- type: StepType.INSTALL,
- description: (
- <p>{tct('Add [code:@sentry/node] as a dependency:', {code: <code />})}</p>
- ),
- configurations: [
- {
- language: 'bash',
- code: `cloud install @sentry/node:`,
- },
- ],
- },
- {
- type: StepType.CONFIGURE,
- description: t('Sentry should be initialized as early in your app as possible.'),
- configurations: [
- {
- language: 'javascript',
- code: `
- import api from "@serverless/cloud";
- import * as Sentry from "@sentry/node";
- // or using CommonJS
- // const api = require("@serverless/cloud");
- // const Sentry = require('@sentry/node');
- Sentry.init({
- ${sentryInitContent},
- });
- // RequestHandler creates a separate execution context, so that all
- // transactions/spans/breadcrumbs are isolated across requests
- api.use(Sentry.Handlers.requestHandler());
- // TracingHandler creates a trace for every incoming request
- api.use(Sentry.Handlers.tracingHandler());
- // All controllers should live here
- api.get("/", function rootHandler(req, res) {
- res.end("Hello world!");
- });
- // The error handler must be before any other error middleware and after all controllers
- api.use(Sentry.Handlers.errorHandler());
- // Optional fallthrough error handler
- api.use(function onError(err, req, res, next) {
- // The error id is attached to \`res.sentry\` to be returned
- // and optionally displayed to the user for support.
- res.statusCode = 500;
- res.end(res.sentry + "\\n");
- });
- `,
- },
- ],
- },
- {
- 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: `
- api.get("/debug-sentry", function mainHandler(req, res) {
- throw new Error("My first Sentry error!");
- });
- `,
- },
- ],
- },
- ];
- export function GettingStartedWithServerlesscloud({
- dsn,
- newOrg,
- platformKey,
- }: ModuleProps) {
- let sentryInitContent: string[] = [`dsn: "${dsn}",`];
- const integrations = [...performanceIntegrations];
- const otherConfigs = [performanceOtherConfig];
- if (integrations.length > 0) {
- sentryInitContent = sentryInitContent.concat('integrations: [', integrations, '],');
- }
- if (otherConfigs.length > 0) {
- sentryInitContent = sentryInitContent.concat(otherConfigs);
- }
- return (
- <Layout
- steps={steps({
- sentryInitContent: sentryInitContent.join('\n'),
- })}
- newOrg={newOrg}
- platformKey={platformKey}
- />
- );
- }
- export default GettingStartedWithServerlesscloud;
|