HomeGuidesReferenceLearn
ArchiveExpo SnackDiscord and ForumsNewsletter

Use Sentry

Edit this page

A guide on installing and configuring Sentry for crash reporting.


Sentry is a crash reporting platform that provides you with real-time insight into production deployments with info to reproduce and fix crashes.

It notifies you of exceptions or errors that your users run into while using your app and organizes them for you on a web dashboard. Reported exceptions include stacktraces, device info, version, and other relevant context automatically. You can also provide additional context that is specific to your application such as the current route and user id.

Platform compatibility

Android DeviceAndroid EmulatoriOS DeviceiOS SimulatorWeb

Install and configure Sentry

1

Sign up for a Sentry account and create a project

Before proceeding with installing Sentry, you'll need to make sure you have created a Sentry account and project:

1.1

Sign up for Sentry (the free tier supports up to 5,000 events per month), and create a project in your Dashboard. Take note of your organization slug, project name, and DSN as you'll need them later:

  • organization slug is available in your Organization settings tab
  • project name is available in your project's Settings > Projects tab (find it in the list)
  • DSN is available in your project's Settings > Projects > Project name > Client Keys (DSN) tab.

1.2

Go to the Developer Settings > Auth Tokens page and create a new token. The token is automatically scoped for Source Map Upload and Release Creation. Save it.

Once you have each of these: organization slug, project name, DSN, and auth token, you're all set to proceed.

2

Install @sentry/react-native

Run the following command in your project directory to install the official React Native library from the Sentry team:

Terminal
npx expo install @sentry/react-native

3

App configuration

Configuring @sentry/react-native can be done through the config plugin. Add the plugin to your project's app config file:

app.json
{
  "expo": {
    "plugins": [
      [
        "@sentry/react-native/expo",
        {
          "organization": "sentry org slug, or use the `SENTRY_ORG` environment variable",
          "project": "sentry project name, or use the `SENTRY_PROJECT` environment variable"
        }
      ]
    ]
  }
}

Next, in an environment where you want to create releases and upload sourcemaps to Sentry, you will need to set the SENTRY_AUTH_TOKEN environment variable to your Sentry auth token. If you are using EAS Build, you can set the environment variable by creating a secret named SENTRY_AUTH_TOKEN.

The Sentry auth token should be stored securely. Do not commit it to a public repository, and treat it as you would any other sensitive API key.
When to add url to @sentry/react-native/expo config plugin?

If you are using a self-hosted instance, you need to add the url property to the @sentry/react-native/expo config plugin.

app.json
{
  "expo": {
    "plugins": [
      [
        "@sentry/react-native/expo",
        {
          /*@hide ...*/ /*@end*/
          "url": "https://self-hosted.example.com"
        }
      ]
    ]
  }
}
Are you using this library in a bare React Native app?

If you do not use Continuous Native Generation (CNG), then you should use the @sentry/wizard.

4

Update Metro configuration

