--- title: "Migrate from 7.x to 8.x" description: "Learn about migrating from Sentry JavaScript SDK 7.x to 8.x" url: https://docs.sentry.io/platforms/javascript/migration/v7-to-v8/ --- # Migrate from 7.x to 8.x | Sentry for JavaScript The main goal of version 8 is to improve our performance monitoring APIs, integrations API, and ESM support. This version is breaking because we removed deprecated APIs, restructured npm package contents, and introduced new dependencies on OpenTelemetry. ## [Migration Codemod](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#migration-codemod) Before updating to `8.x` of the SDK, we recommend upgrading to the latest version of `7.x`. To fix most of the deprecations on `7.x`, you can use the [`@sentry/migr8`](https://www.npmjs.com/package/@sentry/migr8) codemod to automatically update your SDK usage. `@sentry/migr8` requires Node 18+. ```bash npx @sentry/migr8@latest ``` Our migration tool will let you select which updates to run, and automatically update your code. In some cases, we cannot automatically change code for you. These will be marked with a `TODO(sentry)` comment instead. Make sure to review all code changes after running `@sentry/migr8`! For more details on the deprecations, see our docs on [Deprecations in 7.x](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8/v7-deprecations.md). Despite having `@sentry/migr8`, we still recommend reading the migration guide, since `@sentry/migr8` does not cover all of the changes needed to migrate. ## [Upgrading to `8.x`](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#upgrading-to-8x) `8.x` simplifies Sentry SDK initialization and makes several internal improvements. We recommend you read through all the [Important Changes](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#important-changes) as they affect all SDK users. The [Other Changes](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#other-changes) linked below only affect users who have more customized instrumentation. There is also a [Troubleshooting](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#troubleshooting) section for common issues. We also have a [detailed migration guide](https://github.com/getsentry/sentry-javascript/blob/develop/MIGRATION.md#upgrading-from-7x-to-8x) on GitHub, which has a comprehensive list of all changes alongside the source code of the SDK. ## [Important Changes](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#important-changes) ### [Supported versions](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#supported-versions) The SDK now requires ES2018 compatibility plus support for [`globalThis`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/globalThis). The minimum supported browser versions are: * Chrome 71 * Edge 79 * Safari 12.1, iOS Safari 12.2 * Firefox 65 * Opera 58 * Samsung Internet 10 For IE11 support please transpile your code to ES5 using babel or similar and add required polyfills. ### [New Tracing APIs](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#new-tracing-apis) The Custom Instrumentation API for Tracing has been revamped in `8.x`. New methods have been introduced, and `startTransaction` and `span.startChild` has been removed. See the [new Tracing APIs docs](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8/v8-new-performance-api.md) for more information. ## [Other Changes](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#other-changes) ### [Removal of `@sentry/replay` package](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#removal-of-sentryreplay-package) The `@sentry/replay` package is no longer required. Instead you can import the relevant methods directly from your SDK. In addition to this, the integration is now functional instead of class-based. ```JavaScript -import { Replay } from '@sentry/replay'; - Sentry.init({ dsn: '___PUBLIC_DSN___', integrations: [ - new Replay(), + Sentry.replayIntegration(), ], }); ``` ### [Change of Replay default options (`unblock` and `unmask`)](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#change-of-replay-default-options-unblock-and-unmask) The Replay options `unblock` and `unmask` now have `[]` as default value. This means that if you want to use these options, you have to explicitly set them like this: ```JavaScript Sentry.init({ integrations: [ Sentry.replayIntegration({ unblock: [".sentry-unblock, [data-sentry-unblock]"], unmask: [".sentry-unmask, [data-sentry-unmask]"], }), ], }); ``` ### [Removal of makeXHRTransport transport](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#removal-of-makexhrtransport-transport) The xhr transport via `makeXHRTransport` transport has been removed. Only `makeFetchTransport` is available now. This means that the Sentry SDK requires the `fetch` API to be available in the environment. ### [Removal of the `Offline` integration](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#removal-of-the-offline-integration) The `Offline` integration has been removed in favor of the [offline transport wrapper](https://docs.sentry.io/platforms/javascript/configuration/transports.md#makebrowserofflinetransport) ### [Removal of `wrap` export](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#removal-of-wrap-export) The `Sentry.wrap` export has been removed. There is no replacement API. ### [Updated behaviour of `tracePropagationTargets` in the browser](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#updated-behaviour-of-tracepropagationtargets-in-the-browser) We updated the behaviour of the SDKs when no `tracePropagationTargets` option was defined. As a reminder, you can provide a list of strings or RegExes that will be matched against URLs to tell the SDK, to which outgoing requests tracing HTTP headers should be attached to. These tracing headers are used for distributed tracing. Previously, on the browser, when `tracePropagationTargets` were not defined, they defaulted to the following: `['localhost', /^\/(?!\/)/]`. This meant that all request targets to that had "localhost" in the URL, or started with a `/` were equipped with tracing headers. This default was chosen to prevent CORS errors in your browser applications. However, this default had a few flaws. Going forward, when the `tracePropagationTargets` option is not set, tracing headers will be attached to all outgoing requests on the same origin. For example, if you're on `https://example.com/` and you send a request to `https://example.com/api`, the request will be traced (ie. will have trace headers attached). Requests to `https://api.example.com/` will not, because it is on a different origin. The same goes for all applications running on `localhost`. When you provide a `tracePropagationTargets` option, all of the entries you defined will now be matched be matched against the full URL of the outgoing request. Previously, it was only matched against what you called request APIs with. For example, if you made a request like `fetch("/api/posts")`, the provided `tracePropagationTargets` were only compared against `"/api/posts"`. ### [Deprecation of `Hub` and `getCurrentHub()`](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#deprecation-of-hub-and-getcurrenthub) The `Hub` has been a very important part of the Sentry SDK API up until now. Hubs were the SDK's "unit of concurrency" to keep track of data across threads and to scope data to certain parts of your code. Because it is overly complicated and confusing to power users, it is going to be replaced by a set of new APIs: the "new Scope API". For now `Hub` and `getCurrentHub` are still available, but it will be removed in the next major version. See [Deprecate Hub](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8/v7-deprecations.md#deprecate-hub) for details on how to replace existing usage of the Hub APIs. ### [Removal of class-based integrations](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#removal-of-class-based-integrations) In v7, integrations are classes and can be added as e.g. `integrations: [new Sentry.Replay()]`. In v8, integrations will not be classes anymore, but instead functions. Both the use as a class, as well as accessing integrations from the `Integrations.XXX` hash, is deprecated in favor of using the new functional integrations. For example, `new Integrations.LinkedErrors()` becomes `linkedErrorsIntegration()`. For a list of integrations and their replacements, see [the `7.x` deprecation documentation](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8/v7-deprecations.md#deprecate-class-based-integrations). ### [Removal of `Sentry.configureScope` method](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#removal-of-sentryconfigurescope-method) The top level `Sentry.configureScope` function has been removed. Instead, you should use the `Sentry.getCurrentScope()` to access and mutate the current scope. ```JavaScript - Sentry.configureScope((scope) => { - scope.setTag("key", "value"); - }); + Sentry.getCurrentScope().setTag("key", "value"); ``` ### [`tracingOrigins` has been replaced by `tracePropagationTargets`](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#tracingorigins-has-been-replaced-by-tracepropagationtargets) `tracingOrigins` is now removed in favor of the `tracePropagationTargets` option. The `tracePropagationTargets` option should be set in the `Sentry.init()` options, or in your custom `Client`s option if you create them. ```TypeScript Sentry.init({ dsn: "___DSN___", integrations: [Sentry.browserTracingIntegration()], tracePropagationTargets: ["localhost", "example.com"], }); ``` ### [Simplification of Metrics Configuration](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#simplification-of-metrics-configuration) In `7.x`, you had to enable the metrics aggregator by setting the `_experiments` option to `{ metricsAggregator: true }`. In addition for browser environments you had to add the `metricsAggregatorIntegration` to the `integrations` array. ```TypeScript // v7 - Server (Node/Deno/Bun) Sentry.init({ dsn: "___PUBLIC_DSN___", _experiments: { metricsAggregator: true, }, }); // v7 - Browser Sentry.init({ dsn: "___PUBLIC_DSN___", integrations: [Sentry.metricsAggregatorIntegration()], }); Sentry.metrics.increment("my_metric"); ``` In `8.x` no additional configuration is needed to use metrics APIs. ```ts // v8 Sentry.init({ dsn: "___PUBLIC_DSN___", }); Sentry.metrics.increment("my_metric"); ``` ### [Removal of Severity Enum](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#removal-of-severity-enum) In `7.x` we deprecated the `Severity` enum in favor of using the `SeverityLevel` type as this helps save bundle size, and this has been removed in `8.x`. You should now use the `SeverityLevel` type directly. ```JavaScript - import { Severity } from '@sentry/types'; + import { SeverityLevel } from '@sentry/types'; - const level = Severity.error; + const level: SeverityLevel = "error"; ``` #### [Removal of `spanStatusfromHttpCode` in favour of `getSpanStatusFromHttpCode`](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#removal-of-spanstatusfromhttpcode-in-favour-of-getspanstatusfromhttpcode) In `8.x`, we are removing the `spanStatusfromHttpCode` function in favor of `getSpanStatusFromHttpCode`. ```JavaScript - const spanStatus = spanStatusfromHttpCode(200); + const spanStatus = getSpanStatusFromHttpCode(200); ``` ### [`framesToPop` applies to parsed frames](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#framestopop-applies-to-parsed-frames) Errors with `framesToPop` property will have the specified number of frames removed from the top of the stack. This changes compared to the v7 where the property `framesToPop` was used to remove top n lines from the stack string. ### [Removal of `Span` class export from SDK packages](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#removal-of-span-class-export-from-sdk-packages) In `8.x`, we are no longer exporting the `Span` class from SDK packages. Internally, this class is now called `SentrySpan`, and it is no longer meant to be used by users directly. ### [Removal of `void` from transport return types](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#removal-of-void-from-transport-return-types) The `send` method on the `Transport` interface now always requires a `TransportMakeRequestResponse` to be returned in the promise. This means that the `void` return type is no longer allowed. ```TypeScript // v7 interface Transport { - send(event: Event): Promise; + send(event: Event): Promise; } ``` ### [`extraErrorDataIntegration` changes](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#extraerrordataintegration-changes) The `extraErrorDataIntegration` integration now looks at [`error.cause`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/cause) by default. ### [`transactionContext` no longer passed to `tracesSampler`](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#transactioncontext-no-longer-passed-to-tracessampler) Instead of an `transactionContext` being passed to the `tracesSampler` callback, the callback will directly receive `name` and `attributes` going forward. Note that the `attributes` are only the attributes at span creation time, and some attributes may only be set later during the span lifecycle (and thus not be available during sampling). ### [`getClient()` always returns a client](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#getclient-always-returns-a-client) `getClient()` now always returns a client if `Sentry.init()` was called. For cases where this may be used to check if Sentry was actually initialized, using `getClient()` will thus not work anymore. Instead, you should use the new `Sentry.isInitialized()` utility to check this. ### [Removal of `addGlobalEventProcessor` in favour of `addEventProcessor`](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#removal-of-addglobaleventprocessor-in-favour-of-addeventprocessor) In `8.x`, we are removing the `addGlobalEventProcessor` function in favor of `addEventProcessor`. ```JavaScript - Sentry.addGlobalEventProcessor((event) => { + Sentry.getGlobalScope().addEventProcessor((event) => { delete event.extra; return event; }); ``` ### [Removal of `@sentry/integrations` package](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#removal-of-sentryintegrations-package) `@sentry/integrations` has been removed and will no longer be published. We moved pluggable integrations from their own package (`@sentry/integrations`) to `@sentry/browser`. In addition they are now functions instead of classes. Integrations will still be available via the CDN, but they will exposed as functions not classes as is shown below. Integrations that are now exported from `@sentry/browser` for client-side init: * `httpClientIntegration` (`HTTPClient`) * `contextLinesIntegration` (`ContextLines`) * `reportingObserverIntegration` (`ReportingObserver`) * `captureConsoleIntegration` (`CaptureConsole`) * `debugIntegration` (`Debug`) * `extraErrorDataIntegration` (`ExtraErrorData`) * `rewriteFramesIntegration` (`RewriteFrames`) * `sessionTimingIntegration` (`SessionTiming`) * `dedupeIntegration` (`Dedupe`) - Note: enabled by default, not pluggable The `Transaction` integration has been removed from `@sentry/integrations`. There is no replacement API. ## [Troubleshooting](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#troubleshooting) ### [Conflicting Dependency Versions with Bundler Plugins](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8.md#conflicting-dependency-versions-with-bundler-plugins) If you are getting errors from within the Sentry SDK that it is trying to access certain functions that are not available, for example "... is not a function", it is possible that there are misaligned versions installed. The Sentry JavaScript Bundler Plugins (`@sentry/webpack-plugin`, `@sentry/vite-plugin`, `@sentry/esbuild-plugin`, `@sentry/rollup-plugin`) used to depend on certain Sentry SDK packages on version 7, which may clash with version 8 of the SDK. The recommendation is to upgrade the JavaScript Bundler Plugin packages to at least version `2.14.2` which will no longer include dependencies on v7 of the Sentry JavaScript SDK. ## Pages in this section - [New Tracing APIs](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8/v8-new-performance-api.md) - [Deprecations in 7.x](https://docs.sentry.io/platforms/javascript/migration/v7-to-v8/v7-deprecations.md)