Demo
Đăng nhập

Capacitor

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 the Sentry Capacitor SDK alongside the corresponding Sentry SDK for the framework you're using, such as Angular in this example:

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

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

Android Specifics

Add the plugin declaration to your MainActivity.java file

MainActivity.java
Copied
import 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);
    }});
  }
}

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
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>"
  },
  // Forward the init method from @sentry/angular
  SentryAngular.init
);

@NgModule({
  providers: [
    {
      provide: ErrorHandler,
      // Attach the Sentry ErrorHandler
      useValue: SentryAngular.createErrorHandler(),
    },
  ],
})

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

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.

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

Learn more about uploading source maps.

Verify

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

Copied
import * as Sentry from "@sentry/capacitor";

Sentry.captureException("Test Captured Exception");

You can also throw an error anywhere in your application:

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

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.

Package:
npm:@sentry/capacitor
Version:
0.18.0
Repository:
https://github.com/getsentry/sentry-capacitor