Cordova

Prerequisites

You need:

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

Step 1: Install

Install the Sentry SDK

Run this cordova command to add the Sentry SDK to your application:

cordova plugin add sentry-cordova

This command starts the Sentry Wizard, which will patch your project (you need to do this only once). The wizard helps configure your project by:

• Linking your Sentry account and project
• Adding a build step to Xcode to upload debug symbols for iOS crashes
• Configuring source map uploads so you can see your original JavaScript code in Sentry instead of minified production code

Step 2: Configure

Initialize the Sentry SDK

Initialize Sentry as early as possible in your application. For this, init the SDK in the deviceready event:

onDeviceReady: function() {
  var Sentry = cordova.require("sentry-cordova.Sentry");
  Sentry.init({
    dsn: '___PUBLIC_DSN___',

    // Adds request headers and IP for users, for more info visit:
    // https://docs.sentry.io/platforms/javascript/guides/cordova/configuration/options/#sendDefaultPii
    sendDefaultPii: true,
  });
}

Allow the Sentry Domain

Make sure your app can talk to Sentry by adding this to your config.xml:

<access origin="https://*.sentry.io" />

Step 3: Verify Your Setup

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

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

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

Or, try a native crash:

Sentry.nativeCrash();

View Captured Data in Sentry

To view and resolve the recorded error, log in to sentry.io and select your project. Clicking the error's title opens a page where you can view detailed information and mark it as resolved.

Next Steps

At this point, you should have integrated Sentry into your Cordova application and 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:

• Explore practical guides on what to monitor, log, track, and investigate after setup
• Continue to customize your configuration
• Learn how to upload debug symbols to make sure your native stack traces are readable
• Check our Ionic support guide
• Learn how to manually capture errors