Sentry hooks into Metro to inject a "debug ID" into your source maps. This debug ID is used to associate source maps with releases. To enable this, you need to add the following to your metro.config.js (if you don't have the file yet, create it in the root of your project):

metro.config.js
// This replaces `const { getDefaultConfig } = require('expo/metro-config');`
const { getSentryExpoConfig } = require('@sentry/react-native/metro');

// This replaces `const config = getDefaultConfig(__dirname);`
const config = getSentryExpoConfig(__dirname);

module.exports = config;

5

Initialize Sentry

Add the following to your app's main file such as App.js:

import * as Sentry from '@sentry/react-native';

Sentry.init({
  dsn: 'YOUR DSN HERE',
  debug: true, // If `true`, Sentry will try to print out useful debugging information if something goes wrong with sending the event. Set it to `false` in production
});

Now wrap the root component of your app with Sentry. This may be App.js or index.js depending on your project. If you are using Expo Router, see the example configuration in the Usage with Expo Router section below.

import * as Sentry from '@sentry/react-native';

// Your App component here

export default Sentry.wrap(App);

6

Verify the configuration

Create a new release build of your app and verify that it uploads source maps correctly. You may want to add a button in your app to test that it is working and sourcemaps are wired up as expected, for example:

import { Button } from 'react-native';

// Inside some component
<Button title="Press me" onPress={() => { throw new Error('Hello, again, Sentry!'); }}/>

Usage with Expo Router

If your app uses Expo Router, then you can configure Sentry to automatically capture the current route and pass it along with your error reports. To set this up, configure Sentry in the Root Layout route and add routing instrumentation.

Example configuration that instruments Sentry for Expo Router
app/_layout.tsx
import { Slot, useNavigationContainerRef } from 'expo-router';
import React from 'react';
import * as Sentry from '@sentry/react-native';
import { isRunningInExpoGo } from 'expo';

// Construct a new instrumentation instance. This is needed to communicate between the integration and React
const routingInstrumentation = new Sentry.ReactNavigationInstrumentation();

Sentry.init({
  dsn: 'YOUR DSN HERE',
  debug: true, // If `true`, Sentry will try to print out useful debugging information if something goes wrong with sending the event. Set it to `false` in production
  integrations: [
    new Sentry.ReactNativeTracing({
      // Pass instrumentation to be used as `routingInstrumentation`
      routingInstrumentation,
      enableNativeFramesTracking: !isRunningInExpoGo(),
      // ...
    }),
  ],
});

function RootLayout() {
  // Capture the NavigationContainer ref and register it with the instrumentation.
  const ref = useNavigationContainerRef();

  React.useEffect(() => {
    if (ref) {
      routingInstrumentation.registerNavigationContainer(ref);
    }
  }, [ref]);

  return <Slot />;
}

// Wrap the Root Layout route component with `Sentry.wrap` to capture gesture info and profiling data.
export default Sentry.wrap(RootLayout);

Usage with EAS Build

Ensure that SENTRY_AUTH_TOKEN is set in your build environment, and Sentry will automatically upload source maps for you. If you use environment variables rather than properties in your app config, ensure that those are set as well.

Using the above instructions, no additional work is needed to integrate Sentry into your project when using EAS Build.

Usage with EAS Update

After running eas update, upload the source maps to Sentry:

Terminal
# Pass in the `dist` directory generated by `eas update` to the upload script
npx sentry-expo-upload-sourcemaps dist

That's it! Errors for your updates will now be properly symbolicated in Sentry.

Do you want to publish an update and the sourcemaps in one command?

You can chain the commands together with && to publish an update and upload the sourcemaps in one step:

Terminal
eas update --branch <branch> && npx sentry-expo-upload-sourcemaps dist

sentry-expo has been merged into @sentry/react-native and is now deprecated. We recommend upgrading to SDK 50 to use @sentry/react-native for the best experience. If you're already using sentry-expo, learn how to migrate.

1

Sign up for a Sentry account and create a project

Before getting real-time updates on errors and making your app generally incredible, you'll need to make sure you have created a Sentry project. Here's how to do that:

1.1

Sign up for Sentry (it's free), and create a project in your Dashboard. Take note of your organization slug, project name, and DSN as you'll need them later:

  • organization slug is available in your Organization settings tab
  • project name is available in your project's Settings > Projects tab (find it in the list)
  • DSN is available in your project's Settings > Projects > Project name > Client Keys (DSN) tab.

1.2

Go to the Sentry API section, and create an auth token. The token requires the scopes: org:read, project:releases, and project:write. Save them.

Once you have each of these: organization slug, project name, DSN, and auth token, you're all set!

2

Installation

In your project directory, run:

Terminal
npx expo install sentry-expo

sentry-expo also requires some additional Expo module packages. To install them, run:

Terminal
npx expo install expo-application expo-constants expo-device @sentry/react-native

3

Code

Initialization

Add the following to your app's main file such as App.js:

import * as Sentry from 'sentry-expo';

Sentry.init({
  dsn: 'YOUR DSN HERE',
  enableInExpoDevelopment: true,
  debug: true, // If `true`, Sentry will try to print out useful debugging information if something goes wrong with sending the event. Set it to `false` in production
});

Usage

Depending on which platform you are on (mobile or web), use the following methods to access any @sentry/* methods for instrumentation, performance, capturing exceptions and so on:

  • For React Native, access any @sentry/react-native exports with Sentry.Native.*
  • For web, access any @sentry/browser exports with Sentry.Browser.*
// Access any @sentry/react-native exports via:
// Sentry.Native.*

// Access any @sentry/browser exports via:
// Sentry.Browser.*

// The following example uses `captureException()` from Sentry.Native.* to capture errors:
try {
  // your code
} catch (error) {
  Sentry.Native.captureException(error);
}

4

App configuration

Configuring sentry-expo is done through the config plugin in your app config.

Are you using this library in a bare React Native app?

If you use bare workflow, you should not use the plugins property in app config. Instead, run yarn sentry-wizard -i reactNative -p ios android to configure your native projects. This sentry-wizard command will add an extra import statement and Sentry.init to your project's root file (usually App.js) as shown below. Make sure you remove it, however, keep the sentry-expo import and original Sentry.init call.

import * as Sentry from '@sentry/react-native';

Sentry.init({
  dsn: 'YOUR DSN',
});

Configure a postPublish hook

Add expo.hooks property to your project's app.json or app.config.js file:

app.json
{
  "expo": {
    %%placeholder-start%%... your existing configuration %%placeholder-end%%
    "hooks": {
      "postPublish": [
        {
          "file": "sentry-expo/upload-sourcemaps",
          "config": {
            "organization": "sentry org slug, or use the `SENTRY_ORG` environment variable",
            "project": "sentry project name, or use the `SENTRY_PROJECT` environment variable"
          }
        }
      ]
    }
  }
}

To upload the source map to Sentry, you must create a Sentry auth token. After creating your Sentry auth token in your account's settings here, you can configure this token through the SENTRY_AUTH_TOKEN environment variable in EAS Build.

The Sentry auth token should be stored securely. Do not commit it to a public repository, and treat it as you would any other sensitive API key.

Besides the auth token, you can also configure the following options through environment variables:

  • organization → SENTRY_ORG
  • project → SENTRY_PROJECT
Additional configuration options

In addition to the required config fields above, you can also provide these optional fields:

  • setCommits: boolean value indicating whether or not to tell Sentry about which commits are associated with a new release. This allows Sentry to pinpoint which commits likely caused an issue.
  • deployEnv: string indicating the deploy environment. This will automatically send an email to Sentry users who have committed to the release that is being deployed.
  • distribution: The name/value to give your distribution (you can think of this as a sub-release). Expo defaults to using your version from app.json. If you provide a custom distribution, you must pass the same value to dist in your call to Sentry.init(), otherwise you will not see stacktraces in your error reports.
  • release: The name you'd like to give your release (for example, release-feature-ABC). This defaults to a unique revisionId of your JS bundle. If you provide a custom release, you must pass in the same release value to Sentry.init(), otherwise you will not see stacktraces in your error reports.
  • url: your Sentry URL, only necessary when self-hosting Sentry.

You can also use environment variables for your config, if you prefer:

  • setCommits → SENTRY_SET_COMMITS
  • deployEnv → SENTRY_DEPLOY_ENV
  • distribution → SENTRY_DIST
  • release → SENTRY_RELEASE
  • url → SENTRY_URL

Add the Config Plugin

Add the following to your project's app.json or app.config.js file:

app.json
{
  "expo": {
    "plugins": ["sentry-expo"]
    %%placeholder-start%%... your existing configuration %%placeholder-end%%
  }
}

Source maps

With the postPublish hook in place, now all you need to do is run expo-cli publish and the source maps will be uploaded automatically. We automatically assign a unique release version for Sentry each time you hit publish, based on the version you specify in app.json and a release id on our backend -- this means that if you forget to update the version but hit publish, you will still get a unique Sentry release.

Uploading source maps at build time

With expo-updates, release builds of both Android and iOS apps will create and embed a new update from your JavaScript source at build-time. This new update will not be published automatically and will exist only in the binary with which it was bundled. Since it isn't published, the source maps aren't uploaded in the usual way like they are when you run expo-cli publish (actually, we are relying on Sentry's native scripts to handle that). Because of this you have some extra things to be aware of:

  • Your release will automatically be set to Sentry's expected value- ${bundleIdentifier}@${version}+${buildNumber} (iOS) or ${androidPackage}@${version}+${versionCode} (Android).
  • Your dist will automatically be set to Sentry's expected value: ${buildNumber} (iOS) or ${versionCode} (Android).
  • The configuration for build time source maps comes from the android/sentry.properties and ios/sentry.properties files. For more information, see Sentry's documentation. Manual configuration is only required for bare projects, the sentry-expo config plugin handles it otherwise.
  • Configuration for expo publish and npx expo export for projects is done via app.json, whether using bare workflow or not.

Skipping or misconfiguring either of these can lead to invalid source maps, and you won't see human-readable stacktraces in your errors.

Uploading source maps for updates

If you're using EAS Update, or if you're self-hosting your updates (this means you run npx expo export manually), you need to take the following steps to upload the source maps for your update to Sentry:

  • Run eas update. This will generate a dist folder in your project root, which contains your JavaScript bundles and source maps. This command will also output the 'Android update ID' and 'iOS update ID' that we'll need in the next step.
  • Copy or rename the bundle names in the dist/bundles folder to match index.android.bundle (Android) or main.jsbundle (iOS).
  • Next, you can use the Sentry CLI to upload your bundles and source maps:
    • release name should be set to ${bundleIdentifier}@${version}+${buildNumber} (iOS) or ${androidPackage}@${version}+${versionCode} (Android), so for example com.domain.myapp@1.0.0+1.
    • dist should be set to the Update ID that eas update generated.
Terminal
node_modules/@sentry/cli/bin/sentry-cli releases \
files <release name> \ upload-sourcemaps \ --dist <Android Update ID> \ --rewrite \ dist/bundles/index.android.bundle dist/bundles/android-<hash>.map
Terminal
node_modules/@sentry/cli/bin/sentry-cli releases \
files <release name> \ upload-sourcemaps \ --dist <iOS Update ID> \ --rewrite \ dist/bundles/main.jsbundle dist/bundles/ios-<hash>.map

For more information, see Sentry's instructions for uploading the bundle and source maps.

The steps above define a new 'dist' on Sentry, under the same release as your full app build, and associate the source maps with this new dist. If you want to customize this behavior, you can pass in your own values for release and dist when you initialize Sentry in your code. For example:

import * as Sentry from 'sentry-expo';
import * as Updates from 'expo-updates';

Sentry.init({
  dsn: 'YOUR DSN',
  release: 'my release name',
  dist: 'my dist',
});

These values should match the values you pass to the sentry-cli when uploading your source maps.

Testing Sentry

When building tests for your application, you want to assert that the right flow-tracking or error is being sent to Sentry, but without really sending it to Sentry servers. This way you won't swamp Sentry with false reports during test running and other CI operations.

sentry-testkit enables Sentry to work natively in your application, and by overriding the default Sentry transport mechanism, the report is not really sent but rather logged locally into memory. In this way, the logged reports can be fetched later for your own usage, verification, or any other use you may have in your local developing/testing environment.

For more information on how to get started, see sentry-testkit documentation.

If you're using jest, make sure to add @sentry/.* and sentry-expo to your transformIgnorePatterns.

Error reporting semantics

To ensure that errors are reported reliably, Sentry defers reporting the data to their backend until the next time you load the app after a fatal error rather than trying to report it upon catching the exception. It saves the stacktrace and other metadata to AsyncStorage and sends it immediately when the app starts.

Disabled by default in dev

Unless enableInExpoDevelopment: true is set, all your dev/local errors will be ignored and only app releases will report errors to Sentry. You can call methods like Sentry.Native.captureException(new Error('Oops!')) but these methods will be no-op.

Troubleshooting

I'm seeing error: project not found in my build logs

This error is caused by the script that tries to upload source maps during build.

Make sure your organization, project and authToken properties are set correctly.

expo-dev-client transactions never finish

This error is caused by the HTTP request tracking, which creates spans for log requests (Starting 'http.client' span on transaction...) to the development server. To fix this, stop creating spans by adding the following code snippet:

import * as Sentry from 'sentry-expo';
import Constants from 'expo-constants';

Sentry.init({
  tracesSampleRate: 1.0,
  integrations: [
    new Sentry.Native.ReactNativeTracing({
      shouldCreateSpanForRequest: url => {
        return !__DEV__ || !url.startsWith(`http://${Constants.expoConfig.hostUri}/logs`);
      },
    }),
  ],
});

Learn more about Sentry

Sentry does more than just catch fatal errors, learn more about how to use Sentry from their JavaScript usage documentation.