CapacitorIonic
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, such as Angular in this example:
# npm
npm install --save @sentry/capacitor @sentry/angular-ivy
# yarn
yarn add @sentry/capacitor @sentry/angular-ivy
This step is not needed if you are using Capacitor 3
Add the plugin declaration to your MainActivity.java file
MainActivity.javaimport android.os.Bundle;
import com.getcapacitor.BridgeActivity;
import com.getcapacitor.Plugin;
import io.sentry.capacitor.SentryCapacitor;
import java.util.ArrayList;
public class MainActivity extends BridgeActivity {
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// Initializes the Bridge
this.init(savedInstanceState, new ArrayList<Class<? extends Plugin>>() {{
add(SentryCapacitor.class);
}});
}
}
Then forward the init method from the sibling Sentry SDK for the framework you use, such as Angular in this example:
app.module.tsimport * as Sentry from "@sentry/capacitor";
// Use @sentry/angular-ivy for Angular 12+ or `@sentry/angular` from Angular 10 and 11
import * as SentryAngular from "@sentry/angular-ivy";
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
SentryAngular.browserTracingIntegration({
tracePropagationTargets: ["localhost", "https://yourserver.io/api"],
}),
],
// Set tracesSampleRate to 1.0 to capture 100%
// of transactions for performance monitoring.
// We recommend adjusting this value in production
tracesSampleRate: 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.
sentry-cli releases files <release_name> upload-sourcemaps ./www --dist <dist>
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.
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").
