|
| 1 | +<p align="center"> |
| 2 | + <a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank"> |
| 3 | + <img src="https://sentry-brand.storage.googleapis.com/sentry-wordmark-dark-280x84.png" alt="Sentry" width="280" height="84"> |
| 4 | + </a> |
| 5 | +</p> |
| 6 | + |
| 7 | +# Official Sentry SDK for Angular with Ivy Compatibility |
| 8 | + |
| 9 | +## Links |
| 10 | + |
| 11 | +- [Official SDK Docs](https://docs.sentry.io/platforms/javascript/angular/) |
| 12 | +- [TypeDoc](http://getsentry.github.io/sentry-javascript/) |
| 13 | + |
| 14 | +## Angular Version Compatibility |
| 15 | + |
| 16 | +The latest version of this SDK officially supports Angular 12-15 with Ivy. |
| 17 | + |
| 18 | +If you're using Angular 10, 11 or a newer Angular version with View Engine instead of Ivy, please use [`@sentry/angular`](https://github.com/getsentry/sentry-javascript/blob/develop/packages/angular/README.md). |
| 19 | + |
| 20 | +If you're using an older version of Angular and experience problems with the Angular SDK, we recommend downgrading the SDK to version 6.x. |
| 21 | +Please note that we don't provide any support for Angular versions below 10. |
| 22 | + |
| 23 | +## General |
| 24 | + |
| 25 | +This package is a wrapper around `@sentry/browser`, with added functionality related to Angular. All methods available |
| 26 | +in `@sentry/browser` can be imported from `@sentry/angular-ivy`. |
| 27 | + |
| 28 | +To use this SDK, call `Sentry.init(options)` before you bootstrap your Angular application. |
| 29 | + |
| 30 | +```javascript |
| 31 | +import { enableProdMode } from '@angular/core'; |
| 32 | +import { platformBrowserDynamic } from '@angular/platform-browser-dynamic'; |
| 33 | +import { init } from '@sentry/angular-ivy'; |
| 34 | + |
| 35 | +import { AppModule } from './app/app.module'; |
| 36 | + |
| 37 | +init({ |
| 38 | + dsn: '__DSN__', |
| 39 | + // ... |
| 40 | +}); |
| 41 | + |
| 42 | +// ... |
| 43 | + |
| 44 | +enableProdMode(); |
| 45 | +platformBrowserDynamic() |
| 46 | + .bootstrapModule(AppModule) |
| 47 | + .then(success => console.log(`Bootstrap success`)) |
| 48 | + .catch(err => console.error(err)); |
| 49 | +``` |
| 50 | + |
| 51 | +### ErrorHandler |
| 52 | + |
| 53 | +`@sentry/angular-ivy` exports a function to instantiate an ErrorHandler provider that will automatically send Javascript errors |
| 54 | +captured by the Angular's error handler. |
| 55 | + |
| 56 | +```javascript |
| 57 | +import { NgModule, ErrorHandler } from '@angular/core'; |
| 58 | +import { createErrorHandler } from '@sentry/angular-ivy'; |
| 59 | + |
| 60 | +@NgModule({ |
| 61 | + // ... |
| 62 | + providers: [ |
| 63 | + { |
| 64 | + provide: ErrorHandler, |
| 65 | + useValue: createErrorHandler({ |
| 66 | + showDialog: true, |
| 67 | + }), |
| 68 | + }, |
| 69 | + ], |
| 70 | + // ... |
| 71 | +}) |
| 72 | +export class AppModule {} |
| 73 | +``` |
| 74 | + |
| 75 | +Additionally, `createErrorHandler` accepts a set of options that allows you to configure its behavior. For more details |
| 76 | +see `ErrorHandlerOptions` interface in `src/errorhandler.ts`. |
| 77 | + |
| 78 | +### Tracing |
| 79 | + |
| 80 | +`@sentry/angular-ivy` exports a Trace Service, Directive and Decorators that leverage the `@sentry/tracing` Tracing |
| 81 | +integration to add Angular related spans to transactions. If the Tracing integration is not enabled, this functionality |
| 82 | +will not work. The service itself tracks route changes and durations, where directive and decorators are tracking |
| 83 | +components initializations. |
| 84 | + |
| 85 | +#### Install |
| 86 | + |
| 87 | +Registering a Trace Service is a 3-step process. |
| 88 | + |
| 89 | +1. Register and configure the `BrowserTracing` integration from `@sentry/tracing`, including custom Angular routing |
| 90 | + instrumentation: |
| 91 | + |
| 92 | +```javascript |
| 93 | +import { init, instrumentAngularRouting } from '@sentry/angular-ivy'; |
| 94 | +import { Integrations as TracingIntegrations } from '@sentry/tracing'; |
| 95 | + |
| 96 | +init({ |
| 97 | + dsn: '__DSN__', |
| 98 | + integrations: [ |
| 99 | + new TracingIntegrations.BrowserTracing({ |
| 100 | + tracingOrigins: ['localhost', 'https://yourserver.io/api'], |
| 101 | + routingInstrumentation: instrumentAngularRouting, |
| 102 | + }), |
| 103 | + ], |
| 104 | + tracesSampleRate: 1, |
| 105 | +}); |
| 106 | +``` |
| 107 | + |
| 108 | +2. Register `SentryTrace` as a provider in Angular's DI system, with a `Router` as its dependency: |
| 109 | + |
| 110 | +```javascript |
| 111 | +import { NgModule } from '@angular/core'; |
| 112 | +import { Router } from '@angular/router'; |
| 113 | +import { TraceService } from '@sentry/angular-ivy'; |
| 114 | + |
| 115 | +@NgModule({ |
| 116 | + // ... |
| 117 | + providers: [ |
| 118 | + { |
| 119 | + provide: TraceService, |
| 120 | + deps: [Router], |
| 121 | + }, |
| 122 | + ], |
| 123 | + // ... |
| 124 | +}) |
| 125 | +export class AppModule {} |
| 126 | +``` |
| 127 | + |
| 128 | +3. Either require the `TraceService` from inside `AppModule` or use `APP_INITIALIZER` to force-instantiate Tracing. |
| 129 | + |
| 130 | +```javascript |
| 131 | +@NgModule({ |
| 132 | + // ... |
| 133 | +}) |
| 134 | +export class AppModule { |
| 135 | + constructor(trace: TraceService) {} |
| 136 | +} |
| 137 | +``` |
| 138 | + |
| 139 | +or |
| 140 | + |
| 141 | +```javascript |
| 142 | +import { APP_INITIALIZER } from '@angular/core'; |
| 143 | + |
| 144 | +@NgModule({ |
| 145 | + // ... |
| 146 | + providers: [ |
| 147 | + { |
| 148 | + provide: APP_INITIALIZER, |
| 149 | + useFactory: () => () => {}, |
| 150 | + deps: [TraceService], |
| 151 | + multi: true, |
| 152 | + }, |
| 153 | + ], |
| 154 | + // ... |
| 155 | +}) |
| 156 | +export class AppModule {} |
| 157 | +``` |
| 158 | + |
| 159 | +#### Use |
| 160 | + |
| 161 | +To track Angular components as part of your transactions, you have 3 options. |
| 162 | + |
| 163 | +_TraceDirective:_ used to track a duration between `OnInit` and `AfterViewInit` lifecycle hooks in template: |
| 164 | + |
| 165 | +```javascript |
| 166 | +import { TraceModule } from '@sentry/angular-ivy'; |
| 167 | + |
| 168 | +@NgModule({ |
| 169 | + // ... |
| 170 | + imports: [TraceModule], |
| 171 | + // ... |
| 172 | +}) |
| 173 | +export class AppModule {} |
| 174 | +``` |
| 175 | + |
| 176 | +Then inside your components template (keep in mind that directive name attribute is required): |
| 177 | + |
| 178 | +```html |
| 179 | +<app-header trace="header"></app-header> |
| 180 | +<articles-list trace="articles-list"></articles-list> |
| 181 | +<app-footer trace="footer"></app-footer> |
| 182 | +``` |
| 183 | + |
| 184 | +_TraceClassDecorator:_ used to track a duration between `OnInit` and `AfterViewInit` lifecycle hooks in components: |
| 185 | + |
| 186 | +```javascript |
| 187 | +import { Component } from '@angular/core'; |
| 188 | +import { TraceClassDecorator } from '@sentry/angular-ivy'; |
| 189 | + |
| 190 | +@Component({ |
| 191 | + selector: 'layout-header', |
| 192 | + templateUrl: './header.component.html', |
| 193 | +}) |
| 194 | +@TraceClassDecorator() |
| 195 | +export class HeaderComponent { |
| 196 | + // ... |
| 197 | +} |
| 198 | +``` |
| 199 | + |
| 200 | +_TraceMethodDecorator:_ used to track a specific lifecycle hooks as point-in-time spans in components: |
| 201 | + |
| 202 | +```javascript |
| 203 | +import { Component, OnInit } from '@angular/core'; |
| 204 | +import { TraceMethodDecorator } from '@sentry/angular-ivy'; |
| 205 | + |
| 206 | +@Component({ |
| 207 | + selector: 'app-footer', |
| 208 | + templateUrl: './footer.component.html', |
| 209 | +}) |
| 210 | +export class FooterComponent implements OnInit { |
| 211 | + @TraceMethodDecorator() |
| 212 | + ngOnInit() {} |
| 213 | +} |
| 214 | +``` |
| 215 | + |
| 216 | +You can also add your own custom spans by attaching them to the current active transaction using `getActiveTransaction` |
| 217 | +helper. For example, if you'd like to track the duration of Angular boostraping process, you can do it as follows: |
| 218 | + |
| 219 | +```javascript |
| 220 | +import { enableProdMode } from '@angular/core'; |
| 221 | +import { platformBrowserDynamic } from '@angular/platform-browser-dynamic'; |
| 222 | +import { init, getActiveTransaction } from '@sentry/angular-ivy'; |
| 223 | + |
| 224 | +import { AppModule } from './app/app.module'; |
| 225 | + |
| 226 | +// ... |
| 227 | + |
| 228 | +const activeTransaction = getActiveTransaction(); |
| 229 | +const boostrapSpan = |
| 230 | + activeTransaction && |
| 231 | + activeTransaction.startChild({ |
| 232 | + description: 'platform-browser-dynamic', |
| 233 | + op: 'ui.angular.bootstrap', |
| 234 | + }); |
| 235 | + |
| 236 | +platformBrowserDynamic() |
| 237 | + .bootstrapModule(AppModule) |
| 238 | + .then(() => console.log(`Bootstrap success`)) |
| 239 | + .catch(err => console.error(err)); |
| 240 | + .finally(() => { |
| 241 | + if (bootstrapSpan) { |
| 242 | + boostrapSpan.finish(); |
| 243 | + } |
| 244 | + }) |
| 245 | +``` |
0 commit comments