# Capacitor | Sentry for Capacitor

## [Features](https://docs.sentry.io/platforms/javascript/guides/capacitor.md#features)

In addition to capturing errors, you can monitor interactions between multiple services or applications by [enabling tracing](https://docs.sentry.io/concepts/key-terms/tracing.md). You can also get to the root of an error or performance issue faster, by watching a video-like reproduction of a user session with [session replay](https://docs.sentry.io/product/explore/session-replay/web/getting-started.md).

Select which Sentry features you'd like to install in addition to Error Monitoring to get the corresponding installation and configuration instructions below.

## [Install](https://docs.sentry.io/platforms/javascript/guides/capacitor.md#install)

Error Monitoring\[ ]Tracing\[ ]Session Replay\[ ]User Feedback\[ ]Logs (Beta)

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

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

```bash
# npm
npm install @sentry/capacitor @sentry/angular --save

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

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

### [Angular Version Compatibility](https://docs.sentry.io/platforms/javascript/guides/capacitor.md#angular-version-compatibility)

Currently, 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 version | Recommended 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.

### [React and Vue Version Compatibility](https://docs.sentry.io/platforms/javascript/guides/capacitor.md#react-and-vue-version-compatibility)

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

## [Configure](https://docs.sentry.io/platforms/javascript/guides/capacitor.md#configure)

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

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

`app.module.ts`

```typescript
import * as Sentry from "@sentry/capacitor";
import * as SentryAngular from "@sentry/angular";

Sentry.init(
  {
    dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
    
    // 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>",
    integrations: [
      //  performance
      // Registers and configures the Tracing integration,
      // which automatically instruments your application to monitor its
      // performance, including custom Angular routing instrumentation
      Sentry.browserTracingIntegration(),
      //  performance
      //  session-replay
      // Registers the Replay integration,
      // which automatically captures Session Replays
      Sentry.replayIntegration(),
      //  session-replay
      //  user-feedback
      Sentry.feedbackIntegration({
        // Additional SDK configuration goes in here, for example:
        colorScheme: "system",
      }),
      //  user-feedback
    ],
    //  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/],
    //  performance
    //  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,
    //  session-replay
  },
  // Forward the init method from @sentry/angular
  SentryAngular.init
);

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

You can also use the features available with the Sentry SDK for the framework you use, such as [Angular](https://docs.sentry.io/platforms/javascript/guides/angular.md).

### [Source Maps](https://docs.sentry.io/platforms/javascript/guides/capacitor.md#source-maps)

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.

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

Learn more about uploading [source maps](https://docs.sentry.io/platforms/javascript/guides/capacitor/sourcemaps.md).

### [Provide Native Debug Information (iOS)](https://docs.sentry.io/platforms/javascript/guides/capacitor.md#provide-native-debug-information-ios)

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](https://docs.sentry.io/platforms/javascript/guides/capacitor/dsym.md).

## [Verify](https://docs.sentry.io/platforms/javascript/guides/capacitor.md#verify)

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

```javascript
import * as Sentry from "@sentry/capacitor";

Sentry.captureException("Test Captured Exception");
```

You can also throw an error anywhere in your application:

```javascript
throw new Error(`Test Thrown Error`);
```

Learn more about manually capturing an error or message in our [Usage documentation](https://docs.sentry.io/platforms/javascript/guides/capacitor/usage.md).

To view and resolve the recorded error, log into [sentry.io](https://sentry.io) and select your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.
