Skip to content

manual-setup.mdx

Latest commit

 

History

History
504 lines (382 loc) · 15.4 KB

manual-setup.mdx

File metadata and controls

504 lines (382 loc) · 15.4 KB
title Manual Setup
sidebar_order 1
description Learn how to set up the Sentry Angular SDK manually.
For the fastest setup, we recommend using the [wizard installer](/platforms/javascript/guides/angular).

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

You need:

  • A Sentry account and project
  • Your application up and running
  • Angular version 14.0.0 or above

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 to learn more about breaking changes.

npm install @sentry/angular --save
yarn add @sentry/angular
pnpm add @sentry/angular

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) *
10 or 11 @sentry/angular@^7 *
9 and below @sentry/angular@^6 *
AngularJS/1.x @sentry/browser@^6 with the AngularJS integration *

* 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?

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 with @sentry/angular which is now Ivy-compatible by default.

Configure

Choose the features you want to configure, and this guide will show you how:

<OnboardingOptionButtons options={[ "error-monitoring", "performance", "session-replay", "user-feedback", "logs", ]} />

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.

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)
);
import { platformBrowserDynamic } from "@angular/platform-browser-dynamic";
import { AppModule } from "./app/app.module";

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
});

platformBrowserDynamic()
  .bootstrapModule(AppModule)
  .catch((err) => console.error(err));

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.

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
  ],
};
import {
  APP_INITIALIZER,
  ApplicationConfig,
  ErrorHandler,
} 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],
    },
    {
      provide: APP_INITIALIZER,
      useFactory: () => () => {},
      deps: [Sentry.TraceService],
      multi: true,
    },
    // ___PRODUCT_OPTION_END___ performance
  ],
};
import { APP_INITIALIZER, ErrorHandler, NgModule } from "@angular/core";
import { Router } from "@angular/router";

import * as Sentry from "@sentry/angular";

@NgModule({
  // ...
  providers: [
    {
      provide: ErrorHandler,
      useValue: Sentry.createErrorHandler(),
    },
    // ___PRODUCT_OPTION_START___ performance
    {
      provide: Sentry.TraceService,
      deps: [Router],
    },
    {
      provide: APP_INITIALIZER,
      useFactory: () => () => {},
      deps: [Sentry.TraceService],
      multi: true,
    },
    // ___PRODUCT_OPTION_END___ performance
  ],
  // ...
})
export class AppModule {}

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:

@NgModule({
  // ...
})
export class AppModule {
  constructor(trace: Sentry.TraceService) {}
}

Add Readable Stack Traces With Source Maps (Optional)

Avoid Ad Blockers With Tunneling (Optional)

Verify

Let's test your setup and confirm that Sentry is working correctly and sending data to your Sentry project.

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. 
@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");
  }
}
### 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.

@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);
    });
  }
}

View Captured Data in Sentry

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

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 on what to monitor, log, track, and investigate after setup
  • 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