# Cloud Functions for Firebase | Sentry for Cloud Functions for Firebase

[Cloud Functions for Firebase](https://firebase.google.com/docs/functions) let you automatically run backend code in response to events triggered by Firebase features and HTTPS requests. Sentry's Node SDK works out of the box with Cloud Functions for Firebase.

## [What's Instrumented](https://docs.sentry.io/platforms/javascript/guides/firebase.md#whats-instrumented)

The Sentry SDK includes a built-in [Firebase integration](https://docs.sentry.io/platforms/javascript/guides/firebase/configuration/integrations/firebase.md) that automatically instruments:

* **Cloud Functions** - HTTP functions, background functions, and event triggers
* **[Firestore](https://firebase.google.com/docs/firestore)** - Database operations like reads, writes, and queries are instrumented out of the box

This integration is enabled by default, so you get automatic performance monitoring and error tracking without any additional configuration.

## [Prerequisites](https://docs.sentry.io/platforms/javascript/guides/firebase.md#prerequisites)

You need:

* A Sentry [account](https://sentry.io/signup/) and [project](https://docs.sentry.io/product/projects.md)
* Your application up and running
* Node version `18.0.0` or above (>= `19.9.0` or `18.19.0` recommended)

Are you using Node version < 18.19.0 or < 19.9.0?

The required Node version will increase in the next major release of the SDK (v11) to support features that rely on [`TracingChannel`](https://nodejs.org/api/diagnostics_channel.html#class-tracingchannel).

* We strongly recommend upgrading to at least Node `18.19.0` or `19.9.0` to get the best support.
* While we may add features relying on `TracingChannel` in v10.x releases, they will have backwards compatibility for older Node versions.

See the following [issue on GitHub](https://github.com/getsentry/sentry-javascript/issues/17585) for more details.

## [Step 1: Install](https://docs.sentry.io/platforms/javascript/guides/firebase.md#step-1-install)

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

Error Monitoring\[ ]Logs\[ ]Tracing\[ ]Profiling

Want to learn more about these features?

* [**Issues**](https://docs.sentry.io/product/issues.md) (always enabled): Sentry's core error monitoring product that automatically reports errors, uncaught exceptions, and unhandled rejections. If you have something that looks like an exception, Sentry can capture it.
* [**Tracing**](https://docs.sentry.io/product/tracing.md): Track software performance while seeing the impact of errors across multiple systems. For example, distributed tracing allows you to follow a request from the frontend to the backend and back.
* [**Profiling**](https://docs.sentry.io/product/explore/profiling.md): Gain deeper insight than traditional tracing without custom instrumentation, letting you discover slow-to-execute or resource-intensive functions in your app.
* [**Logs**](https://docs.sentry.io/product/explore/logs.md): Centralize and analyze your application logs to correlate them with errors and performance issues. Search, filter, and visualize log data to understand what's happening in your applications.

### [Install the Sentry SDK](https://docs.sentry.io/platforms/javascript/guides/firebase.md#install-the-sentry-sdk)

Run the command for your preferred package manager to add the Sentry SDK to your Firebase Functions project:

```bash
npm install @sentry/node --save
```

## [Step 2: Configure](https://docs.sentry.io/platforms/javascript/guides/firebase.md#step-2-configure)

Create an initialization file (for example, `instrument.js`) that imports and initializes Sentry. This file must be imported at the very top of your functions entry point, before any other imports.

`instrument.js`

```javascript
const Sentry = require("@sentry/node");

Sentry.init({
  dsn: "___PUBLIC_DSN___",

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

  // Add Tracing by setting tracesSampleRate
  // 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___ profiling

  // Set profilesSampleRate to 1.0 to profile 100% of sampled transactions.
  // This is relative to tracesSampleRate
  profilesSampleRate: 1.0,
  // ___PRODUCT_OPTION_END___ profiling
  // ___PRODUCT_OPTION_START___ logs
  // Enable logs to be sent to Sentry
  enableLogs: true,
  // ___PRODUCT_OPTION_END___ logs
});
```

Import the initialization file at the very top of your functions entry point (for example, `index.js`), before any other imports:

`index.js`

```javascript
require("./instrument"); // Require Sentry initialization first

const { onRequest } = require("firebase-functions/https");
const { onDocumentCreated } = require("firebase-functions/firestore");
const admin = require("firebase-admin");

admin.initializeApp();

// HTTP function - automatically instrumented
exports.helloWorld = onRequest(async (request, response) => {
  response.send("Hello from Firebase!");
});

// Firestore trigger - automatically instrumented
exports.onUserCreated = onDocumentCreated(
  "users/{userId}",
  async (event) => {
    const userId = event.params.userId;
    // Your logic here
  },
);
```

The key is to import the initialization file **before** any other `require` calls, including Firebase imports. This ensures Sentry can properly instrument all modules.

## [Step 3: Add Readable Stack Traces With Source Maps (Optional)](https://docs.sentry.io/platforms/javascript/guides/firebase.md#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](https://docs.sentry.io/platforms/javascript/guides/firebase/sourcemaps.md) to Sentry. The easiest way to do this is by using the Sentry Wizard:

```bash
npx @sentry/wizard@latest -i sourcemaps
```

## [Step 4: Verify Your Setup](https://docs.sentry.io/platforms/javascript/guides/firebase.md#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](https://docs.sentry.io/platforms/javascript/guides/firebase.md#issues)

Add a test function that throws an error to verify Sentry is capturing errors:

`index.js`

```javascript
require("./instrument"); // Import Sentry initialization first
const { onRequest } = require("firebase-functions/https");

exports.testSentry = onRequest(async (request, response) => {
  throw new Error("Sentry Test Error - This is intentional!");
});
```

Deploy your functions and trigger the test endpoint:

```bash
firebase deploy --only functions
curl https://<region>-<project-id>.cloudfunctions.net/testSentry
```

### [Tracing](https://docs.sentry.io/platforms/javascript/guides/firebase.md#tracing)

Firebase Functions are automatically instrumented for tracing. You can also create custom spans:

`index.js`

```javascript
require("./instrument");
const Sentry = require("@sentry/node");
const { onRequest } = require("firebase-functions/https");

exports.tracedFunction = onRequest(async (request, response) => {
  await Sentry.startSpan(
    { op: "task", name: "My Custom Task" },
    async () => {
      // Simulate some work
      await new Promise((resolve) => setTimeout(resolve, 100));
    },
  );

  response.send("Done!");
});
```

### [View Captured Data in Sentry](https://docs.sentry.io/platforms/javascript/guides/firebase.md#view-captured-data-in-sentry)

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

Need help locating the captured errors in your Sentry project?

1. Open the [**Issues**](https://sentry.io/orgredirect/organizations/:orgslug/issues) page and select an error from the issues list to view the full details and context of this error. For an interactive UI walkthrough, click [here](https://docs.sentry.io/product/sentry-basics/integrate-frontend/generate-first-error.md#ui-walkthrough).
2. Open the [**Traces**](https://sentry.io/orgredirect/organizations/:orgslug/traces) page and select a trace to reveal more information about each span, its duration, and any errors. For an interactive UI walkthrough, click [here](https://docs.sentry.io/product/sentry-basics/distributed-tracing/generate-first-error.md#ui-walkthrough).
3. Open the [**Profiles**](https://sentry.io/orgredirect/organizations/:orgslug/profiling) page, select a transaction, and then a profile ID to view its flame graph. For more information, click [here](https://docs.sentry.io/product/explore/profiling/profile-details.md).
4. Open the [**Logs**](https://sentry.io/explore/logs) page and filter by service, environment, or search keywords to view log entries from your application. For an interactive UI walkthrough, click [here](https://docs.sentry.io/product/explore/logs.md#overview).

## [Next Steps](https://docs.sentry.io/platforms/javascript/guides/firebase.md#next-steps)

At this point, you should have integrated Sentry into your Cloud Functions for Firebase project.

Now's a good time to customize your setup and look into more advanced topics:

* Explore [practical guides](https://docs.sentry.io/guides.md) on what to monitor, log, track, and investigate after setup
* Continue to [customize your configuration](https://docs.sentry.io/platforms/javascript/guides/firebase/configuration.md)
* Learn how to [manually capture errors](https://docs.sentry.io/platforms/javascript/guides/firebase/usage.md)
* Get familiar with [Sentry's product features](https://docs.sentry.io/product.md) like tracing, insights, and alerts

Are you having problems setting up the SDK?

* Find various topics in [Troubleshooting](https://docs.sentry.io/platforms/javascript/guides/firebase/troubleshooting.md)
* [Get support](https://sentry.zendesk.com/hc/en-us/)

## Other JavaScript Frameworks

- [Angular](https://docs.sentry.io/platforms/javascript/guides/angular.md)
- [Astro](https://docs.sentry.io/platforms/javascript/guides/astro.md)
- [AWS Lambda](https://docs.sentry.io/platforms/javascript/guides/aws-lambda.md)
- [Azure Functions](https://docs.sentry.io/platforms/javascript/guides/azure-functions.md)
- [Bun](https://docs.sentry.io/platforms/javascript/guides/bun.md)
- [Capacitor](https://docs.sentry.io/platforms/javascript/guides/capacitor.md)
- [Cloudflare](https://docs.sentry.io/platforms/javascript/guides/cloudflare.md)
- [Connect](https://docs.sentry.io/platforms/javascript/guides/connect.md)
- [Cordova](https://docs.sentry.io/platforms/javascript/guides/cordova.md)
- [Deno](https://docs.sentry.io/platforms/javascript/guides/deno.md)
- [Electron](https://docs.sentry.io/platforms/javascript/guides/electron.md)
- [Ember](https://docs.sentry.io/platforms/javascript/guides/ember.md)
- [Express](https://docs.sentry.io/platforms/javascript/guides/express.md)
- [Fastify](https://docs.sentry.io/platforms/javascript/guides/fastify.md)
- [Gatsby](https://docs.sentry.io/platforms/javascript/guides/gatsby.md)
- [Google Cloud Functions](https://docs.sentry.io/platforms/javascript/guides/gcp-functions.md)
- [Hapi](https://docs.sentry.io/platforms/javascript/guides/hapi.md)
- [Hono](https://docs.sentry.io/platforms/javascript/guides/hono.md)
- [Koa](https://docs.sentry.io/platforms/javascript/guides/koa.md)
- [Nest.js](https://docs.sentry.io/platforms/javascript/guides/nestjs.md)
- [Next.js](https://docs.sentry.io/platforms/javascript/guides/nextjs.md)
- [Node.js](https://docs.sentry.io/platforms/javascript/guides/node.md)
- [Nuxt](https://docs.sentry.io/platforms/javascript/guides/nuxt.md)
- [React](https://docs.sentry.io/platforms/javascript/guides/react.md)
- [React Router Framework](https://docs.sentry.io/platforms/javascript/guides/react-router.md)
- [Remix](https://docs.sentry.io/platforms/javascript/guides/remix.md)
- [Solid](https://docs.sentry.io/platforms/javascript/guides/solid.md)
- [SolidStart](https://docs.sentry.io/platforms/javascript/guides/solidstart.md)
- [Svelte](https://docs.sentry.io/platforms/javascript/guides/svelte.md)
- [SvelteKit](https://docs.sentry.io/platforms/javascript/guides/sveltekit.md)
- [TanStack Start React](https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react.md)
- [Vue](https://docs.sentry.io/platforms/javascript/guides/vue.md)
- [Wasm](https://docs.sentry.io/platforms/javascript/guides/wasm.md)

## Topics

- [Capturing Errors](https://docs.sentry.io/platforms/javascript/guides/firebase/usage.md)
- [Source Maps](https://docs.sentry.io/platforms/javascript/guides/firebase/sourcemaps.md)
- [Logs](https://docs.sentry.io/platforms/javascript/guides/firebase/logs.md)
- [Session Replay](https://docs.sentry.io/platforms/javascript/guides/firebase/session-replay.md)
- [Tracing](https://docs.sentry.io/platforms/javascript/guides/firebase/tracing.md)
- [AI Agent Monitoring](https://docs.sentry.io/platforms/javascript/guides/firebase/ai-agent-monitoring-browser.md)
- [Metrics](https://docs.sentry.io/platforms/javascript/guides/firebase/metrics.md)
- [Profiling](https://docs.sentry.io/platforms/javascript/guides/firebase/profiling.md)
- [User Feedback](https://docs.sentry.io/platforms/javascript/guides/firebase/user-feedback.md)
- [Sampling](https://docs.sentry.io/platforms/javascript/guides/firebase/sampling.md)
- [Enriching Events](https://docs.sentry.io/platforms/javascript/guides/firebase/enriching-events.md)
- [Extended Configuration](https://docs.sentry.io/platforms/javascript/guides/firebase/configuration.md)
- [Feature Flags](https://docs.sentry.io/platforms/javascript/guides/firebase/feature-flags.md)
- [Data Management](https://docs.sentry.io/platforms/javascript/guides/firebase/data-management.md)
- [Security Policy Reporting](https://docs.sentry.io/platforms/javascript/guides/firebase/security-policy-reporting.md)
- [Special Use Cases](https://docs.sentry.io/platforms/javascript/guides/firebase/best-practices.md)
- [Migration Guide](https://docs.sentry.io/platforms/javascript/guides/firebase/migration.md)
- [Troubleshooting](https://docs.sentry.io/platforms/javascript/guides/firebase/troubleshooting.md)
