Manual Setup
Learn how to set up the Sentry Angular SDK manually.
For the fastest setup, we recommend using the wizard installer.
If you can't (or prefer not to) use the installation wizard, follow the instructions below to configure the Sentry Angular SDK in your application. This guide is also useful to adjust the pre-set configuration if you used the installation wizard for automatic setup.
You need:
Choose the features you want to configure, and this guide will show you how:
npm install @sentry/angular --save
If you're updating your Sentry SDK to the latest version, check out our migration guide to learn more about breaking changes.
The main configuration should happen as early as possible in your app's lifecycle. Typically that means in your main.ts file. In addition, you'll need to register some providers to fully instrument your application.
main.tsimport { bootstrapApplication } from "@angular/platform-browser";
import { appConfig } from "./app/app.config";
import { AppComponent } from "./app/app.component";
import * as Sentry from "@sentry/angular";
Sentry.init({
dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
// Adds request headers and IP for users, for more info visit:
// https://docs.sentry.io/platforms/javascript/guides/angular/configuration/options/#sendDefaultPii
sendDefaultPii: true,
integrations: [
// performance
// Registers and configures the Tracing integration,
// which automatically instruments your application to monitor its
// performance, including custom Angular routing instrumentation
Sentry.browserTracingIntegration(),
// performance
// session-replay
// Registers the Replay integration,
// which automatically captures Session Replays
Sentry.replayIntegration(),
// session-replay
],
// performance
// Set tracesSampleRate to 1.0 to capture 100%
// of transactions for tracing.
// We recommend adjusting this value in production
// Learn more at
// https://docs.sentry.io/platforms/javascript/configuration/options/#traces-sample-rate
tracesSampleRate: 1.0,
// Set `tracePropagationTargets` to control for which URLs trace propagation should be enabled
tracePropagationTargets: ["localhost", /^https:\/\/yourserver\.io\/api/],
// performance
// session-replay
// Capture Replay for 10% of all sessions,
// plus for 100% of sessions with an error
// Learn more at
// https://docs.sentry.io/platforms/javascript/session-replay/configuration/#general-integration-configuration
replaysSessionSampleRate: 0.1,
replaysOnErrorSampleRate: 1.0,
// session-replay
});
bootstrapApplication(AppComponent, appConfig).catch((err) =>
console.error(err),
);
The Sentry Angular SDK exports a couple of Angular providers that are necessary to fully instrument your application. We recommend registering them in your app.config.ts or main app.module.ts:
app.config.tsimport {
ApplicationConfig,
ErrorHandler,
inject,
provideAppInitializer,
} from "@angular/core";
import { Router } from "@angular/router";
import * as Sentry from "@sentry/angular";
export const appConfig: ApplicationConfig = {
providers: [
// ...
{
provide: ErrorHandler,
useValue: Sentry.createErrorHandler(),
},
// performance
{
provide: Sentry.TraceService,
deps: [Router],
},
provideAppInitializer(() => {
inject(TraceService);
}),
// performance
],
};
If your Angular app is configured for SSR, make sure that the Sentry providers are not accidentally passed to the SSR config (app.config.server.ts). The Sentry Angular SDK can only be used in the browser.
The stack traces in your Sentry errors probably won't look like your actual code. To fix this, upload your source maps to Sentry. The easiest way to do this is by using the Sentry Wizard:
npx @sentry/wizard@latest -i sourcemaps
Alternatively, take a look at our Uploading Source Maps docs
Let's test your setup and confirm that Sentry is working correctly and sending data to your Sentry project.
To verify that Sentry captures errors and creates issues in your Sentry project, add the following test button to one of your components (e.g. app.component.ts), which will trigger an error that Sentry will capture when you click it:
app.component.ts@Component({
selector: "app-root",
template: `
<!-- rest of your page -->
<button (click)="throwTestError()">Test Sentry Error</button>`
})
class AppComponent {
// ...
throwTestError(): void {
throw new Error("Sentry Test Error");
}
}
Open the page in a browser and click the button to trigger a frontend error.
Important
Errors triggered from within your browser's developer tools (like the browser console) are sandboxed, so they will not trigger Sentry's error monitoring.
To test your tracing configuration, update the previous code snippet to start a trace to measure the time it takes to execute your code:
app.component.ts@Component({
selector: "app-root",
template: `
<!-- rest of your page -->
<button (click)="throwTestError()">Test Sentry Error</button>`
})
class AppComponent {
// ...
throwTestError(): void {
Sentry.startSpan({ op: "test", name: "Example Span" }, () => {
setTimeout(() => {
throw new Error("Sentry Test Error");
}, 99);
});
}
}
Open the page in a browser and click the button to trigger a frontend error and performance trace.
Now, head over to your project on Sentry.io to view the collected data (it takes a couple of moments for the data to appear).
At this point, you should have integrated Sentry into your Angular application and should already be sending data to your Sentry project.
Now's a good time to customize your setup and look into more advanced topics. Our next recommended steps for you are:
- Extend Sentry to your backend using one of our SDKs
- Continue to customize your configuration
- Make use of Angular-specific features
- Learn how to manually capture errors
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").