Ionic

Learn how to use Sentry with Ionic.

Sentry Capacitor supports Ionic out of the box. The documentation below is similar to our Capacitor Getting Started documentation since the setup of Capacitor and Ionic are the same.

Install the Sentry Capacitor SDK alongside the corresponding Sentry SDK for the framework you're using:

Copied
# npm
npm install @sentry/capacitor @sentry/angular --save

# yarn
yarn add @sentry/capacitor @sentry/angular

# pnpm
pnpm add @sentry/capacitor @sentry/angular

In its current beta version, the Sentry Capacitor SDK only supports Angular 14 and newer.

If you're using an older version of Angular, you also need to use an older version of the SDK. See the table below for compatibility guidance:

Angular versionRecommended Sentry SDK
14 and newer@sentry/capacitor @sentry/angular
12 or 13@sentry/capacitor^0 @sentry/angular-ivy@^7 *
10 or 11@sentry/capacitor^0 @sentry/angular@^7 *

* These versions of the SDK are no longer maintained or tested. Version 0 might still receive bug fixes but we don't guarantee support.

Both Frameworks are fully compatible with the current and beta versions of Sentry Capacitor.

Then forward the init method from the sibling Sentry SDK for the framework you use, such as Angular in this example:

app.module.ts
Copied
import * as Sentry from "@sentry/capacitor";
import * as SentryAngular from "@sentry/angular";

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

    // Set your release version, such as "getsentry@1.0.0"
    release: "my-project-name@<release-name>",
    // Set your dist version, such as "1"
    dist: "<dist>",
    integrations: [
      // Registers and configures the Tracing integration,
      // which automatically instruments your application to monitor its
      // performance, including custom Angular routing instrumentation
      Sentry.browserTracingIntegration(),
      // Registers the Replay integration,
      // which automatically captures Session Replays
      Sentry.replayIntegration(),
    ],

    // Set tracesSampleRate to 1.0 to capture 100%
    // of transactions for tracing.
    // We recommend adjusting this value in production
    tracesSampleRate: 1.0,

    // Set `tracePropagationTargets` to control for which URLs distributed tracing should be enabled
    tracePropagationTargets: ["localhost", /^https:\/\/yourserver\.io\/api/],

    // Capture Replay for 10% of all sessions,
    // plus for 100% of sessions with an error
    replaysSessionSampleRate: 0.1,
    replaysOnErrorSampleRate: 1.0,
  },
  // Forward the init method from @sentry/angular
  SentryAngular.init
);

@NgModule({
  providers: [
    {
      provide: ErrorHandler,
      // Attach the Sentry ErrorHandler
      useValue: SentryAngular.createErrorHandler(),
    },
    {
      provide: SentryAngular.TraceService,
      deps: [Router],
    },
    {
      provide: APP_INITIALIZER,
      useFactory: () => () => {},
      deps: [SentryAngular.TraceService],
      multi: true,
    },
  ],
})

You can also use the features available with the Sentry SDK for the framework you use, such as Angular.

You will need to upload source maps to make sense of the events you receive in Sentry.

For example, if you are using Capacitor with Ionic-Angular, upload your www folder on every build you release. The values for <release_name> and <dist> must match the values passed into Sentry.init for events to be deminified correctly.

Copied
sentry-cli sourcemaps upload --release <release_name>  --dist <dist> ./www

Learn more about uploading source maps.

To make stack-trace information for native crashes on iOS easier to understand, you need to provide debug information to Sentry. Debug information is provided by uploading dSYM files.

Previous
Uploading Debug Symbols (iOS)
Next
Set Up Tracing
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").