Angular

If you're seeing deprecation warnings in your code, please note that we're currently working on version 8 of the JavaScript SDKs. In v8, some methods and properties will be removed or renamed. Check out the Migration docs and learn how to update your code to be compatible with v8.

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.

npm install --save @sentry/angular

Angular Version Compatibility

In its current major version, the Sentry Angular 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:

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

What is @sentry/angular-ivy?

The @sentry/angular-ivy package is an Ivy-compatible version of @sentry/angular in version 7 of the SDK. It's recommended to use this package if you're using Angular 12 or 13 to avoid build-time warnings. Functionality-wise, it's identical to @sentry/angular and you can simply replace all imports of @sentry/angular with @sentry/angular-ivy in our docs. Since version 8, the @sentry/angular-ivy was removed and merged with @sentry/angular which is now Ivy-compatible by default.

Configure

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

Once this is done, Sentry's Angular SDK captures all unhandled exceptions and transactions.

import { enableProdMode } from "@angular/core";
import { platformBrowserDynamic } from "@angular/platform-browser-dynamic";
import * as Sentry from "@sentry/angular";
import { AppModule } from "./app/app.module";

Sentry.init({
  dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
  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 performance monitoring.
  // 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,
});

platformBrowserDynamic()
  .bootstrapModule(AppModule)
  .catch((err) => console.error(err));

Register Sentry Providers

The Sentry Angular SDK exports a couple of Angular providers that are necessary to fully instrument your application. We recommend registering them in your main AppModule:

import { APP_INITIALIZER, ErrorHandler, NgModule } from "@angular/core";
import { Router } from "@angular/router";

import * as Sentry from "@sentry/angular";

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

The Sentry.createErrorHandler function initializes a Sentry-specific ErrorHandler that automatically sends errors caught by Angular to Sentry. You can also customize the behavior by setting a couple of handler options.

The Sentry.TraceService listens to the Angular router for performance monitoring and tracing. To inject TraceService, register the APP_INITIALIZER provider as shown above. Alternatively, you can also require the TraceService from inside your AppModule constructor:

@NgModule({
  // ...
})
export class AppModule {
  constructor(trace: Sentry.TraceService) {}
}

Add Readable Stack Traces to Errors

Depending on how you've set up your project, the stack traces in your Sentry errors probably don't look like your actual code.

To fix this, upload your source maps to Sentry. The easiest way to do this is to use the Sentry Wizard:

npx @sentry/wizard@latest -i sourcemaps

The wizard will guide you through the following steps:

• Logging into Sentry and selecting a project
• Installing the necessary Sentry packages
• Configuring your build tool to generate and upload source maps
• Configuring your CI to upload source maps

For more information on source maps or for more options to upload them, head over to our Source Maps documentation.

Verify

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

Trigger a test error somewhere in your Angular app, for example in your main app component:

<button (click)="throwTestError()">Test Sentry Error</button>

Then, in your app.component.ts add:

public throwTestError(): void {
  throw new Error("Sentry Test 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.