Product
API
Sandbox
Sign In

Cordova

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:

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.

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.

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.

Configure

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" />

Debug Information

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.

Script to Submit to App Store Connect

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.

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.

Add Readable Stack Traces to Errors

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

To fix this, head over to our source maps documentation where you'll learn how to upload source maps, so you can make sense of your stack traces.

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").
Suggest an edit to this page   |  Contribute to Docs   |  Report a problem
Package:
npm:sentry-cordova
Version:
0.12.3
Repository:
https://github.com/getsentry/sentry-cordova