Google Cloud Functions

Prerequisites

You need:

• A Sentry account and project
• Your application up and running

Step 1: Install

Choose the features you want to configure, and this guide will show you how:

Install the Sentry SDK

Run the command for your preferred package manager to add the Sentry SDK to your application:

npm install @sentry/google-cloud-serverless --save

npm install @sentry/google-cloud-serverless @sentry/profiling-node --save

Step 2: Configure

Make sure to initialize Sentry at the top of your function code and wrap each function with the appropriate helper. Select the tab that matches the kind of function you're using (HTTP, Background, or CloudEvent):

const Sentry = require("@sentry/google-cloud-serverless");

Sentry.init({
  dsn: "___PUBLIC_DSN___",

  // Adds request headers and IP for users, for more info visit:
  // https://docs.sentry.io/platforms/javascript/guides/gcp-functions/configuration/options/#sendDefaultPii
  sendDefaultPii: true,
  // ___PRODUCT_OPTION_START___ performance

  // Add Tracing by setting tracesSampleRate and adding integration
  // Set tracesSampleRate to 1.0 to capture 100% of transactions
  // We recommend adjusting this value in production
  // Learn more at
  // https://docs.sentry.io/platforms/javascript/configuration/options/#traces-sample-rate
  tracesSampleRate: 1.0,
  // ___PRODUCT_OPTION_END___ performance
  // ___PRODUCT_OPTION_START___ logs

  // Enable logs to be sent to Sentry
  enableLogs: true,
  // ___PRODUCT_OPTION_END___ logs
});

exports.helloHttp = Sentry.wrapHttpFunction((req, res) => {
  // your code
});

Step 3: Add Readable Stack Traces With Source Maps (Optional)

The stack traces in your Sentry errors probably won't look like your actual code without unminifying them. To fix this, upload your source maps to Sentry. The easiest way to do this is by using the Sentry Wizard:

npx @sentry/wizard@latest -i sourcemaps

Step 4: Verify Your Setup

Let's test your setup and confirm that Sentry is working correctly and sending data to your Sentry project.

Issues

First, let's verify that Sentry captures errors and creates issues in your Sentry project. Add an intentional error in your function:

exports.helloHttp = Sentry.wrapHttpFunction((req, res) => {
  throw new Error("Sentry Test Error - This is intentional!");
});

exports.helloHttp = Sentry.wrapHttpFunction(async (req, res) => {
  await Sentry.startSpan(
    { op: "test", name: "My First Test Transaction" },
    async () => {
      // Simulate some work
      await new Promise((resolve) => setTimeout(resolve, 100));
    },
  );

  res.status(200).send("Success!");
});

View Captured Data in Sentry

Now, head over to your project on Sentry.io to view the collected data (it takes a couple of moments for the data to appear).

Next Steps

At this point, you should have integrated Sentry into your Google Cloud Platform functions, which should already be sending data to your Sentry project.

Now's a good time to customize your setup and look into more advanced topics. Our next recommended steps for you are:

• Continue to customize your configuration
• Learn how to manually capture errors
• Get familiar with Sentry's product features like tracing, insights, and alerts