--- title: "Manual Setup" description: "Learn how to set up the Sentry Angular SDK manually." url: https://docs.sentry.io/platforms/javascript/guides/angular/manual-setup/ --- # Manual Setup | Sentry for Angular For the fastest setup, we recommend using the [wizard installer](https://docs.sentry.io/platforms/javascript/guides/angular.md). 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. ## [Prerequisites](https://docs.sentry.io/platforms/javascript/guides/angular/manual-setup.md#prerequisites) You need: * A Sentry [account](https://sentry.io/signup/) and [project](https://docs.sentry.io/product/projects.md) * Your application up and running * Angular version `14.0.0` or above ## [Install](https://docs.sentry.io/platforms/javascript/guides/angular/manual-setup.md#install) Run the command for your preferred package manager to add the Sentry SDK to your application. If you're updating your Sentry SDK to the latest version, check out our [migration guide](https://github.com/getsentry/sentry-javascript/blob/master/MIGRATION.md) to learn more about breaking changes. ```bash npm install @sentry/angular --save ``` Which SDK version should you use with your Angular version? In its current major version, the Sentry Angular SDK 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: | Angular version | Recommended Sentry SDK | | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | 14 and newer | `@sentry/angular` | | 12 or 13 | `@sentry/angular-ivy@^7` (see [Note](https://docs.sentry.io/platforms/javascript/guides/angular/manual-setup.md#what-is-sentryangular-ivy)) \* | | 10 or 11 | `@sentry/angular@^7` \* | | 9 and below | `@sentry/angular@^6` \* | | AngularJS/1.x | `@sentry/browser@^6` with the [AngularJS integration](https://docs.sentry.io/platforms/javascript/guides/angular/angular1.md) \* | \* 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`?](https://docs.sentry.io/platforms/javascript/guides/angular/manual-setup.md#what-is-sentryangular-ivy) The `@sentry/angular-ivy` package was 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, `@sentry/angular-ivy` was [removed and merged](https://docs.sentry.io/platforms/javascript/guides/angular/migration/v7-to-v8.md#supported-versions) with `@sentry/angular` which is now Ivy-compatible by default. ## [Configure](https://docs.sentry.io/platforms/javascript/guides/angular/manual-setup.md#configure) Choose the features you want to configure, and this guide will show you how: Error Monitoring\[ ]Tracing\[ ]Session Replay\[ ]Logs\[ ]User Feedback Want to learn more about these features? * [**Issues**](https://docs.sentry.io/product/issues.md) (always enabled) : Sentry's core error monitoring product that automatically reports errors, uncaught exceptions, and unhandled rejections. If you have something that looks like an exception, Sentry can capture it. * [**Tracing**](https://docs.sentry.io/product/tracing.md): Track software performance while seeing the impact of errors across multiple systems. For example, distributed tracing allows you to follow a request from the frontend to the backend and back. * [**Session Replay**](https://docs.sentry.io/product/explore/session-replay/web.md): Get to the root cause of an issue faster by viewing a video-like reproduction of what was happening in the user's browser before, during, and after the problem. * [**Logs**](https://docs.sentry.io/product/explore/logs.md): Centralize and analyze your application logs to correlate them with errors and performance issues. Search, filter, and visualize log data to understand what's happening in your applications. * [**User Feedback**](https://docs.sentry.io/product/user-feedback.md): Collect feedback directly from users when they encounter errors, allowing them to describe what happened and provide context that helps you understand and resolve issues faster. ### [Initialize the SDK](https://docs.sentry.io/platforms/javascript/guides/angular/manual-setup.md#initialize-the-sdk) The main configuration should happen as early as possible in your app's lifecycle. Typically that means in your `main.ts` file. `main.ts` ```typescript import { 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: "___PUBLIC_DSN___", // 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: [ // ___PRODUCT_OPTION_START___ performance // Registers and configures the Tracing integration, // which automatically instruments your application to monitor its // performance, including custom Angular routing instrumentation Sentry.browserTracingIntegration(), // ___PRODUCT_OPTION_END___ performance // ___PRODUCT_OPTION_START___ session-replay // Registers the Replay integration, // which automatically captures Session Replays Sentry.replayIntegration(), // ___PRODUCT_OPTION_END___ session-replay // ___PRODUCT_OPTION_START___ user-feedback Sentry.feedbackIntegration({ // Additional SDK configuration goes in here, for example: colorScheme: "system", }), // ___PRODUCT_OPTION_END___ user-feedback ], // ___PRODUCT_OPTION_START___ 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/], // ___PRODUCT_OPTION_END___ performance // ___PRODUCT_OPTION_START___ 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, // ___PRODUCT_OPTION_END___ session-replay // ___PRODUCT_OPTION_START___ logs // Enable logs to be sent to Sentry enableLogs: true, // ___PRODUCT_OPTION_END___ logs }); bootstrapApplication(AppComponent, appConfig).catch((err) => console.error(err), ); ``` ### [Register Sentry Providers](https://docs.sentry.io/platforms/javascript/guides/angular/manual-setup.md#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 `app.config.ts` or main `app.module.ts`: 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. `app.config.ts` ```typescript import { 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(), }, // ___PRODUCT_OPTION_START___ performance { provide: Sentry.TraceService, deps: [Router], }, provideAppInitializer(() => { inject(TraceService); }), // ___PRODUCT_OPTION_END___ performance ], }; ``` Alternative TraceService setup If you're using an NGModule-based application (`app.module.ts`), you can also dependency-inject the `TraceService` from inside your `AppModule` constructor, instead of providing `APP_INITIALIZER`: `app.module.ts` ```javascript @NgModule({ // ... }) export class AppModule { constructor(trace: Sentry.TraceService) {} } ``` ### [Add Readable Stack Traces With Source Maps (Optional)](https://docs.sentry.io/platforms/javascript/guides/angular/manual-setup.md#add-readable-stack-traces-with-source-maps-optional) The stack traces in your Sentry errors probably won't look like your actual code without unminifying them. To fix this, upload your source maps to Sentry. The easiest way to do this is by using the Sentry Wizard. Alternatively, take a look at our [Uploading Source Maps](https://docs.sentry.io/platforms/javascript/guides/angular/sourcemaps/uploading.md) documentation. ```bash npx @sentry/wizard@latest -i sourcemaps ``` ### [Avoid Ad Blockers With Tunneling (Optional)](https://docs.sentry.io/platforms/javascript/guides/angular/manual-setup.md#avoid-ad-blockers-with-tunneling-optional) You can prevent ad blockers from blocking Sentry events using tunneling. Use the `tunnel` option in `Sentry.init` to add an API endpoint in your application that forwards Sentry events to Sentry servers. This will send all events to the `tunnel` endpoint. However, the events need to be parsed and redirected to Sentry, so you'll need to do additional configuration on the server. You can find a detailed explanation on how to do this on our [Troubleshooting page](https://docs.sentry.io/platforms/javascript/guides/angular/troubleshooting.md#using-the-tunnel-option). ```javascript Sentry.init({ dsn: "___PUBLIC_DSN___", tunnel: "/tunnel", }); ``` ## [Verify](https://docs.sentry.io/platforms/javascript/guides/angular/manual-setup.md#verify) Let's test your setup and confirm that Sentry is working correctly and sending data to your Sentry project. ### [Issues](https://docs.sentry.io/platforms/javascript/guides/angular/manual-setup.md#issues) 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. 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. `app.component.ts` ```javascript @Component({ selector: "app-root", template: ` ` }) class AppComponent { // ... throwTestError(): void { throw new Error("Sentry Test Error"); } } ``` ### [Tracing](https://docs.sentry.io/platforms/javascript/guides/angular/manual-setup.md#tracing) To test your tracing configuration, update the previous code snippet to start a trace to measure the time it takes to execute your code. Open the page in a browser and click the button to trigger a frontend error and performance trace. `app.component.ts` ```javascript @Component({ selector: "app-root", template: ` ` }) class AppComponent { // ... throwTestError(): void { Sentry.startSpan({ op: "test", name: "Example Span" }, () => { setTimeout(() => { throw new Error("Sentry Test Error"); }, 99); }); } } ``` ### [Logs NEW](https://docs.sentry.io/platforms/javascript/guides/angular/manual-setup.md#logs-) To verify that Sentry catches your logs, add some log statements to your application: ```javascript Sentry.logger.info("User example action completed"); Sentry.logger.warn("Slow operation detected", { operation: "data_fetch", duration: 3500, }); Sentry.logger.error("Validation failed", { field: "email", reason: "Invalid email", }); ``` ### [View Captured Data in Sentry](https://docs.sentry.io/platforms/javascript/guides/angular/manual-setup.md#view-captured-data-in-sentry) Now, head over to your project on [Sentry.io](https://sentry.io/) to view the collected data (it takes a couple of moments for the data to appear). Need help locating the captured errors in your Sentry project? * Open the [**Issues**](https://sentry.io/orgredirect/organizations/:orgslug/issues/) page and select an error from the issues list to view the full details and context of this error. For more details, see this [interactive walkthrough](https://docs.sentry.io/product/sentry-basics/integrate-frontend/generate-first-error.md#ui-walkthrough). * Open the [**Traces**](https://sentry.io/orgredirect/organizations/:orgslug/explore/traces/) page and select a trace to reveal more information about each span, its duration, and any errors. For an interactive UI walkthrough, click [here](https://docs.sentry.io/product/sentry-basics/distributed-tracing/generate-first-error.md#ui-walkthrough). * Open the [**Replays**](https://sentry.io/orgredirect/organizations/:orgslug/replays/) page and select an entry from the list to get a detailed view where you can replay the interaction and get more information to help you troubleshoot. * Open the [**Logs**](https://sentry.io/orgredirect/organizations/:orgslug/explore/logs/) page and filter by service, environment, or search keywords to view log entries from your application. For an interactive UI walkthrough, click [here](https://docs.sentry.io/product/explore/logs.md#overview). * Open the [**User Feedback**](https://sentry.io/orgredirect/organizations/:orgslug/feedback/) page and click on individual feedback to see more details all in one view. For more information, click [here](https://docs.sentry.io/product/user-feedback.md). ## [Next Steps](https://docs.sentry.io/platforms/javascript/guides/angular/manual-setup.md#next-steps) 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: * Explore [practical guides](https://docs.sentry.io/guides.md) on what to monitor, log, track, and investigate after setup * Extend Sentry to your backend using one of our [SDKs](https://docs.sentry.io/.md) * Continue to [customize your configuration](https://docs.sentry.io/platforms/javascript/guides/angular/configuration.md) * Make use of [Angular-specific features](https://docs.sentry.io/platforms/javascript/guides/angular/features.md) * Learn how to [manually capture errors](https://docs.sentry.io/platforms/javascript/guides/angular/usage.md) Are you having problems setting up the SDK? * If you encountered issues with setting up Sentry manually, [try our installation wizard](https://docs.sentry.io/platforms/javascript/guides/angular.md) * Find various topics in [Troubleshooting](https://docs.sentry.io/platforms/javascript/guides/angular/troubleshooting.md) * [Get support](https://sentry.zendesk.com/hc/en-us/)