AngularAngular
Sentry's SDKs enable automatic reporting of errors and exceptions.
On this page, we get you up and running with Sentry's SDK.
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.
Sentry captures data by using an SDK within your application’s runtime.
# Angular 12 and newer:
npm install --save @sentry/angular-ivy
# Angular 10 and 11:
npm install --save @sentry/angular
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 version | Recommended Sentry SDK |
|---|---|
| 12 and newer | @sentry/angular-ivy |
| 10, 11 | @sentry/angular |
| Older versions | See note below |
Support for any Angular version below 10 was discontinued in version 7 of the SDK. If you need to use Angular 9 or older, try version 6 (@sentry/angular@^6.x) of the SDK. For AngularJS/1.x, use @sentry/browser@^6.x and our AngularJS integration. Note, that these versions of the SDK are no longer maintained or tested.
If you are using Angular 16 or newer, @sentry/angular will no longer work as it doesn't support Angular's rendering engine Ivy natively. Please use @sentry/angular-ivy instead.
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.tsimport { 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
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)
.then(success => console.log(`Bootstrap success`))
.catch(err => console.error(err));
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.tsimport { 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.
For performance monitoring, register TraceService as a provider with a Router as its dependency:
app.module.tsimport { 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@NgModule({
// ...
})
export class AppModule {
constructor(trace: Sentry.TraceService) {}
}
or
app.module.tsimport { APP_INITIALIZER } from "@angular/core";
@NgModule({
// ...
providers: [
{
provide: APP_INITIALIZER,
useFactory: () => () => {},
deps: [Sentry.TraceService],
multi: true,
},
],
// ...
})
export class AppModule {}
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.
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<button (click)="throwTestError()">Test Sentry Error</button>
Then, in your app.component.ts add:
app.component.tspublic throwTestError(): void {
throw new Error("Sentry Test Error");
}
Errors triggered from within Browser DevTools are sandboxed and won't trigger an error handler. Place the snippet directly in your code instead.
Learn more about manually capturing an error or message in our Usage documentation.
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.
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").
