Product
API
Sandbox
Sign In

Angular

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.

Copied
# Angular 12 and newer:
npm install --save @sentry/angular-ivy

# Angular 10 and 11:
npm install --save @sentry/angular

Angular Version Compatibility

Because of the way Angular libraries are compiled, you need to use a specific version of the Sentry SDK for each corresponding version of Angular as shown below:

Angular versionRecommended Sentry SDK
12 and newer@sentry/angular-ivy
10, 11@sentry/angular
Older versionsSee note below

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.

main.ts
Copied
import { enableProdMode } from "@angular/core";
import { platformBrowserDynamic } from "@angular/platform-browser-dynamic";
import * as Sentry from "@sentry/angular-ivy";
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
    new Sentry.BrowserTracing({
      // Set `tracePropagationTargets` to control for which URLs distributed tracing should be enabled
      tracePropagationTargets: ["localhost", /^https:\/\/yourserver\.io\/api/],
      routingInstrumentation: Sentry.routingInstrumentation,
    }),
    // Registers the Replay integration,
    // which automatically captures Session Replays
    new Sentry.Replay(),
  ],

  // Set tracesSampleRate to 1.0 to capture 100%
  // of transactions for performance monitoring.
  // We recommend adjusting this value in production
  tracesSampleRate: 1.0,

  // Capture Replay for 10% of all sessions,
  // plus for 100% of sessions with an error
  replaysSessionSampleRate: 0.1,
  replaysOnErrorSampleRate: 1.0,
});

platformBrowserDynamic()
  .bootstrapModule(AppModule)
  .then(success => console.log(`Bootstrap success`))
  .catch(err => console.error(err));

Automatically Send Errors with ErrorHandler

The Angular SDK exports a function to instantiate an ErrorHandler provider that will automatically send JavaScript errors captured by Angular's error handler.

app.module.ts
Copied
import { NgModule, ErrorHandler } from "@angular/core";
import * as Sentry from "@sentry/angular-ivy";

@NgModule({
  // ...
  providers: [
    {
      provide: ErrorHandler,
      useValue: Sentry.createErrorHandler({
        showDialog: true,
      }),
    },
  ],
  // ...
})
export class AppModule {}

You can configure the behavior of createErrorHandler. For more details see the ErrorHandlerOptions interface in our repository.

Register TraceService

For performance monitoring, register TraceService as a provider with a Router as its dependency:

app.module.ts
Copied
import { NgModule } from "@angular/core";
import { Router } from "@angular/router";
import * as Sentry from "@sentry/angular-ivy";

@NgModule({
  // ...
  providers: [
    {
      provide: Sentry.TraceService,
      deps: [Router],
    },
  ],
  // ...
})
export class AppModule {}

Then, either require the TraceService from inside AppModule or use APP_INITIALIZER to force instantiate Tracing.

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

or

app.module.ts
Copied
import { APP_INITIALIZER } from "@angular/core";
@NgModule({
  // ...
  providers: [
    {
      provide: APP_INITIALIZER,
      useFactory: () => () => {},
      deps: [Sentry.TraceService],
      multi: true,
    },
  ],
  // ...
})
export class AppModule {}

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:

app.component.html
Copied
<button (click)="throwTestError()">Test Sentry Error</button>

Then, in your app.component.ts add:

app.component.ts
Copied
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.

Add Readable Stack Traces to Errors

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

To fix this, head over to our source maps documentation where you'll learn how to upload source maps, so you can make sense of your stack traces.

Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) to suggesting an update ("yeah, this would be better").
Suggest an edit to this page   |  Contribute to Docs   |  Report a problem
Package:
npm:@sentry/angular
Version:
7.54.0
Repository:
https://github.com/getsentry/sentry-javascript