React Native

Features:

On this page, we get you up and running with Sentry's SDK, so that it will automatically report errors and exceptions in your application.

Don't already have an account and Sentry project established? Head over to sentry.io, then return to this page.

Install

Sentry captures data by using an SDK within your application’s runtime.

Add the @sentry/react-native dependency:

Copied
npm install --save @sentry/react-native

Expo

If you are using Expo, see How to Add Sentry to Your Expo Project. This SDK works for both managed and bare projects.

Linking

Link the SDK to your native projects to enable native crash reporting.

Copied
react-native link @sentry/react-native
Copied
npx @sentry/wizard -i reactNative -p ios android

cd ios
pod install

The call to the Sentry Wizard will patch your project accordingly, though you can link manually if you prefer. You need to do this only once, then the created files can go into your version control system.

The following changes will be performed by Sentry Wizard:

  • add the sentry-android package for native crash reporting on Android
  • add the sentry-cocoa package for native crash reporting on iOS
  • enable the Sentry Gradle build step for Android
  • patch MainApplication.java for Android
  • configure Sentry for the supplied DSN in your index.js/App.js files
  • store build credentials in ios/sentry.properties and android/sentry.properties.

iOS Specifics

When you use Xcode, you can hook directly into the build process to upload debug symbols and source maps. However, if you are using bitcode, you will need to disable the “Upload Debug Symbols to Sentry” build phase and then separately upload debug symbols from iTunes Connect to Sentry.

Android Specifics

For Android, we hook into Gradle for the source map build process. When you run react-native link, the Gradle files are automatically updated. When you run ./gradlew assembleRelease or ./gradlew bundleRelease, source maps are automatically built and uploaded to Sentry.

If you have enabled Gradle's org.gradle.configureondemand feature, you'll need a clean build, or you'll need to disable this feature to upload the source map on every build.

To disable this feature, set org.gradle.configureondemand=false or remove it as its default value is disabled, do this in the gradle.properties file.

Configure

Configuration should happen as early as possible in your application's lifecycle.

Initialize

To initialize the SDK, you need to call:

App.js
Copied
import * as Sentry from "@sentry/react-native";

Sentry.init({
  dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
});

Once this is done, all unhandled exceptions will be automatically captured by Sentry. You can also perform the following optional steps:

Wrap Your App

Wrap your app with Sentry to automatically instrument it with touch event tracking and automatic performance monitoring:

App.js
Copied
export default Sentry.wrap(App);

Enable Performance Monitoring

Learn how to enable Sentry's performance monitoring in your SDK to help you track your application performance, measuring metrics like throughput and latency.

Verify

This snippet includes an intentional error, so you can test that everything is working as soon as you set it up:

Copied
throw new Error("My first Sentry error!");

Or, try a native crash:

Copied
Sentry.nativeCrash();

To view and resolve the recorded error, log into sentry.io and open your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.

Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) to suggesting an update ("yeah, this would be better").