@sentry/tracing

Important Changes

• node: Add AsyncLocalStorage implementation of AsyncContextStrategy

  • feat(core): Extend AsyncContextStrategy to allow reuse of existing context

  • feat(core): Make runWithAsyncContext public API

  • feat(core): Add async context abstraction

  • feat(node): Adds domain implementation of AsyncContextStrategy

  • feat(node): Auto-select best AsyncContextStrategy for Node.js version

  • feat(node): Migrate to domains used through AsyncContextStrategy

This release switches the SDK to use AsyncLocalStorage as the async context isolation mechanism in the SDK for Node 14+. For Node 10 - 13, we continue to use the Node domain standard library, since AsyncLocalStorage is not supported there. Preliminary testing showed a 30% improvement in latency and rps when making the switch from domains to AsyncLocalStorage on Node 16.

If you want to manually add async context isolation to your application, you can use the new runWithAsyncContext API.

import * as Sentry from '@sentry/node';

const requestHandler = (ctx, next) => {
  return new Promise((resolve) => {
    Sentry.runWithAsyncContext(async () => {
      const hub = Sentry.getCurrentHub();

      hub.configureScope(scope =>
        scope.addEventProcessor(event =>
          Sentry.addRequestDataToEvent(event, ctx.request, {
            include: {
              user: false,
            },
          })
        )
      );

      await next();
      resolve();
    });
  });
};

If you're manually using domains to isolate Sentry data, we strongly recommend switching to this API!

In addition to exporting runWithAsyncContext publicly, the SDK also uses it internally where we previously used domains.

• sveltekit: Remove withSentryViteConfig

  • feat(sveltekit): Remove SDK initialization via dedicated files

This release removes our withSentryViteConfig wrapper we previously instructed you to add to your vite.config.js file. It is replaced Vite plugins which you simply add to your Vite config, just like the sveltekit() Vite plugins. We believe this is a more transparent and Vite/SvelteKit-native way of applying build time modifications. Here's how to use the plugins:

// vite.config.js
import { sveltekit } from '@sveltejs/kit/vite';
import { sentrySvelteKit } from '@sentry/sveltekit';

export default {
  plugins: [sentrySvelteKit(), sveltekit()],
  // ... rest of your Vite config
};

Take a look at the README for updated instructions!

Furthermore, with this transition, we removed the possibility to intialize the SDK in dedicated sentry.(client|server).config.js files. Please use SvelteKit's hooks files to initialize the SDK.

Please note that these are breaking changes! We're sorry for the inconvenience but the SvelteKit SDK is still in alpha stage and we want to establish a clean and SvelteKit-friendly API before making the SDK stable. You have been warned ;)

• sveltekit: Add Sentry Vite Plugin to upload source maps

This release adds automatic upload of source maps to the SvelteKit SDK. No need to configure anything other than adding our Vite plugins to your SDK. The example above shows you how to do this.

Please make sure to follow the README to specify your Sentry auth token, as well as org and project slugs.

