diff --git a/docs/platforms/javascript/common/configuration/micro-frontend-support.mdx b/docs/platforms/javascript/common/configuration/micro-frontend-support.mdx index 8995a91e70636..b36662d4f09bb 100644 --- a/docs/platforms/javascript/common/configuration/micro-frontend-support.mdx +++ b/docs/platforms/javascript/common/configuration/micro-frontend-support.mdx @@ -14,18 +14,34 @@ keywords: If your frontend includes JavaScript bundles from multiple sources with different release cycles, you may want to identify these or route events to specific projects. This is especially useful if you've set up [module federation](https://module-federation.github.io/) or a similar frontend architecture. -## Identifying the source of errors +Below we offer two approaches. -To identify the source of an error, you must inject metadata that helps identify -which bundles were responsible for the error. You can do this with any of the -Sentry bundler plugins by enabling the `_experiments.moduleMetadata` option. + +In all cases `Sentry.init()` must never be called more than once, doing so will result in undefined behavior. + + +## Automatically Route Errors to Different Projects Depending on Module + +`ModuleMetadata` and `makeMultiplexedTransport` can be used together to automatically route +events to different Sentry projects based on the module where the error +occurred. + + + -`moduleMetadata` can be any serializable data or alternatively a function that -returns serializable data. If you supply a function, it will be passed an object -containing the `org`, `project`, and `release` strings. +First, to identify the source of an error, you must inject metadata that helps identify +which bundles were responsible for the error. You can do this with any of the +Sentry bundler plugins by enabling the `_experiments.moduleMetadata` option. The example +below is for Webpack, but this is also supported in Vite, Rollup, and esbuild. ```javascript // webpack.config.js @@ -37,61 +53,79 @@ module.exports = { sentryWebpackPlugin({ /* Other plugin config */ _experiments: { - moduleMetadata: ({ org, project, release }) => { - return { team: "frontend", release }; - }, + moduleMetadata: ({ release }) => ({ dsn: "__MODULE_DSN__", release }), }, }), ], }; ``` -### `ModuleMetadata` Integration - -Requires SDK version `7.59.0` or higher. - Once metadata has been injected into modules, the `moduleMetadataIntegration` can be used to look up that metadata and attach it to stack frames with -matching file names. This metadata is then available in other integrations or in -the `beforeSend` callback as the `module_metadata` property on each -`StackFrame`. This can be used to identify which bundles may be responsible -for an error and used to tag or route events. +matching file names. This metadata is then available in the `beforeSend` callback +as the `module_metadata` property on each `StackFrame`. This can be used to identify +which bundles may be responsible for an error. Once the destination is determined, you can +store it as a list of DSN-release pairs in `event.extra[MULTIPLEXED_TRANSPORT_EXTRA_KEY]` +for the multiplexed transport to reference for routing. + +In practice, here is what your Sentry initialization should look like: ```javascript -import * as Sentry from "@sentry/browser"; +import { init, makeFetchTransport, moduleMetadataIntegration, makeMultiplexedTransport } from "@sentry/browser"; + +const EXTRA_KEY = "ROUTE_TO"; + +const transport = makeMultiplexedTransport(makeFetchTransport, (args) => { + const event = args.getEvent(); + if ( + event && + event.extra && + EXTRA_KEY in event.extra && + Array.isArray(event.extra[EXTRA_KEY]) + ) { + return event.extra[EXTRA_KEY]; + } + return []; +}); -Sentry.init({ - dsn: "___PUBLIC_DSN___", - integrations: [Sentry.moduleMetadataIntegration()], +init({ + dsn: "__DEFAULT_DSN__", + integrations: [moduleMetadataIntegration()], + transport, beforeSend: (event) => { - const frames = event?.exception?.values?.[0].stacktrace.frames || []; - // Get all team names in the stack frames - const teams = frames - .filter((frame) => frame.module_metadata && frame.module_metadata.team) - .map((frame) => frame.module_metadata.team); - // If there are teams, add them as extra data to the event - if (teams.length > 0) { - event.extra = { - ...event.extra, - teams, - }; + if (event?.exception?.values?.[0].stacktrace.frames) { + const frames = event.exception.values[0].stacktrace.frames; + // Find the last frame with module metadata containing a DSN + const routeTo = frames + .filter((frame) => frame.module_metadata && frame.module_metadata.dsn) + .map((v) => v.module_metadata) + .slice(-1); // using top frame only - you may want to customize this according to your needs + + if (routeTo.length) { + event.extra = { + ...event.extra, + [EXTRA_KEY]: routeTo, + }; + } } return event; }, }); - -Sentry.captureException(new Error("oh no!")); ``` -## Routing events to different projects +Once this is set up, errors - both handled and unhandled - will be automatically routed to the right project. + -Once you've identified which module or modules are likely to be responsible for -an error, you may want to send these events to different Sentry projects. The -multiplexed transport can route events to different Sentry projects based on the -attributes on an event. +## Manually Route Errors to Different Projects +If, however, you would like to have more control over the routing of errors to the point +where you explicitly specify the destination for each individual `captureException`, +you can do that with the more advanced interface multiplexed transport offers. + + Requires SDK version `7.59.0` or higher. + The example below uses a `feature` tag to determine which Sentry project to send the event to. If the event does not have a `feature` tag, we send it to the @@ -130,107 +164,17 @@ init({ dsn: "__FALLBACK_DSN__", transport: makeMultiplexedTransport(makeFetchTransport, dsnFromFeature), }); - -captureException(new Error("oh no!"), (scope) => { - scope.setTag("feature", "cart"); - return scope; -}); -``` - -You can then set tags/contexts on events in individual micro-frontends to decide which Sentry project to send the event to. - -### `makeMultiplexedTransport` API - -`makeMultiplexedTransport` takes an instance of a transport (we recommend -`makeFetchTransport`) and a matcher function that returns an array of objects -containing the DSN and optionally the release. - -```typescript -interface RouteTo { - dsn: string; - release?: string; -} - -type Matcher = (param: MatchParam) => RouteTo[]; - -declare function makeMultiplexedTransport( - transport: (options: TransportOptions) => Transport, - matcher: Matcher -): (options: TransportOptions) => Transport; ``` -The matcher function runs after all client processing (`beforeSend` option, event processors from integrations). - -## Combining `ModuleMetadata` and `makeMultiplexedTransport` +You can then set tags/contexts on events in individual micro-frontends to decide which Sentry project to send the event to as follows: -`ModuleMetadata` and `makeMultiplexedTransport` can be used together to route -events to different Sentry projects based on the module where the error -occurred. - -Ensure your modules have injected metadata containing the project DSN and release: - -```javascript -// webpack.config.js -const { sentryWebpackPlugin } = require("@sentry/webpack-plugin"); + +It is important to always use a local scope when setting the tag (either as shown below or using withScope documentation). Using a global scope e.g. through `Sentry.setTag()` will result in all subsequent events being routed to the same DSN regardless of where they originate. + -module.exports = { - devtool: "source-map", - plugins: [ - sentryWebpackPlugin({ - _experiments: { - moduleMetadata: ({ release }) => ({ dsn: "__MODULE_DSN__", release }), - }, - }), - ], -}; ``` - -Then when you initialize Sentry: - -- Add the `ModuleMetadata` integration so metadata is attached to stack frames -- Add a `beforeSend` callback that sets an `extra` property with the target DSN/release -- Create a transport that routes events when the `extra` property is present - -```javascript -import { init, makeFetchTransport, moduleMetadataIntegration, makeMultiplexedTransport } from "@sentry/browser"; - -const EXTRA_KEY = "ROUTE_TO"; - -const transport = makeMultiplexedTransport(makeFetchTransport, (args) => { - const event = args.getEvent(); - if ( - event && - event.extra && - EXTRA_KEY in event.extra && - Array.isArray(event.extra[EXTRA_KEY]) - ) { - return event.extra[EXTRA_KEY]; - } - return []; -}); - -init({ - dsn: "__DEFAULT_DSN__", - integrations: [moduleMetadataIntegration()], - transport, - beforeSend: (event) => { - if (event?.exception?.values?.[0].stacktrace.frames) { - const frames = event.exception.values[0].stacktrace.frames; - // Find the last frame with module metadata containing a DSN - const routeTo = frames - .filter((frame) => frame.module_metadata && frame.module_metadata.dsn) - .map((v) => v.module_metadata) - .slice(-1); // using top frame only - you may want to customize this according to your needs - - if (routeTo.length) { - event.extra = { - ...event.extra, - [EXTRA_KEY]: routeTo, - }; - } - } - - return event; - }, +captureException(new Error("oh no!"), (scope) => { + scope.setTag("feature", "cart"); + return scope; }); ```