Cordova

Sentry's Cordova SDK enables automatic reporting of errors, messages, and exceptions, and identifies performance issues in your application. The SDK is available on GitHub sentry-cordova.

The Cordova SDK uses a native extension for iOS and Android, but will fall back to a pure JavaScript version (@sentry/browser) if needed. When you install sentry-cordova, the Sentry Wizard will help configure your project. We also add a build step to your Xcode project to upload debug symbols we need to symbolicate iOS crashes.

Features:

  • Automatic Native crash error tracking using both iOS and Android supports
  • Offline storage of events
    • Android: Offline caching when a device is offline; we send a report once the application is restarted
    • iOS: Offline caching when a device is unable to connect; we send a report once we receive another event
  • Events enriched with device data
  • Breadcrumbs created for location changes, outgoing HTTP requests with XHR and Fetch, console logs, and HTML touch events
  • On-device symbolication for JavaScript (in Debug mode)
  • Ionic support
  • Under the hood the SDK relies on our JavaScript SDK, which makes all functions available for JavaScript also available in this SDK including:

We have recently released v8 of the JavaScript SDKs. If you're using version 7.x, we recommend upgrading to the latest version. Check out the Migration docs to learn how to update your code to be compatible with v8.

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

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

Install our SDK using the cordova command:

Copied
cordova plugin add sentry-cordova

The Sentry Wizard will patch your project. You need to do this only once, then the created files can go into your version control system.

When you use Xcode, you can hook directly into the build process to upload debug symbols and source maps.

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

You should init the SDK in the deviceReady function, to make sure the native integrations runs.

Copied
onDeviceReady: function() {
  var Sentry = cordova.require("sentry-cordova.Sentry");
  Sentry.init({ dsn: 'https://examplePublicKey@o0.ingest.sentry.io/0' });
}

You will also need to allow Sentry's domain in your config.xml:

config.xml
Copied
<access origin="sentry.io" />

If you want to run the debug information (also known as debug symbols) upload when building your app, you can use the scripts provided in Debug Information.

If you are experiencing errors and want to remove unused architectures from your binary when submitting the build to iTunes Connect, you can use the scripts provided in Troubleshooting.

Depending on how you've set up your project, the stack traces in your Sentry errors probably don't look like your actual code.

To fix this, upload your source maps to Sentry. The easiest way to do this is to use the Sentry Wizard:

Copied
npx @sentry/wizard@latest -i sourcemaps

The wizard will guide you through the following steps:

  • Logging into Sentry and selecting a project
  • Installing the necessary Sentry packages
  • Configuring your build tool to generate and upload source maps
  • Configuring your CI to upload source maps

For more information on source maps or for more options to upload them, head over to our Source Maps documentation.

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();

Learn more about manually capturing an error or message in our Usage documentation.

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!) or suggesting an update ("yeah, this would be better").