Angular
Sentry's SDKs enable automatic reporting of errors and exceptions.
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.
npm install --save @sentry/angular @sentry/tracing
Angular Version Compatibility
The latest version of the Sentry Angular SDK officially supports Angular 10 and newer.
If you need to use Angular 9 or older and you experience problems with the latest version of the Sentry SDK,
try downgrading the SDK to version 6 (@sentry/angular@^6.x
). If you are using Sentry Tracing,
be sure to also downgrade it to the same version (@sentry/tracing@^6.x
).
Version 6 of the Sentry SDK was compiled differently and might work with older versions of Angular.
Please note that this combination of packages is not being maintained or tested.
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 { BrowserTracing } from "@sentry/tracing";
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 BrowserTracing({
tracePropagationTargets: ["localhost", "https://yourserver.io/api"],
routingInstrumentation: Sentry.routingInstrumentation,
}),
],
// Set tracesSampleRate to 1.0 to capture 100%
// of transactions for performance monitoring.
// We recommend adjusting this value in production
tracesSampleRate: 1.0,
});
platformBrowserDynamic()
.bootstrapModule(AppModule)
.then(success => console.log(`Bootstrap success`))
.catch(err => console.error(err));
You can also configure @sentry/angular
to catch any Angular-specific exceptions reported through the @angular/core/ErrorHandler provider.
@sentry/angular
exports a Trace Service, Directive, and Decorators that leverages the @sentry/tracing
, Sentry's Tracing integration, to add Angular-related spans to transactions. The service itself tracks route changes and durations, where directive and decorators are tracking component initializations.
Automatically Send Errors with ErrorHandler
@sentry/angular
exports a function to instantiate an ErrorHandler
provider that will automatically send JavaScript errors captured by the Angular's error handler.
import { NgModule, ErrorHandler } from "@angular/core";
import * as Sentry from "@sentry/angular";
@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
In Angular's DI system, register TraceService
as a provider with a Router
as its dependency:
import { NgModule } from "@angular/core";
import { Router } from "@angular/router";
import * as Sentry from "@sentry/angular";
@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.
@NgModule({
// ...
})
export class AppModule {
constructor(trace: Sentry.TraceService) {}
}
or
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:
myUndefinedFunction();
Errors triggered from within Browser DevTools are sandboxed, so will not 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.
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.
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").
- Package:
- npm:@sentry/angular
- Version:
- 7.34.0
- Repository:
- https://github.com/getsentry/sentry-javascript