Sentry Tracing Extensions


Links

- Official SDK Docs
- TypeDoc

General

This package contains extensions to the @sentry/hub to enable Sentry AM related functionality. It also provides integrations for Browser and Node that provide a good experience out of the box.

Migrating from @sentry/apm to @sentry/tracing

The tracing integration for JavaScript SDKs has moved from
@sentry/apm to
@sentry/tracing. While the
two packages are similar, some imports and APIs have changed slightly.

The old package @sentry/apm is deprecated in favor of @sentry/tracing.
Future support for @sentry/apm is limited to bug fixes only.

Migrating from @sentry/apm to @sentry/tracing

$3

If you were using the Browser CDN bundle, switch from the old
bundle.apm.min.js to the new tracing bundle:

``html
src="https://browser.sentry-cdn.com/{{ packages.version('sentry.javascript.browser') }}/bundle.tracing.min.js"
integrity="sha384-{{ packages.checksum('sentry.javascript.browser', 'bundle.tracing.min.js', 'sha384-base64') }}"
crossorigin="anonymous"
>
`

And then update Sentry.init:

`diff
Sentry.init({
- integrations: [new Sentry.Integrations.Tracing()]
+ integrations: [new Sentry.Integrations.BrowserTracing()]
});
`

$3

If you were using automatic instrumentation, update the import statement and
update Sentry.init to use the new BrowserTracing integration:

`diff
import * as Sentry from "@sentry/browser";
-import { Integrations } from "@sentry/apm";
+import { Integrations } from "@sentry/tracing";

Sentry.init({
integrations: [
- new Integrations.Tracing(),
+ new Integrations.BrowserTracing(),
]
});
`

If you were using the beforeNavigate option from the Tracing integration,
the API in BrowserTracing has changed slightly. Instead of passing in a
location and returning a string representing transaction name, beforeNavigate
now accepts a transaction context and is expected to return a transaction
context. You can now add extra tags or change the op based on different
parameters. If you want to access the location like before, you can get it from
window.location.

For example, if you had a function like so that computed a custom transaction
name:

`javascript
import * as Sentry from "@sentry/browser";
import { Integrations } from "@sentry/apm";

Sentry.init({
integrations: [
new Integrations.Tracing({
beforeNavigate: location => {
return getTransactionName(location);
},
}),
],
});
`

You would now leverage the context to do the same thing:

`javascript
import * as Sentry from "@sentry/browser";
import { Integrations } from "@sentry/tracing";

Sentry.init({
integrations: [
new Integrations.BrowserTracing({
beforeNavigate: context => {
return {
...context,
// Can even look at context tags or other data to adjust
// transaction name
name: getTransactionName(window.location),
};
},
}),
],
});
`

For the full diff:

`diff
import * as Sentry from "@sentry/browser";
-import { Integrations } from "@sentry/apm";
+import { Integrations } from "@sentry/tracing";

Sentry.init({
integrations: [
- new Integrations.Tracing({
- beforeNavigate: (location) => {
- return getTransactionName(location)
+ new Integrations.BrowserTracing({
+ beforeNavigate: (ctx) => {
+ return {
+ ...ctx,
+ name: getTransactionName(ctx.name, window.location)
+ }
}
}),
]
});
`

$3

If you were using the Express integration for automatic instrumentation, the
only necessary change is to update the import statement:

`diff
import * as Sentry from "@sentry/node";
-import { Integrations } from "@sentry/apm";
+import { Integrations } from "@sentry/tracing";

Sentry.init({
integrations: [
new Integrations.Express(),
]
});
``