123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164 |
- 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 performanceOtherConfig = `// Performance Monitoring
- tracesSampleRate: 1.0, // Capture 100% of the transactions, reduce in production!`;
- export const steps = ({
- sentryInitContent,
- }: Partial<StepProps> = {}): LayoutProps['steps'] => [
- {
- type: StepType.INSTALL,
- description: (
- <p>
- {tct(
- 'Add the Sentry Serverless SDK as a dependency to your [code:package.json]:',
- {code: <code />}
- )}
- </p>
- ),
- configurations: [
- {
- language: 'json',
- code: `
- dependencies: {
- //...
- "@sentry/serverless": "^7"
- }
- `,
- },
- ],
- },
- {
- title: t('Configure SDK for Http Functions'),
- description: (
- <p>
- {tct('Use [code:wrapHttpFunction] to wrap your http function:', {
- code: <code />,
- })}
- </p>
- ),
- configurations: [
- {
- language: 'javascript',
- code: `
- const Sentry = require("@sentry/serverless");
- Sentry.GCPFunction.init({
- ${sentryInitContent}
- });
- exports.helloHttp = Sentry.GCPFunction.wrapHttpFunction((req, res) => {
- /* Your function code */
- });
- `,
- },
- ],
- },
- {
- title: t('Configure SDK for Background Functions'),
- description: (
- <p>
- {tct('Use [code:wrapEventFunction] to wrap your background function:', {
- code: <code />,
- })}
- </p>
- ),
- configurations: [
- {
- language: 'javascript',
- code: `
- const Sentry = require("@sentry/serverless");
- Sentry.GCPFunction.init({
- ${sentryInitContent}
- });
- exports.helloEvents = Sentry.GCPFunction.wrapEventFunction(
- (data, context, callback) => {
- /* Your function code */
- }
- );
- `,
- },
- ],
- },
- {
- title: t('Configure SDK for CloudEvent Functions'),
- description: (
- <p>
- {tct('Use [code:wrapCloudEventFunction] to wrap your CloudEvent function:', {
- code: <code />,
- })}
- </p>
- ),
- configurations: [
- {
- language: 'javascript',
- code: `
- const Sentry = require("@sentry/serverless");
- Sentry.GCPFunction.init({
- ${sentryInitContent}
- });
- exports.helloEvents = Sentry.GCPFunction.wrapCloudEventFunction(
- (context, callback) => {
- /* Your function code */
- }
- );
- `,
- },
- ],
- },
- {
- 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: `
- exports.helloHttp = Sentry.GCPFunction.wrapHttpFunction((req, res) => {
- throw new Error("oh, hello there!");
- });
- `,
- },
- ],
- },
- ];
- export function GettingStartedWithGCPFunctions({dsn, newOrg, platformKey}: ModuleProps) {
- let sentryInitContent: string[] = [`dsn: "${dsn}",`];
- const otherConfigs = [performanceOtherConfig];
- if (otherConfigs.length > 0) {
- sentryInitContent = sentryInitContent.concat(otherConfigs);
- }
- return (
- <Layout
- steps={steps({
- sentryInitContent: sentryInitContent.join('\n'),
- })}
- newOrg={newOrg}
- platformKey={platformKey}
- />
- );
- }
- export default GettingStartedWithGCPFunctions;
|