Angular

Learn how to set up Sentry in your Angular application and capture your first errors.

You need:

  • A Sentry account and project
  • Your application up and running
  • Angular version 17.0.0 or above
Are you using Angular 16 or older?

If you're using Angular 16 or older, install and Set Up the SDK Manually. The Sentry Angular SDK still works for Angular versions 14 and newer but the installation wizards requires at least Angular 17.

To install Sentry, run the following command within your project:

Copied
npx @sentry/wizard@latest -i angular

The wizard then guides you through the setup process, asking you to enable additional (optional) Sentry features for your application beyond error monitoring.

Want to learn more about these features?
  • Issues (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: 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: 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.

This guide assumes that you enable all features and allow the wizard to add an example component to your application. You can add or remove features at any time, but setting them up now will save you the effort of configuring them manually later.

What does the installation wizard change inside your application?
  • Adds a Sentry.init() call into your main.ts file
  • Registers the Sentry ErrorHandler and TraceService in your app.config.ts file
  • Creates .sentryclirc with an auth token to upload source maps (this file is automatically added to .gitignore)
  • Walks you through enabling source maps upload when making a production build, locally as well as in CI
  • Adds an example component to your application to help verify your Sentry setup

You can prevent ad blockers from blocking Sentry events using tunneling. Use the tunnel option to add an API endpoint in your application that forwards Sentry events to Sentry servers.

To enable tunneling, update Sentry.init with the following option:

Copied
Sentry.init({
  dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",,

  tunnel: "/tunnel",

});

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.

If you haven't tested your Sentry configuration yet, let's do it now. You can confirm that the Sentry SDK is sending data to your Sentry project by using the example component created by the installation wizard:

  1. Open the page you added the example component to in your browser.
  2. Click the "Throw error" button. This triggers an error.

Sentry captures this error for you. Additionally, the button click starts a trace to measure the time it takes for the error to be thrown.

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).

Need help locating the captured errors in your Sentry project?
  1. Open the Issues page and select an error from the issues list to view the full details and context of this error. For an interactive UI walkthrough, click here.
  2. Open the 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.
  3. Open the 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.

At this point, you should have integrated Sentry into Angular application and should already be sending error and tracing 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:

Are you having problems setting up the SDK?
Previous
Welcome to Sentry
Next
Manual Setup
Was this helpful?
Help improve this content
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").