Skip to content

Commit 09cc571

Browse files
committed
doc(v7/angular-ivy): Add discontinuity note
1 parent c035a95 commit 09cc571

File tree

1 file changed

+24
-15
lines changed

1 file changed

+24
-15
lines changed

packages/angular-ivy/README.md

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,24 @@
1414

1515
- [Official SDK Docs](https://docs.sentry.io/platforms/javascript/angular/)
1616

17+
## Package Discontinued
18+
19+
The `@sentry/angular-ivy` package was discontinued with the release of version 8.0.0 of `@sentry/angular`. The v8
20+
`@sentry/angular` package is now fully compatible with Ivy by default, making this package obsolete. Furthermore, new
21+
Angular versions (18+) are supported in version 8.
22+
23+
To upgrade to v8, follow the
24+
[Angular SDK migration guide](https://docs.sentry.io/platforms/javascript/guides/angular/migration/v7-to-v8/).
25+
1726
## Angular Version Compatibility
1827

1928
This SDK officially supports Angular 12 to 17 with Angular's new rendering engine, Ivy.
2029

21-
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).
30+
If you're using Angular 10, 11 or a newer Angular version with View Engine instead of Ivy, please use
31+
[`@sentry/angular`](https://github.com/getsentry/sentry-javascript/blob/develop/packages/angular/README.md).
2232

23-
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.
24-
Please note that we don't provide any support for Angular versions below 10.
33+
If you're using an older version of Angular and experience problems with the Angular SDK, we recommend downgrading the
34+
SDK to version 6.x. Please note that we don't provide any support for Angular versions below 10.
2535

2636
## General
2737

@@ -53,8 +63,8 @@ platformBrowserDynamic()
5363

5464
### ErrorHandler
5565

56-
`@sentry/angular-ivy` exports a function to instantiate an ErrorHandler provider that will automatically send Javascript errors
57-
captured by the Angular's error handler.
66+
`@sentry/angular-ivy` exports a function to instantiate an ErrorHandler provider that will automatically send Javascript
67+
errors captured by the Angular's error handler.
5868

5969
```javascript
6070
import { NgModule, ErrorHandler } from '@angular/core';
@@ -89,17 +99,14 @@ initializations.
8999

90100
Registering a Trace Service is a 3-step process.
91101

92-
1. Register and configure the `BrowserTracing` integration, including custom Angular routing
93-
instrumentation:
102+
1. Register and configure the `BrowserTracing` integration, including custom Angular routing instrumentation:
94103

95104
```javascript
96105
import { init, browserTracingIntegration } from '@sentry/angular-ivy';
97106

98107
init({
99108
dsn: '__DSN__',
100-
integrations: [
101-
browserTracingIntegration(),
102-
],
109+
integrations: [browserTracingIntegration()],
103110
tracePropagationTargets: ['localhost', 'https://yourserver.io/api'],
104111
tracesSampleRate: 1,
105112
});
@@ -213,7 +220,8 @@ export class FooterComponent implements OnInit {
213220
}
214221
```
215222

216-
You can also add your own custom spans via `startSpan()`. For example, if you'd like to track the duration of Angular boostraping process, you can do it as follows:
223+
You can also add your own custom spans via `startSpan()`. For example, if you'd like to track the duration of Angular
224+
boostraping process, you can do it as follows:
217225

218226
```javascript
219227
import { enableProdMode } from '@angular/core';
@@ -223,12 +231,13 @@ import { init, startSpan } from '@sentry/angular';
223231
import { AppModule } from './app/app.module';
224232

225233
// ...
226-
startSpan({
227-
name: 'platform-browser-dynamic',
228-
op: 'ui.angular.bootstrap'
234+
startSpan(
235+
{
236+
name: 'platform-browser-dynamic',
237+
op: 'ui.angular.bootstrap',
229238
},
230239
async () => {
231240
await platformBrowserDynamic().bootstrapModule(AppModule);
232-
}
241+
},
233242
);
234243
```

0 commit comments

Comments
 (0)