Capacitor
Learn how to set up Sentry in your Capacitor application, capture your first errors and traces, and view them in Sentry.
You need:
This guide will show you setup instructions for Angular, React, Vue, and Nuxt. If you use any other JavaScript framework (or none at all) with Capacitor, follow the vanilla instructions outlined under "Other".
Run the command for your preferred package manager to add Sentry's Capacitor SDK and the SDK for the framework you're using to your application:
# npm
npm install @sentry/capacitor @sentry/angular --save
# yarn
yarn add @sentry/capacitor @sentry/angular
# pnpm
pnpm add @sentry/capacitor @sentry/angular
Choose the features you want to configure, and this guide will show you how:
Initialize Sentry as early as possible in your application's lifecycle.
If you're using Angular, React, Vue, or Nuxt, make sure to forward the init method from the framework's Sentry SDK, as you can see in these code snippets. If you're following the vanilla setup, you don't need to do this.
app.module.tsimport * as Sentry from "@sentry/capacitor";
import * as SentryAngular from "@sentry/angular";
Sentry.init(
{
dsn: "___PUBLIC_DSN___",
// Adds request headers and IP for users, for more info visit:
// https://docs.sentry.io/platforms/javascript/guides/capacitor/configuration/options/#sendDefaultPii
sendDefaultPii: true,
// 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>",
// ___PRODUCT_OPTION_START___ logs
// Logs requires @sentry/capacitor 2.0.0 or newer.
enableLogs: true,
// ___PRODUCT_OPTION_END___ logs
// ___PRODUCT_OPTION_START___ performance
// Registers and configures the Tracing integration,
// which automatically instruments your application to monitor its
// performance, including custom Angular routing instrumentation
Sentry.browserTracingIntegration(),
// ___PRODUCT_OPTION_END___ performance
// ___PRODUCT_OPTION_START___ session-replay
// Registers the Replay integration,
// which automatically captures Session Replays
Sentry.replayIntegration(),
// ___PRODUCT_OPTION_END___ session-replay
// ___PRODUCT_OPTION_START___ user-feedback
Sentry.feedbackIntegration({
// Additional SDK configuration goes in here, for example:
colorScheme: "system",
}),
// ___PRODUCT_OPTION_END___ user-feedback
// ___PRODUCT_OPTION_START___ performance
// Set tracesSampleRate to 1.0 to capture 100%
// of transactions for tracing.
// We recommend adjusting this value in production
// Learn more at
// https://docs.sentry.io/platforms/javascript/configuration/options/#traces-sample-rate
tracesSampleRate: 1.0,
// Set `tracePropagationTargets` to control for which URLs distributed tracing should be enabled
tracePropagationTargets: ["localhost", /^https:\/\/yourserver\.io\/api/],
// ___PRODUCT_OPTION_END___ performance
// ___PRODUCT_OPTION_START___ session-replay
// Capture Replay for 10% of all sessions,
// plus for 100% of sessions with an error
// Learn more at
// https://docs.sentry.io/platforms/javascript/session-replay/configuration/#general-integration-configuration
replaysSessionSampleRate: 0.1,
replaysOnErrorSampleRate: 1.0,
// ___PRODUCT_OPTION_END___ session-replay
},
// Forward the init method from @sentry/angular
SentryAngular.init
);
@NgModule({
providers: [
{
provide: ErrorHandler,
// Attach the Sentry ErrorHandler
useValue: SentryAngular.createErrorHandler(),
},
// ___PRODUCT_OPTION_START___ performance
{
provide: SentryAngular.TraceService,
deps: [Router],
},
{
provide: APP_INITIALIZER,
useFactory: () => () => {},
deps: [SentryAngular.TraceService],
multi: true,
},
// ___PRODUCT_OPTION_END___ performance
],
})
The stack traces in your Sentry errors probably won't look like your actual code without unminifying them. To fix this, upload your source maps to Sentry. The easiest way to do this is by using the Sentry Wizard:
npx @sentry/wizard@latest -i sourcemaps
You need to provide debug information to Sentry to make the stack-trace information for native crashes on iOS easier to understand. You can provide debug information by uploading dSYM files.
Let's test your setup and confirm that Sentry is working correctly and sending data to your Sentry project.
To verify that Sentry captures errors and creates issues in your Sentry project, add the following test button and logic:
@Component({
selector: "app-root",
template: `
<!-- rest of your page -->
<button (click)="throwError()">Test Sentry Error</button>`
})
class AppComponent {
// ...
throwError(): void {
throw new Error("Sentry Test Error");
}
}
Open the page in a browser and click the button to trigger a frontend error.
Important
Errors triggered from within your browser's developer tools (like the browser console) are sandboxed, so they will not trigger Sentry's error monitoring.
To test your tracing configuration, update the previous code snippet and wrap the error in a custom span:
import * as Sentry from "@sentry/capacitor";
@Component({
selector: "app-root",
template: `
<!-- rest of your page -->
<button (click)="throwError()">Test Sentry Error</button>`
})
class AppComponent {
// ...
throwError(): void {
Sentry.startSpan({ op: "test", name: "Example Frontend Span" }, () => {
throw new Error("Sentry Test Error");
});
}
}
Open the page in a browser and click the button to trigger a frontend error and trace.
Now, head over to your project on Sentry.io to view the collected data (it takes a couple of moments for the data to appear).
At this point, you should have integrated Sentry into your Capacitor 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
- Learn how to use Sentry with Ionic
- Continue to customize your configuration
- Learn how to manually capture errors
- Make use of framework-specific features, such as Angular, Vue, React, or Nuxt
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").