- feat(replay): Capture request & response headers (#7816)

Replay now captures the content-length, content-type, and accept headers from requests and responses automatically.

Additional Features and Fixes

• browser: Export request instrumentation options

• core: Add async context abstraction

• core: Add DSC to all outgoing envelopes

• core: Cache processed stacks for debug IDs

• node: Add checkin envelope types

• replay: Add getReplayId() method

• browser: Adjust BrowserTransportOptions to support offline transport options

• browser: DOMException SecurityError stacktrace parsing bug

• core: Log warning when tracing extensions are missing

• core: Only call applyDebugMetadata for error events

• integrations: Ensure httpclient integration works with Request

• node: reuseExisting does not need to call bind on domain

• node: Fix domain scope inheritance

• node: Make trpcMiddleware factory synchronous

• serverless: Account when transaction undefined

• utils: Make xhr instrumentation independent of parallel running SDK versions

Bundle size

Important Changes

• feat(browser): Add captureUserFeedback

This release adds a new API, Sentry.captureUserFeedback, to browser-side SDKs that allows you to send user feedback to Sentry without loading and opening Sentry's user feedback dialog. This allows you to obtain user feedback however and whenever you want to and simply send it to Sentry using the SDK.

For instance, you can collect feedback, whenever convenient as shown in this example:

const eventId = Sentry.captureMessage('User Feedback');
const user = Sentry.getCurrentHub().getScope().getUser();
const userFeedback = {
  event_id: eventId;
  email: user.email
  name: user.username
  comments: 'I really like your App, thanks!'
}
Sentry.captureUserFeedback(userFeedback);

Note that feedback needs to be coupled to an event but as in the example above, you can just use Sentry.captureMessage to generate one.

You could also collect feedback in a custom way if an error happens and use the SDK to send it along:

Sentry.init({
  dsn: '__DSN__',
  beforeSend: event => {
    const userFeedback = collectYourUserFeedback();
    const feedback = {
      ...userFeedback,
      event_id: event.event_id.
    }
    Sentry.captureUserFeedback(feedback);
    return event;
  }
})

• deprecated

  feat(tracing): Deprecate @sentry/tracing exports

With this release, we officially deprecate all exports from the @sentry/tracing package, in favour of using them directly from the main SDK package. The @sentry/tracing package will be removed in a future major release.

Please take a look at the Migration docs for more details.

Additional Features and Fixes

• sveltekit: Add partial instrumentation for client-side fetch

• angular: Handle routes with empty path

• angular: Only open report dialog if error was sent

• core: Determine debug ID paths from the top of the stack

• ember: Ensure only one client is created & Replay works

• integrations: Ensure HttpClient integration works with Axios

• loader: Ensure JS loader works with tracing & add tests

• nextjs: Restore tree shaking capabilities

• node: Disable LocalVariables integration on Node < v18

• node: Redact URL authority only in breadcrumbs and spans

• react: Only show report dialog if event was sent to Sentry

• remix: Remove unnecessary dependencies

• replay: Ensure circular references are handled

• sveltekit: Don't capture thrown Redirects as exceptions

• sveltekit: Log error to console by default in handleErrorWithSentry

• tracing: Make sure idle transaction does not override other transactions

Work in this release contributed by @de-don and @TrySound. Thank you for your contributions!

Bundle size

Important Changes

• feat(sveltekit): Add Performance Monitoring for SvelteKit

  • feat(sveltekit): Add meta tag for backend -> frontend

  • fix(sveltekit): Explicitly export Node SDK exports

  • fix(sveltekit): Handle nested server calls in sentryHandle

  • ref(sveltekit): Split up universal and server load wrappers

This release adds support for Performance Monitoring in our SvelteKit SDK for the client/server. We've also changed how you should initialize your SDK. Please read our updated SvelteKit README instructions for more details.

• feat(core): Add ignoreTransactions option

You can now easily filter out certain transactions from being sent to Sentry based on their name.

Sentry.init({
  ignoreTransactions: ['/api/healthcheck', '/ping'],
})

• feat(node): Undici integration

  • feat(nextjs): Add Undici integration automatically

  • feat(sveltekit): Add Undici integration by default

We've added an integration that automatically instruments Undici and Node server side fetch. This supports Undici v4.7.0 or higher and requires Node v16.7.0 or higher. After adding the integration outgoing requests made by Undici will have associated spans and breadcrumbs in Sentry.

Sentry.init({
  integrations: [new Sentry.Integrations.Undici()],
})

In our Next.js and SvelteKit SDKs, this integration is automatically added.

• feat(node): Add Sentry tRPC middleware

We've added a new middleware for trpc that automatically adds TRPC information to Sentry transactions. This middleware is meant to be used in combination with a Sentry server integration (Next.js, Express, etc).

import { initTRPC } from '@trpc/server';
import * as Sentry from '@sentry/node';

const t = initTRPC.context().create();
const sentryMiddleware = t.middleware(
  Sentry.Handlers.trpcMiddleware({
    attachRpcInput: true,
  }),
);

const sentrifiedProcedure = t.procedure.use(sentryMiddleware);

• feat(tracing): Remove requirement for @sentry/tracing package

With 7.46.0 you no longer require the @sentry/tracing package to use tracing and performance monitoring with the Sentry JavaScript SDKs. The @sentry/tracing package will be removed in a future major release, but can still be used with no changes.

Please see the Migration docs for more details.

• fix(node): Convert debugging code to callbacks to fix memory leak in LocalVariables integration

This fixes a memory leak in the opt-in LocalVariables integration, which adds local variables to the stacktraces sent to Sentry. The minimum recommended version to use the LocalVariables is now 7.46.0.

Additional Features and Fixes

• node: Auto discovery only returns integrations where dependency loads

• node: Sanitize URLs in Span descriptions and breadcrumbs (PII)

• replay: Add responseStatus, decodedBodySize to perf entries

• replay: Add experiment to capture request/response bodies

• replay: Capture replay mutation breadcrumbs & add experiment

• tracing: Ensure pageload transaction starts at timeOrigin

• core: Remove abs_path from stack trace (reverting #7167)

• nextjs: Add loading component type to server component wrapping

• nextjs: Don't report NEXT_NOT_FOUND and NEXT_REDIRECT errors

• nextjs: Rewrite abs_path frames

• nextjs: Show errors and warnings only once during build

• nextjs: Use Next.js internal AsyncStorage

• nextjs: Gracefully handle undefined beforeFiles in rewrites

Work in this release contributed by @aldenquimby and @bertho-zero. Thank you for your contributions!

Bundle size

• core: Add trace function

• hub: Make scope always defined on the hub

• replay: Add replay_id to transaction DSC

• replay: Capture fetch body size for replay events

• sveltekit: Add performance monitoring for client load

• sveltekit: Add performance monitoring for server load

• sveltekit: Add performance monitoring to Sveltekit server handle

• sveltekit: Add SvelteKit routing instrumentation

• browser: Ensure keepalive flag is correctly set for parallel requests

• core: Ensure ignoreErrors only applies to error events

• node: Consider tracing error handler for process exit

• otel: Make sure we use correct hub on finish

• react: Handle case where error.cause already defined

Bundle size

This release introduces the first alpha version of @sentry/sveltekit, our newest JavaScript SDK for Sveltekit. Check out the README for usage instructions and what to expect from this alpha release.

• replay: Add request_body_size & response_body_size to fetch/xhr

• replay: Add additional properties for UI clicks

• replay: Reduce time limit before pausing a recording

• replay: Upgrade rrweb and rrweb-player

• replay: Use new afterSend hook to improve error linking

• serverless: Publish lambda layer for Node 16/18

• sveltekit: Add wrapper for client load function

• sveltekit: Add wrapper for server load function

• sveltekit: Add server-side handleError wrapper

• sveltekit: Introduce client-side handleError wrapper

• sveltekit: Add SvelteKit client and server init functions

• sveltekit: Inject Sentry.init calls into server and client bundles

• tracing: Expose BrowserTracing in non-tracing bundles

• core: Permanent idle timeout cancel finishes the transaction with the last finished child

• integrations: Handle lower-case prefix windows paths in RewriteFrames

• next: Guard against missing serverSideProps

• nextjs: Fix broken server component wrapping because of interrupted promise chain

• nextjs: Fix runtime error for static pages

• profiling: Catch sendProfile rejection

• replay: Never capture file input changes

• serverless: Explicitly export node package exports

• vue: Do not depend on window.location for SSR environments

Replay rrweb changes:

@sentry-internal/rrweb was updated from 1.105.0 to 1.106.0:

• Ensure password inputs are always masked

• Ensure text masking for updated attributes works

• Ensure unmaskTextSelector is used for masked attributes

• Mask <option> values for selects & radio/checkbox value

Work in this release contributed by @woochanleee and @baked-dev. Thank you for your contribution!

• nextjs: Run source map upload in Vercel develop and preview environments

• types: Add profilesSampler option to node client type

• core: Avoid using Array.findIndex() as it is ES5 incompatible

• nextjs: Add better error messages for missing params during next build

• nextjs: Don't crash build when auth token is missing

• node: Revert to dynamic require call to fix monkey patching