diff --git a/docs/integrations/deployment/vercel/index.mdx b/docs/integrations/deployment/vercel/index.mdx index 8841011fff6f8..34db175a6c51a 100644 --- a/docs/integrations/deployment/vercel/index.mdx +++ b/docs/integrations/deployment/vercel/index.mdx @@ -67,7 +67,7 @@ Use Vercel to [link projects](#project-linking) for uploading source maps and no - If you have not already done so, [instrument your code with Sentry](/platforms/javascript/). - Ensure you have [installed a repository integration](/product/releases/setup/release-automation/) and added the relevant repository. -- Add a Sentry bundler plugin to your bundler configuration ([webpack plugin](https://www.npmjs.com/package/@sentry/webpack-plugin), [Vite Plugin](https://www.npmjs.com/package/@sentry/vite-plugin), [Esbuild Plugin](https://www.npmjs.com/package/@sentry/esbuild-plugin), [Rollup Plugin](https://www.npmjs.com/package/@sentry/rollup-plugin)). If you are using Sentry's Next.js, or SvelteKit SDKs this will already have been done for you. +- Add a Sentry bundler plugin to your bundler configuration ([webpack plugin](/platforms/javascript/sourcemaps/uploading/webpack/), [Vite Plugin](/platforms/javascript/sourcemaps/uploading/vite/), [Esbuild Plugin](/platforms/javascript/sourcemaps/uploading/esbuild/), [Rollup Plugin](/platforms/javascript/sourcemaps/uploading/rollup/)). If you are using Sentry's Next.js, or SvelteKit SDKs this will already have been done for you. - In case you already have a Vercel project integrated with Sentry, ensure the Sentry project you link is the one you're already using to report errors. ### Drains diff --git a/docs/platforms/javascript/common/best-practices/micro-frontends.mdx b/docs/platforms/javascript/common/best-practices/micro-frontends.mdx index 35346e311a313..36a8eecc493df 100644 --- a/docs/platforms/javascript/common/best-practices/micro-frontends.mdx +++ b/docs/platforms/javascript/common/best-practices/micro-frontends.mdx @@ -63,9 +63,9 @@ fix them faster in complex frontend architectures. @@ -80,7 +80,7 @@ below is for Webpack, but this is also supported in Vite, Rollup, and esbuild. ```javascript // webpack.config.js -const { sentryWebpackPlugin } = require("@sentry/webpack-plugin"); +const { sentryWebpackPlugin } = require("@sentry/bundler-plugins/webpack"); module.exports = { devtool: "hidden-source-map", // Source map generation must be turned on ("hidden-source-map", "source-map", etc.) diff --git a/docs/platforms/javascript/common/configuration/filtering.mdx b/docs/platforms/javascript/common/configuration/filtering.mdx index d52ef5f3951bc..cb8e08cceb53c 100644 --- a/docs/platforms/javascript/common/configuration/filtering.mdx +++ b/docs/platforms/javascript/common/configuration/filtering.mdx @@ -57,7 +57,7 @@ This integration can be very helpful in reducing noise that's not related to you -**Prerequisite**: To use the `thirdPartyErrorFilterIntegration`, ensure you are using a bundler and one of [Sentry's bundler plugins](https://github.com/getsentry/sentry-javascript-bundler-plugins). For **Next.js**, set the [`applicationKey`](/platforms/javascript/guides/nextjs/configuration/build/#applicationKey) build option, which works for both Webpack and Turbopack builds. +**Prerequisite**: To use the `thirdPartyErrorFilterIntegration`, ensure you are using a bundler and one of Sentry's bundler plugins. For **Next.js**, set the [`applicationKey`](/platforms/javascript/guides/nextjs/configuration/build/#applicationKey) build option, which works for both Webpack and Turbopack builds. diff --git a/docs/platforms/javascript/common/configuration/tree-shaking.mdx b/docs/platforms/javascript/common/configuration/tree-shaking.mdx index 552d81061827e..effaf0851b40c 100644 --- a/docs/platforms/javascript/common/configuration/tree-shaking.mdx +++ b/docs/platforms/javascript/common/configuration/tree-shaking.mdx @@ -37,7 +37,7 @@ If you're using one of our bundler plugins, you can use the `bundleSizeOptimizat ```javascript -// For example, the @sentry/webpack-plugin passed to the webpack config +// For example, the @sentry/bundler-plugins/webpack passed to the webpack config sentryPlugin({ // other config bundleSizeOptimizations: { @@ -55,7 +55,7 @@ sentryPlugin({ ```javascript -// For example, the @sentry/webpack-plugin passed to the webpack config +// For example, the @sentry/bundler-plugins/webpack passed to the webpack config sentryPlugin({ // other config bundleSizeOptimizations: { @@ -68,10 +68,11 @@ sentryPlugin({ For more details, see the documentation for the specific bundler plugin you're using: -- [Sentry Webpack Plugin](https://www.npmjs.com/package/@sentry/webpack-plugin) -- [Sentry Vite Plugin](https://www.npmjs.com/package/@sentry/vite-plugin) -- [Sentry Esbuild Plugin](https://www.npmjs.com/package/@sentry/esbuild-plugin) -- [Sentry Rollup Plugin](https://www.npmjs.com/package/@sentry/rollup-plugin) +- Sentry Webpack Plugin +- Sentry Vite Plugin +- Sentry Esbuild Plugin +- Sentry Rollup Plugin +- Bundler Plugin Options diff --git a/docs/platforms/javascript/common/install/bundler.mdx b/docs/platforms/javascript/common/install/bundler.mdx index 9127daac891d2..7d582a0935506 100644 --- a/docs/platforms/javascript/common/install/bundler.mdx +++ b/docs/platforms/javascript/common/install/bundler.mdx @@ -39,6 +39,8 @@ Create a file named `instrument.(js|mjs)` in the root directory of your project Add the Sentry plugin for your bundler to your build configuration. The plugin instruments your dependencies at build time, so the SDK no longer depends on `Sentry.init()` running before your other imports. + + ```javascript {tabTitle:Vite} {filename: vite.config.mjs} import { sentryVitePlugin } from "@sentry/node/vite"; @@ -71,6 +73,44 @@ await esbuild.build({ }); ``` + + + + +```javascript {tabTitle:Vite} {filename: vite.config.mjs} +import { sentryVitePlugin } from "@sentry/hono/node/vite"; + +export default { + plugins: [sentryVitePlugin()], +}; +``` + +```javascript {tabTitle:Rollup} {filename: rollup.config.mjs} +import { sentryRollupPlugin } from "@sentry/hono/node/rollup"; + +export default { + plugins: [sentryRollupPlugin()], +}; +``` + +```javascript {tabTitle:webpack} {filename: webpack.config.mjs} +import { sentryWebpackPlugin } from "@sentry/hono/node/webpack"; + +export default { + plugins: [sentryWebpackPlugin()], +}; +``` + +```javascript {tabTitle:esbuild} {filename: build.mjs} +import { sentryEsbuildPlugin } from "@sentry/hono/node/esbuild"; + +await esbuild.build({ + plugins: [sentryEsbuildPlugin()], +}); +``` + + + ## 3. Import Your Instrument File First Import `instrument.(js|mjs)` at the very top of your application's entry point, before any other imports: diff --git a/docs/platforms/javascript/common/session-replay/configuration.mdx b/docs/platforms/javascript/common/session-replay/configuration.mdx index 8fa075617cc89..4acd9271a83a0 100644 --- a/docs/platforms/javascript/common/session-replay/configuration.mdx +++ b/docs/platforms/javascript/common/session-replay/configuration.mdx @@ -125,7 +125,7 @@ replayIntegration({ }); ``` -4. (optional) To reduce bundle size, you can now Tree Shake the default included worker script. If you are using one of the [Sentry Bundler Plugins](https://github.com/getsentry/sentry-javascript-bundler-plugins) (version 2.10.0 or later): +4. (optional) To reduce bundle size, you can now Tree Shake the default included worker script. If you are using one of the Sentry Bundler Plugins (version 2.10.0 or later): ```javascript sentryPlugin({ diff --git a/docs/platforms/javascript/common/sourcemaps/uploading/angular-nx.mdx b/docs/platforms/javascript/common/sourcemaps/uploading/angular-nx.mdx index d8377ba198d7b..3b190aed99d08 100644 --- a/docs/platforms/javascript/common/sourcemaps/uploading/angular-nx.mdx +++ b/docs/platforms/javascript/common/sourcemaps/uploading/angular-nx.mdx @@ -71,21 +71,21 @@ SENTRY_AUTH_TOKEN=___ORG_AUTH_TOKEN___ Install the Sentry Webpack plugin: ```shell {tabTitle:npm} -npm install @sentry/webpack-plugin --save-dev +npm install @sentry/bundler-plugins --save-dev ``` ```shell {tabTitle:yarn} -yarn add @sentry/webpack-plugin --dev +yarn add @sentry/bundler-plugins --dev ``` ```shell {tabTitle:pnpm} -pnpm add @sentry/webpack-plugin --save-dev +pnpm add @sentry/bundler-plugins --save-dev ``` Register the Sentry webpack plugin in your `webpack.config.js`: ```javascript {filename:webpack.config.js} -const { sentryWebpackPlugin } = require("@sentry/webpack-plugin"); +const { sentryWebpackPlugin } = require("@sentry/bundler-plugins/webpack"); module.exports = { // ... other config above ... @@ -110,30 +110,30 @@ module.exports = { Generating source maps **may expose them to the public**, potentially causing your source code to be leaked. You can prevent this by configuring your server to - deny access to `.js.map` files, or by using [Sentry Webpack Plugin's - `sourcemaps.filesToDeleteAfterUpload`](https://www.npmjs.com/package/@sentry/webpack-plugin#sourcemapsfilestodeleteafterupload) + deny access to `.js.map` files, or by using Sentry Webpack Plugin's + `sourcemaps.filesToDeleteAfterUpload` option to delete source maps after they've been uploaded to Sentry. -Learn more about configuring the plugin in our [Sentry webpack plugin documentation](https://www.npmjs.com/package/@sentry/webpack-plugin). +Learn more about configuring the plugin in our Sentry webpack plugin documentation. ### esbuild Install the Sentry esbuild plugin: ```shell {tabTitle:npm} -npm install @sentry/esbuild-plugin --save-dev +npm install @sentry/bundler-plugins --save-dev ``` ```shell {tabTitle:yarn} -yarn add @sentry/esbuild-plugin --dev +yarn add @sentry/bundler-plugins --dev ``` ```shell {tabTitle:pnpm} -pnpm add @sentry/esbuild-plugin --save-dev +pnpm add @sentry/bundler-plugins --save-dev ``` -Then, follow the [official Nx documentation](https://nx.dev/nx-api/angular/executors/browser-esbuild#examples) to register the Sentry esbuild plugin (`@sentry/esbuild-plugin`) in your `project.json` file. For example: +Then, follow the [official Nx documentation](https://nx.dev/nx-api/angular/executors/browser-esbuild#examples) to register the Sentry esbuild plugin (`@sentry/bundler-plugins/esbuild`) in your `project.json` file. For example: ```json {filename:project.json} { @@ -143,7 +143,7 @@ Then, follow the [official Nx documentation](https://nx.dev/nx-api/angular/execu "options": { "plugins": [ { - "path": "@sentry/esbuild-plugin", + "path": "@sentry/bundler-plugins/esbuild", "options": { "org": "___ORG_SLUG___", "project": "___PROJECT_SLUG___", @@ -160,8 +160,8 @@ Then, follow the [official Nx documentation](https://nx.dev/nx-api/angular/execu Generating source maps **may expose them to the public**, potentially causing your source code to be leaked. You can prevent this by configuring your server to - deny access to `.js.map` files, or by using [Sentry Esbuild Plugin's - `sourcemaps.filesToDeleteAfterUpload`](https://www.npmjs.com/package/@sentry/esbuild-plugin#sourcemapsfilestodeleteafterupload) + deny access to `.js.map` files, or by using Sentry Esbuild Plugin's + `sourcemaps.filesToDeleteAfterUpload` option to delete source maps after they've been uploaded to Sentry. diff --git a/docs/platforms/javascript/common/sourcemaps/uploading/angular-webpack.mdx b/docs/platforms/javascript/common/sourcemaps/uploading/angular-webpack.mdx index 20b66cb1bd491..0d748d55e5439 100644 --- a/docs/platforms/javascript/common/sourcemaps/uploading/angular-webpack.mdx +++ b/docs/platforms/javascript/common/sourcemaps/uploading/angular-webpack.mdx @@ -21,15 +21,15 @@ Before you start configuring the source maps upload, make sure that you're [gene Install the custom webpack builder for Angular and the Sentry webpack plugin: ```shell {tabTitle:npm} -npm install @angular-builders/custom-webpack @sentry/webpack-plugin --save-dev +npm install @angular-builders/custom-webpack @sentry/bundler-plugins --save-dev ``` ```shell {tabTitle:yarn} -yarn add @angular-builders/custom-webpack @sentry/webpack-plugin --dev +yarn add @angular-builders/custom-webpack @sentry/bundler-plugins --dev ``` ```shell {tabTitle:pnpm} -pnpm add @angular-builders/custom-webpack @sentry/webpack-plugin --save-dev +pnpm add @angular-builders/custom-webpack @sentry/bundler-plugins --save-dev ``` ## Configure @@ -97,7 +97,7 @@ SENTRY_AUTH_TOKEN=___ORG_AUTH_TOKEN___ Register the Sentry Webpack plugin in your `webpack.config.js`: ```javascript {filename:webpack.config.js} -const { sentryWebpackPlugin } = require("@sentry/webpack-plugin"); +const { sentryWebpackPlugin } = require("@sentry/bundler-plugins/webpack"); module.exports = { // ... other config above ... @@ -119,7 +119,7 @@ module.exports = { }; ``` -Learn more about configuring the plugin in our [Sentry webpack plugin documentation](https://www.npmjs.com/package/@sentry/webpack-plugin). +Learn more about configuring the plugin in our Sentry webpack plugin documentation. ### 3. Upload @@ -139,7 +139,7 @@ We recommend running a production build to test your implementation. Generating source maps **may expose them to the public**, potentially causing your source code to be leaked. You can prevent this by configuring your server to - deny access to `.js.map` files, or by using [Sentry Webpack Plugin's - `sourcemaps.filesToDeleteAfterUpload`](https://www.npmjs.com/package/@sentry/webpack-plugin#sourcemapsfilestodeleteafterupload) + deny access to `.js.map` files, or by using Sentry Webpack Plugin's + `sourcemaps.filesToDeleteAfterUpload` option to delete source maps after they've been uploaded to Sentry. diff --git a/docs/platforms/javascript/common/sourcemaps/uploading/bundler-plugin-options.mdx b/docs/platforms/javascript/common/sourcemaps/uploading/bundler-plugin-options.mdx new file mode 100644 index 0000000000000..6831137f82fdd --- /dev/null +++ b/docs/platforms/javascript/common/sourcemaps/uploading/bundler-plugin-options.mdx @@ -0,0 +1,623 @@ +--- +title: Bundler Plugin Options +description: "Learn about the options you can pass to the Sentry bundler plugins for Vite, webpack, Rollup, and esbuild." +customCanonicalTag: "/platforms/javascript/sourcemaps/uploading/bundler-plugin-options/" +sidebar_order: 20 +keywords: + [ + "bundler plugin", + "vite", + "webpack", + "rollup", + "esbuild", + "sourcemaps", + "source maps", + "release", + "options", + ] +--- + +The Sentry bundler plugins for Vite, webpack, Rollup, and esbuild all accept the options on this page. + + + +Import the plugins from the `/vite`, `/webpack`, `/rollup`, or `/esbuild` subpath of your Sentry SDK package, . + + + + + +Import the plugins from `@sentry/hono/node/vite`, `@sentry/hono/node/webpack`, `@sentry/hono/node/rollup`, or `@sentry/hono/node/esbuild`. + + + + + +Import the plugins from `@sentry/bundler-plugins/vite`, `@sentry/bundler-plugins/webpack`, `@sentry/bundler-plugins/rollup`, or `@sentry/bundler-plugins/esbuild`. + + + +```javascript {filename:vite.config.js} +sentryVitePlugin({ + org: "___ORG_SLUG___", + project: "___PROJECT_SLUG___", + authToken: process.env.SENTRY_AUTH_TOKEN, + sourcemaps: { + filesToDeleteAfterUpload: ["./dist/**/*.map"], + }, +}); +``` + +## Available Options + + + +## Core Options + + + +The slug of the Sentry organization associated with the app. + +This value can also be specified via the `SENTRY_ORG` environment variable. + + + + + +The slug of the Sentry project associated with the app. You can also provide an array of project slugs to upload source maps to multiple projects with the same release. + +This value can also be specified via the `SENTRY_PROJECT` environment variable. To specify multiple projects via the environment variable, separate them with commas: `SENTRY_PROJECT=project1,project2,project3`. + +```javascript +sentryVitePlugin({ + org: process.env.SENTRY_ORG, + project: ["frontend-team-a", "frontend-team-b", "frontend-team-c"], + authToken: process.env.SENTRY_AUTH_TOKEN, +}); +``` + + + + + +The authentication token to use for all communication with Sentry. +Can be obtained from https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/. + +This value can also be specified via the `SENTRY_AUTH_TOKEN` environment variable. + +Check out the docs on [organization tokens](/account/auth-tokens/#organization-tokens). + + + + + +The base URL of your Sentry instance. Use this if you are using a self-hosted or Sentry instance other than sentry.io. + +This value can also be set via the `SENTRY_URL` environment variable. + +The default value is correct for SaaS customers. + + + + + +Additional headers to send with every outgoing request to Sentry. + + + + + +Enable debug information logs during build-time. Enabling this will give you, for example, logs about source maps. This option also propagates the debug flag to the Sentry CLI by setting the `SENTRY_LOG_LEVEL` environment variable to `"debug"` if it's not already set. If you have explicitly set `SENTRY_LOG_LEVEL`, this option will be ignored. + + + + + +Suppresses all build logs (all log levels, including errors). + + + + + +When an error occurs during release creation or sourcemaps upload, the plugin will call this function. + +By default, the plugin will simply throw an error, thereby stopping the bundling process. If an `errorHandler` callback is provided, compilation will continue, unless an error is thrown in the provided callback. + +To allow compilation to continue but still emit a warning, set this option to the following: + +```javascript +errorHandler: (err) => { + console.warn(err); +}; +``` + + + + + +If this flag is `true`, internal plugin errors and performance data will be sent to Sentry. It will not collect any sensitive or user-specific data. + +At Sentry, we like to use Sentry ourselves to deliver faster and more stable products. We're very careful of what we're sending. We won't collect anything other than error and high-level performance data. We will never collect your code or any details of the projects in which you're using this plugin. + + + + + +Completely disables all functionality of the plugin. + + + +## Source Maps Options + +Options related to source maps upload and processing. + + + +A glob or an array of globs that specify the build artifacts and source maps that will be uploaded to Sentry. + +The globbing patterns must follow the implementation of the [`glob`](https://www.npmjs.com/package/glob#glob-primer) package. + +If this option is not specified, the plugin will try to upload all JavaScript files and source map files that are created during build. + +Use the `debug` option to print information about which files end up being uploaded. + + + + + +A glob or an array of globs that specifies which build artifacts should not be uploaded to Sentry. + +The globbing patterns must follow the implementation of the [`glob`](https://www.npmjs.com/package/glob#glob-primer) package. + +Use the `debug` option to print information about which files end up being uploaded. + + + + + +Hook to rewrite the `sources` field inside the source map before being uploaded to Sentry. Does not modify the actual source map. Effectively, this modifies how files inside the stacktrace will show up in Sentry. + +The `context.mapDir` parameter provides the directory path of the source map file, which is useful for resolving relative source paths (e.g. `path.resolve(context.mapDir, source)`). + +Defaults to making all sources relative to `process.cwd()` while building. + + + + + +Hook to customize source map file resolution. + +The hook is called with the absolute path of the build artifact and the value of the `//# sourceMappingURL=` comment, if present. The hook should then return an absolute path (or a promise that resolves to one) indicating where to find the artifact's corresponding source map file. If no path is returned or the returned path doesn't exist, the standard source map resolution process will be used. + +The standard process first tries to resolve based on the `//# sourceMappingURL=` value (it supports `file://` urls and absolute/relative paths). If that path doesn't exist, it then looks for a file named `${artifactName}.map` in the same directory as the artifact. + +Note: This is mostly helpful for complex builds with custom source map generation. For example, if you put source maps into a separate directory and rewrite the `//# sourceMappingURL=` comment to something other than a relative directory, Sentry will be unable to locate the source maps for a given build artifact. This hook allows you to implement the resolution process yourself. + +Use the `debug` option to print information about source map resolution. + + + + + +A glob, an array of globs or a promise resolving a glob or array of globs that specifies the build artifacts that should be deleted after the artifact upload to Sentry has been completed. + +Note: If you pass in a Promise that resolves to a string or array, the plugin will await the Promise and use the resolved value globs. This is useful if you need to dynamically determine the files to delete. Some higher-level Sentry SDKs or options use this feature (e.g., SvelteKit). + +The globbing patterns must follow the implementation of the [`glob`](https://www.npmjs.com/package/glob#glob-primer) package. + +Use the `debug` option to print information about which files end up being deleted. + + + + + +If this flag is `true`, any functionality related to source maps will be disabled. + +If set to `"disable-upload"`, the plugin will not upload source maps to Sentry, but will still inject debug IDs into the build artifacts: the bundles receive the runtime debug ID snippet and a `//# debugId=` comment, and the emitted source maps receive the matching `debug_id` field. This happens inside the bundler's build pipeline, so hashes computed by later build steps (for example, for subresource integrity) include the debug IDs. + +This is useful if you want to manually upload source maps to Sentry at a later point in time, for example with `sentry-cli sourcemaps upload`. The artifacts already carry their debug IDs, so no `inject` step is needed. + + + +## Release Options + +Options related to managing the Sentry releases for a build. Learn more in [Releases](/product/releases/). + + + +Unique identifier for the release you want to create. + +This value can also be specified via the `SENTRY_RELEASE` environment variable. + +Defaults to automatically detecting a value for your environment. This includes values for Cordova, Heroku, AWS CodeBuild, CircleCI, Xcode, and Gradle, and otherwise uses the git `HEAD`'s commit SHA (the latter requires access to git CLI and for the root directory to be a valid repository). + +If no `name` is provided and the plugin can't automatically detect one, no release will be created. + + + + + +Whether the plugin should inject release information into the build for the SDK to pick it up when sending events. (recommended) + + + + + +Whether the plugin should create a release on Sentry during the build. + +Note that a release may still appear in Sentry even if this value is `false` because any Sentry event that has a release value attached will automatically create a release (for example, via the `inject` option). + + + + + +Whether to automatically finalize the release. The release is finalized by adding an end timestamp after the build ends. + + + + + +Unique distribution identifier for the release. Used to further segment the release. + +Usually your build number. + + + + + +Version control system (VCS) remote name. + +This value can also be specified via the `SENTRY_VSC_REMOTE` environment variable. + + + + + +Configuration for associating the release with its commits in Sentry. + +Set to `false` to disable commit association. + + + + + +The commit before the beginning of this release (in other words, the last commit of the previous release). + +Defaults to the last commit of the previous release in Sentry. + +If there was no previous release, the last 10 commits will be used. + + + + + +If the flag is set to `true` and the previous release commit was not found in the repository, the plugin creates a release with the default commits count instead of failing the command. + + + + + +If this flag is set, the setCommits step will not fail and just exit silently if no new commits for a given release have been found. + + + + + +Automatically sets `commit` and `previousCommit`. Sets `commit` to `HEAD` and `previousCommit` as described in the option's documentation. + +If you set this to `true`, manually specified `commit` and `previousCommit` options will be overridden. It is best to not specify them at all if you set this option to `true`. + + + + + +The full repo name as defined in Sentry. + +Required if the `auto` option is not set to `true`. + + + + + +The current (last) commit in the release. + +Required if the `auto` option is not set to `true`. + + + + + +Configuration for adding deployment information to the release in Sentry. + +Set to `false` to disable automatic deployment detection and creation (for example, when deploying on Vercel). + + + + + +Environment for this release. Values that make sense here would be `production` or `staging`. + + + + + +Deployment start time in Unix timestamp (in seconds) or ISO 8601 format. + + + + + +Deployment finish time in Unix timestamp (in seconds) or ISO 8601 format. + + + + + +Deployment duration (in seconds). Can be used instead of started and finished. + + + + + +Human readable name for the deployment. + + + + + +URL that points to the deployment. + + + + + +Legacy method of uploading source maps. (not recommended unless necessary) +One or more paths that should be scanned recursively for sources. + +Each path can be given as a string or an object with more specific options. + +The modern version of doing source maps upload is more robust and way easier to get working but has to inject a very small snippet of JavaScript into your output bundles. +In situations where this leads to problems (e.g subresource integrity) you can use this option as a fallback. + +Please note that this option will not interact with any settings provided in the `sourcemaps` option. Using `uploadLegacySourcemaps` is a completely separate upload mechanism we provide for backwards-compatibility. + +The `IncludeEntry` type looks as follows: + +```typescript +type IncludeEntry = { + /** + * One or more paths to scan for files to upload. + */ + paths: string[]; + + /** + * One or more paths to ignore during upload. + * Overrides entries in ignoreFile file. + * + * Defaults to `['node_modules']` if neither `ignoreFile` nor `ignore` is set. + */ + ignore?: string | string[]; + + /** + * Path to a file containing list of files/directories to ignore. + * + * Can point to `.gitignore` or anything with the same format. + */ + ignoreFile?: string; + + /** + * Array of file extensions of files to be collected for the file upload. + * + * By default the following file extensions are processed: js, map, jsbundle and bundle. + */ + ext?: string[]; + + /** + * URL prefix to add to the beginning of all filenames. + * Defaults to '~/' but you might want to set this to the full URL. + * + * This is also useful if your files are stored in a sub folder. eg: url-prefix '~/static/js'. + */ + urlPrefix?: string; + + /** + * URL suffix to add to the end of all filenames. + * Useful for appending query parameters. + */ + urlSuffix?: string; + + /** + * When paired with the `rewrite` option, this will remove a prefix from filename references inside of + * sourcemaps. For instance you can use this to remove a path that is build machine specific. + * Note that this will NOT change the names of uploaded files. + */ + stripPrefix?: string[]; + + /** + * When paired with the `rewrite` option, this will add `~` to the `stripPrefix` array. + * + * Defaults to `false`. + */ + stripCommonPrefix?: boolean; + + /** + * Determines whether sentry-cli should attempt to link minified files with their corresponding maps. + * By default, it will match files and maps based on name, and add a Sourcemap header to each minified file + * for which it finds a map. Can be disabled if all minified files contain sourceMappingURL. + * + * Defaults to true. + */ + sourceMapReference?: boolean; + + /** + * Enables rewriting of matching source maps so that indexed maps are flattened and missing sources + * are inlined if possible. + * + * Defaults to true + */ + rewrite?: boolean; + + /** + * When `true`, attempts source map validation before upload if rewriting is not enabled. + * It will spot a variety of issues with source maps and cancel the upload if any are found. + * + * Defaults to `false` as this can cause false positives. + */ + validate?: boolean; +}; +``` + + + +## Bundle Size Optimizations + +Options for bundle size optimizations by excluding certain features. + + + +Exclude debug statements from the bundle, thus disabling features like the SDK's `debug` option. + +If set to `true`, the plugin will attempt to tree-shake (remove) any debugging code within the Sentry SDK during the build. +Note that the success of this depends on tree-shaking being enabled in your build tooling. + + + + + +Exclude tracing functionality from the bundle, thus disabling features like performance monitoring. + +If set to `true`, the plugin will attempt to tree-shake (remove) code within the Sentry SDK that is related to tracing and performance monitoring. +Note that the success of this depends on tree-shaking being enabled in your build tooling. + +**Notice:** Do not enable this when you're using any performance monitoring-related SDK features (e.g. `Sentry.startSpan()`). + + + + + +Exclude the Node SDK's runtime diagnostics-channel injection from the bundle. + +If set to `true`, the plugin will attempt to tree-shake (remove) code that installs the Node SDK's runtime module hooks (e.g. for Express instrumentation) at load time. Note that the success of this depends on tree-shaking being enabled in your build tooling. + +Only enable this when the diagnostics channels are injected at build time (via the bundler plugin) or when you otherwise do not rely on the runtime channel injection. This is equivalent to setting `enableRuntimeChannelInjection: false` in the SDK's `init` options. + + + + + +Exclude Replay Shadow DOM functionality from the bundle. + +If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay Shadow DOM recording functionality. +Note that the success of this depends on tree-shaking being enabled in your build tooling. + +This option is safe to be used when you do not want to capture any Shadow DOM activity via Sentry Session Replay. + + + + + +Exclude Replay iFrame functionality from the bundle. + +If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay `iframe` recording functionality. +Note that the success of this depends on tree-shaking being enabled in your build tooling. + +You can safely do this when you do not want to capture any `iframe` activity via Sentry Session Replay. + + + + + +Exclude Replay worker functionality from the bundle. + +If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay's Compression Web Worker. +Note that the success of this depends on tree-shaking being enabled in your build tooling. + +**Notice:** You should only use this option if you manually host a compression worker and configure it in your Sentry Session Replay integration config via the `workerUrl` option. + + + +## React Component Annotation + + + +Use the React component annotation feature with caution. The option will pass additional properties to your React components which may lead to errors if libraries or your own code iterate through component props without checking for the additional Sentry props. + + + +Options related to React component name annotations. +Disabled by default, unless a value is set for this option. +When enabled, your app's DOM will automatically be annotated during build-time with their respective component names. +This will unlock the capability to search for Replays in Sentry by component name, as well as see component names in breadcrumbs and performance monitoring. + +The esbuild plugin doesn't support these options. + + + +Whether the component name annotate plugin should be enabled or not. + + + + + +A list of strings representing the names of components to ignore. The plugin will not apply `data-sentry` annotations on the DOM element for these components. + + + + + +An experimental component annotation injection mode that injects annotations into HTML rather than React components. + + + +## Other Options + + + +Metadata that should be associated with the built application. + +The metadata is serialized and can be looked up at runtime from within the SDK (for example in the `beforeSend`, event processors, or the transport), allowing for custom event filtering logic or routing of events. + +Metadata can either be passed directly or alternatively a callback can be provided that will be called with the following parameters: + +- `org`: The organization slug. +- `project`: The project slug (when multiple projects are configured, this is the first project). +- `projects`: An array of all project slugs (available when multiple projects are configured). +- `release`: The release name. + + + + + +A key which will be embedded in all the bundled files. The SDK will be able to use the key to apply filtering rules, for example using the `thirdPartyErrorFilterIntegration`. + + + + + +Options that are considered experimental and subject to change. This option does not follow semantic versioning and may change in any release. + + + + + +If set to true, the plugin will inject an additional `SENTRY_BUILD_INFO` variable. This contains information about the build, e.g. dependencies, node version and other useful data. + + + +## Configuration File + +As an additional configuration method, the Sentry bundler plugins will pick up environment variables configured inside a `.env.sentry-build-plugin` file located in the current working directory when building your app. + + + +## Node.js Options + +These options are only available in the plugins from your Sentry SDK package. `@sentry/bundler-plugins` doesn't support them. + + + +Automatic instrumentation of server-side dependencies at build time. Set to `false` to turn it off. + + + + diff --git a/docs/platforms/javascript/common/sourcemaps/uploading/esbuild.mdx b/docs/platforms/javascript/common/sourcemaps/uploading/esbuild.mdx index 494b76807ea67..7e1bf48e70368 100644 --- a/docs/platforms/javascript/common/sourcemaps/uploading/esbuild.mdx +++ b/docs/platforms/javascript/common/sourcemaps/uploading/esbuild.mdx @@ -43,20 +43,30 @@ If you want to configure source map uploading with esbuild manually, follow the ## Manual Setup + + Install the Sentry esbuild plugin: ```bash {tabTitle:npm} -npm install @sentry/esbuild-plugin --save-dev +npm install @sentry/bundler-plugins --save-dev ``` ```bash {tabTitle:yarn} -yarn add @sentry/esbuild-plugin --dev +yarn add @sentry/bundler-plugins --dev ``` ```bash {tabTitle:pnpm} -pnpm add @sentry/esbuild-plugin --save-dev +pnpm add @sentry/bundler-plugins --save-dev ``` + + + + +The Sentry esbuild plugin is part of your Sentry SDK package. You don't need to install another package. + + + ### Configure To upload source maps you have to configure an [Organization Token](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/). @@ -66,7 +76,7 @@ Alternatively, you can also use a [Personal Token](https://sentry.io/orgredirect Auth tokens can be passed to the plugin explicitly with the `authToken` option, with a `SENTRY_AUTH_TOKEN` environment variable, or with an `.env.sentry-build-plugin` file (don't forget to add it to your `.gitignore` file, as this is sensitive data) in the working directory when building your project. We recommend you add the auth token to your CI/CD environment as an environment variable. -Learn more about configuring the plugin in our [Sentry esbuild Plugin documentation](https://www.npmjs.com/package/@sentry/esbuild-plugin). +Learn more about configuring the plugin in our Sentry esbuild Plugin documentation. @@ -76,8 +86,36 @@ SENTRY_AUTH_TOKEN=___ORG_AUTH_TOKEN___ Example: + + +```javascript {filename:esbuild.config.js} +const { sentryEsbuildPlugin } = require("@sentry/bundler-plugins/esbuild"); + +require("esbuild").build({ + sourcemap: "hidden", // Source map generation must be turned on ("hidden", true, etc.) + plugins: [ + // Put the Sentry esbuild plugin after all other plugins + sentryEsbuildPlugin({ + org: "___ORG_SLUG___", + project: "___PROJECT_SLUG___", + authToken: process.env.SENTRY_AUTH_TOKEN, + + sourcemaps: { + // As you're enabling client source maps, you probably want to delete them after they're uploaded to Sentry. + // Set the appropriate glob pattern for your output folder - some glob examples below: + filesToDeleteAfterUpload: ["./**/*.map", ".*/**/public/**/*.map", "./dist/**/client/**/*.map"] + } + }), + ], +}); +``` + + + + + ```javascript {filename:esbuild.config.js} -const { sentryEsbuildPlugin } = require("@sentry/esbuild-plugin"); +const { sentryEsbuildPlugin } = require("___SDK_PACKAGE___/esbuild"); require("esbuild").build({ sourcemap: "hidden", // Source map generation must be turned on ("hidden", true, etc.) @@ -98,11 +136,39 @@ require("esbuild").build({ }); ``` + + + + +```javascript {filename:esbuild.config.js} +const { sentryEsbuildPlugin } = require("@sentry/hono/node/esbuild"); + +require("esbuild").build({ + sourcemap: "hidden", // Source map generation must be turned on ("hidden", true, etc.) + plugins: [ + // Put the Sentry esbuild plugin after all other plugins + sentryEsbuildPlugin({ + org: "___ORG_SLUG___", + project: "___PROJECT_SLUG___", + authToken: process.env.SENTRY_AUTH_TOKEN, + + sourcemaps: { + // As you're enabling client source maps, you probably want to delete them after they're uploaded to Sentry. + // Set the appropriate glob pattern for your output folder - some glob examples below: + filesToDeleteAfterUpload: ["./**/*.map", ".*/**/public/**/*.map", "./dist/**/client/**/*.map"] + } + }), + ], +}); +``` + + + Generating source maps **may expose them to the public**, potentially causing your source code to be leaked. You can prevent this by configuring your server to - deny access to `.js.map` files, or by using [Sentry Esbuild Plugin's - `sourcemaps.filesToDeleteAfterUpload`](https://www.npmjs.com/package/@sentry/esbuild-plugin#sourcemapsfilestodeleteafterupload) + deny access to `.js.map` files, or by using Sentry Esbuild Plugin's + `sourcemaps.filesToDeleteAfterUpload` option to delete source maps after they've been uploaded to Sentry. diff --git a/docs/platforms/javascript/common/sourcemaps/uploading/rollup.mdx b/docs/platforms/javascript/common/sourcemaps/uploading/rollup.mdx index 29b44acd07dd1..0dddb73697d35 100644 --- a/docs/platforms/javascript/common/sourcemaps/uploading/rollup.mdx +++ b/docs/platforms/javascript/common/sourcemaps/uploading/rollup.mdx @@ -23,20 +23,30 @@ If you'd rather manually configure source map uploading with the CLI, follow the ## Manual Setup + + Install the Sentry Rollup plugin: ```bash {tabTitle:npm} -npm install @sentry/rollup-plugin --save-dev +npm install @sentry/bundler-plugins --save-dev ``` ```bash {tabTitle:yarn} -yarn add @sentry/rollup-plugin --dev +yarn add @sentry/bundler-plugins --dev ``` ```bash {tabTitle:pnpm} -pnpm add @sentry/rollup-plugin --save-dev +pnpm add @sentry/bundler-plugins --save-dev ``` + + + + +The Sentry Rollup plugin is part of your Sentry SDK package. You don't need to install another package. + + + ### Configuration To upload source maps you have to configure an [Organization Token](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/). @@ -46,7 +56,7 @@ Alternatively, you can also use a [Personal Token](https://sentry.io/orgredirect Auth tokens can be passed to the plugin explicitly with the `authToken` option, with a `SENTRY_AUTH_TOKEN` environment variable, or with an `.env.sentry-build-plugin` file (don't forget to add it to your `.gitignore` file, as this is sensitive data) in the working directory when building your project. We recommend you add the auth token to your CI/CD environment as an environment variable. -Learn more about configuring the plugin in our [Sentry Rollup Plugin documentation](https://www.npmjs.com/package/@sentry/rollup-plugin). +Learn more about configuring the plugin in our Sentry Rollup Plugin documentation. @@ -56,8 +66,10 @@ SENTRY_AUTH_TOKEN=___ORG_AUTH_TOKEN___ Example: + + ```javascript {filename:rollup.config.js} -import { sentryRollupPlugin } from "@sentry/rollup-plugin"; +import { sentryRollupPlugin } from "@sentry/bundler-plugins/rollup"; export default { output: { @@ -79,10 +91,66 @@ export default { }; ``` + + + + +```javascript {filename:rollup.config.js} +import { sentryRollupPlugin } from "___SDK_PACKAGE___/rollup"; + +export default { + output: { + sourcemap: "hidden", // Source map generation must be turned on ("hidden", true, etc.) + }, + plugins: [ + // Put the Sentry rollup plugin after all other plugins + sentryRollupPlugin({ + org: "___ORG_SLUG___", + project: "___PROJECT_SLUG___", + authToken: process.env.SENTRY_AUTH_TOKEN, + sourcemaps: { + // As you're enabling client source maps, you probably want to delete them after they're uploaded to Sentry. + // Set the appropriate glob pattern for your output folder - some glob examples below: + filesToDeleteAfterUpload: ["./**/*.map", ".*/**/public/**/*.map", "./dist/**/client/**/*.map"] + } + }), + ], +}; +``` + + + + + +```javascript {filename:rollup.config.js} +import { sentryRollupPlugin } from "@sentry/hono/node/rollup"; + +export default { + output: { + sourcemap: "hidden", // Source map generation must be turned on ("hidden", true, etc.) + }, + plugins: [ + // Put the Sentry rollup plugin after all other plugins + sentryRollupPlugin({ + org: "___ORG_SLUG___", + project: "___PROJECT_SLUG___", + authToken: process.env.SENTRY_AUTH_TOKEN, + sourcemaps: { + // As you're enabling client source maps, you probably want to delete them after they're uploaded to Sentry. + // Set the appropriate glob pattern for your output folder - some glob examples below: + filesToDeleteAfterUpload: ["./**/*.map", ".*/**/public/**/*.map", "./dist/**/client/**/*.map"] + } + }), + ], +}; +``` + + + Generating source maps **may expose them to the public**, potentially causing your source code to be leaked. You can prevent this by configuring your server to - deny access to `.js.map` files, or by using [Sentry Rollup Plugin's - `sourcemaps.filesToDeleteAfterUpload`](https://www.npmjs.com/package/@sentry/rollup-plugin#sourcemapsfilestodeleteafterupload) + deny access to `.js.map` files, or by using Sentry Rollup Plugin's + `sourcemaps.filesToDeleteAfterUpload` option to delete source maps after they've been uploaded to Sentry. diff --git a/docs/platforms/javascript/common/sourcemaps/uploading/vite.mdx b/docs/platforms/javascript/common/sourcemaps/uploading/vite.mdx index 7440da1fd816d..07270e499979d 100644 --- a/docs/platforms/javascript/common/sourcemaps/uploading/vite.mdx +++ b/docs/platforms/javascript/common/sourcemaps/uploading/vite.mdx @@ -23,20 +23,30 @@ If you'd rather configure source map uploading with Vite manually, follow the st ## Manual Setup + + Install the Sentry Vite plugin: ```bash {tabTitle:npm} -npm install @sentry/vite-plugin --save-dev +npm install @sentry/bundler-plugins --save-dev ``` ```bash {tabTitle:yarn} -yarn add @sentry/vite-plugin --dev +yarn add @sentry/bundler-plugins --dev ``` ```bash {tabTitle:pnpm} -pnpm add @sentry/vite-plugin --save-dev +pnpm add @sentry/bundler-plugins --save-dev ``` + + + + +The Sentry Vite plugin is part of your Sentry SDK package. You don't need to install another package. + + + ### Configuration To upload source maps you have to configure an [Organization Token](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/). @@ -46,7 +56,7 @@ Alternatively, you can also use a [Personal Token](https://sentry.io/orgredirect Auth tokens can be passed to the plugin explicitly with the `authToken` option, with a `SENTRY_AUTH_TOKEN` environment variable, or with an `.env.sentry-build-plugin` file (don't forget to add it to your `.gitignore` file, as this is sensitive data) in the working directory when building your project. We recommend you add the auth token to your CI/CD environment as an environment variable. -Learn more about configuring the plugin in our [Sentry Vite Plugin documentation](https://www.npmjs.com/package/@sentry/vite-plugin). +Learn more about configuring the plugin in our Sentry Vite Plugin documentation. @@ -64,9 +74,11 @@ Place the Sentry Vite plugin **after all other plugins** in your `plugins` array Example: + + ```javascript {filename:vite.config.js} import { defineConfig } from "vite"; -import { sentryVitePlugin } from "@sentry/vite-plugin"; +import { sentryVitePlugin } from "@sentry/bundler-plugins/vite"; export default defineConfig({ build: { @@ -89,11 +101,71 @@ export default defineConfig({ }); ``` + + + + +```javascript {filename:vite.config.js} +import { defineConfig } from "vite"; +import { sentryVitePlugin } from "___SDK_PACKAGE___/vite"; + +export default defineConfig({ + build: { + sourcemap: "hidden", // Source map generation must be turned on ("hidden", true, etc.) + }, + plugins: [ + // Put the Sentry Vite plugin after all other plugins + sentryVitePlugin({ + org: "___ORG_SLUG___", + project: "___PROJECT_SLUG___", + authToken: process.env.SENTRY_AUTH_TOKEN, + + sourcemaps: { + // As you're enabling client source maps, you probably want to delete them after they're uploaded to Sentry. + // Set the appropriate glob pattern for your output folder - some glob examples below: + filesToDeleteAfterUpload: ["./**/*.map", ".*/**/public/**/*.map", "./dist/**/client/**/*.map"] + } + }), + ], +}); +``` + + + + + +```javascript {filename:vite.config.js} +import { defineConfig } from "vite"; +import { sentryVitePlugin } from "@sentry/hono/node/vite"; + +export default defineConfig({ + build: { + sourcemap: "hidden", // Source map generation must be turned on ("hidden", true, etc.) + }, + plugins: [ + // Put the Sentry Vite plugin after all other plugins + sentryVitePlugin({ + org: "___ORG_SLUG___", + project: "___PROJECT_SLUG___", + authToken: process.env.SENTRY_AUTH_TOKEN, + + sourcemaps: { + // As you're enabling client source maps, you probably want to delete them after they're uploaded to Sentry. + // Set the appropriate glob pattern for your output folder - some glob examples below: + filesToDeleteAfterUpload: ["./**/*.map", ".*/**/public/**/*.map", "./dist/**/client/**/*.map"] + } + }), + ], +}); +``` + + + Generating source maps **may expose them to the public**, potentially causing your source code to be leaked. You can prevent this by configuring your server to - deny access to `.js.map` files, or by using [Sentry Vite Plugin's - `sourcemaps.filesToDeleteAfterUpload`](https://www.npmjs.com/package/@sentry/vite-plugin#sourcemapsfilestodeleteafterupload) + deny access to `.js.map` files, or by using Sentry Vite Plugin's + `sourcemaps.filesToDeleteAfterUpload` option to delete source maps after they've been uploaded to Sentry. diff --git a/docs/platforms/javascript/common/sourcemaps/uploading/webpack.mdx b/docs/platforms/javascript/common/sourcemaps/uploading/webpack.mdx index 645a7934a727b..c693ed0ac7bb9 100644 --- a/docs/platforms/javascript/common/sourcemaps/uploading/webpack.mdx +++ b/docs/platforms/javascript/common/sourcemaps/uploading/webpack.mdx @@ -22,20 +22,30 @@ If you'd rather configure source map uploading with webpack manually, follow the ## Manual Setup + + Install the Sentry webpack plugin: ```bash {tabTitle:npm} -npm install @sentry/webpack-plugin --save-dev +npm install @sentry/bundler-plugins --save-dev ``` ```bash {tabTitle:yarn} -yarn add @sentry/webpack-plugin --dev +yarn add @sentry/bundler-plugins --dev ``` ```bash {tabTitle:pnpm} -pnpm add @sentry/webpack-plugin --save-dev +pnpm add @sentry/bundler-plugins --save-dev ``` + + + + +The Sentry webpack plugin is part of your Sentry SDK package. You don't need to install another package. + + + ### Configuration To upload source maps you have to configure an [Organization Token](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/). @@ -45,7 +55,7 @@ Alternatively, you can also use a [Personal Token](https://sentry.io/orgredirect Auth tokens can be passed to the plugin explicitly with the `authToken` option, with a `SENTRY_AUTH_TOKEN` environment variable, or with an `.env.sentry-build-plugin` file (don't forget to add it to your `.gitignore` file, as this is sensitive data) in the working directory when building your project. We recommend you add the auth token to your CI/CD environment as an environment variable. -Learn more about configuring the plugin in our [Sentry webpack plugin documentation](https://www.npmjs.com/package/@sentry/webpack-plugin). +Learn more about configuring the plugin in our Sentry webpack plugin documentation. @@ -57,8 +67,64 @@ SENTRY_AUTH_TOKEN=___ORG_AUTH_TOKEN___ And the following webpack config: + + +```javascript {filename:webpack.config.js} +const { sentryWebpackPlugin } = require("@sentry/bundler-plugins/webpack"); + +module.exports = { + // ... other config above ... + + devtool: "hidden-source-map", // Source map generation must be turned on ("hidden-source-map", "source-map", etc.) + plugins: [ + sentryWebpackPlugin({ + org: "___ORG_SLUG___", + project: "___PROJECT_SLUG___", + authToken: process.env.SENTRY_AUTH_TOKEN, + + sourcemaps: { + // As you're enabling client source maps, you probably want to delete them after they're uploaded to Sentry. + // Set the appropriate glob pattern for your output folder - some glob examples below: + filesToDeleteAfterUpload: ["./**/*.map", ".*/**/public/**/*.map", "./dist/**/client/**/*.map"] + } + }), + ], +}; +``` + + + + + +```javascript {filename:webpack.config.js} +const { sentryWebpackPlugin } = require("___SDK_PACKAGE___/webpack"); + +module.exports = { + // ... other config above ... + + devtool: "hidden-source-map", // Source map generation must be turned on ("hidden-source-map", "source-map", etc.) + plugins: [ + sentryWebpackPlugin({ + org: "___ORG_SLUG___", + project: "___PROJECT_SLUG___", + authToken: process.env.SENTRY_AUTH_TOKEN, + + sourcemaps: { + // As you're enabling client source maps, you probably want to delete them after they're uploaded to Sentry. + // Set the appropriate glob pattern for your output folder - some glob examples below: + filesToDeleteAfterUpload: ["./**/*.map", ".*/**/public/**/*.map", "./dist/**/client/**/*.map"] + } + }), + ], +}; +``` + + + + + ```javascript {filename:webpack.config.js} -const { sentryWebpackPlugin } = require("@sentry/webpack-plugin"); +const { sentryWebpackPlugin } = require("@sentry/hono/node/webpack"); module.exports = { // ... other config above ... @@ -82,12 +148,14 @@ module.exports = { + + Add the following to your `gatsby-node.js` file: ```javascript {filename:gatsby-node.js} -const { sentryWebpackPlugin } = require("@sentry/webpack-plugin"); +const { sentryWebpackPlugin } = require("@sentry/bundler-plugins/webpack"); exports.onCreateWebpackConfig = ({ actions }) => { actions.setWebpackConfig({ @@ -113,8 +181,8 @@ exports.onCreateWebpackConfig = ({ actions }) => { Generating source maps **may expose them to the public**, potentially causing your source code to be leaked. You can prevent this by configuring your server to - deny access to `.js.map` files, or by using [Sentry Webpack Plugin's - `sourcemaps.filesToDeleteAfterUpload`](https://www.npmjs.com/package/@sentry/webpack-plugin#sourcemapsfilestodeleteafterupload) + deny access to `.js.map` files, or by using Sentry Webpack Plugin's + `sourcemaps.filesToDeleteAfterUpload` option to delete source maps after they've been uploaded to Sentry. diff --git a/docs/platforms/javascript/guides/cordova/configuration/tree-shaking.mdx b/docs/platforms/javascript/guides/cordova/configuration/tree-shaking.mdx index b12e6692e1ad6..4302ac3884a28 100644 --- a/docs/platforms/javascript/guides/cordova/configuration/tree-shaking.mdx +++ b/docs/platforms/javascript/guides/cordova/configuration/tree-shaking.mdx @@ -31,7 +31,7 @@ _This configuration is available starting with v2.9.0 of the bundler plugins._ If you're using one of our bundler plugins, you can use the `bundleSizeOptimizations` configuration option to tree shake optional code: ```javascript -// For example, the @sentry/webpack-plugin passed to the webpack config +// For example, the @sentry/bundler-plugins/webpack passed to the webpack config sentryPlugin({ // other config bundleSizeOptimizations: { @@ -48,10 +48,11 @@ sentryPlugin({ For more details, see the documentation for the specific bundler plugin you're using: -- [Sentry Webpack Plugin](https://www.npmjs.com/package/@sentry/webpack-plugin) -- [Sentry Vite Plugin](https://www.npmjs.com/package/@sentry/vite-plugin) -- [Sentry Esbuild Plugin](https://www.npmjs.com/package/@sentry/esbuild-plugin) -- [Sentry Rollup Plugin](https://www.npmjs.com/package/@sentry/rollup-plugin) +- Sentry Webpack Plugin +- Sentry Vite Plugin +- Sentry Esbuild Plugin +- Sentry Rollup Plugin +- [Bundler Plugin Options](/platforms/javascript/sourcemaps/uploading/bundler-plugin-options/#bundle-size-optimizations) ### Manual Tree Shaking diff --git a/docs/platforms/javascript/guides/cordova/sourcemaps/uploading/esbuild.mdx b/docs/platforms/javascript/guides/cordova/sourcemaps/uploading/esbuild.mdx index a55d1834b9f28..dead3b14915d2 100644 --- a/docs/platforms/javascript/guides/cordova/sourcemaps/uploading/esbuild.mdx +++ b/docs/platforms/javascript/guides/cordova/sourcemaps/uploading/esbuild.mdx @@ -25,15 +25,15 @@ If you want to configure source map uploading with esbuild manually, follow the Install the Sentry esbuild plugin: ```bash {tabTitle:npm} -npm install @sentry/esbuild-plugin --save-dev +npm install @sentry/bundler-plugins --save-dev ``` ```bash {tabTitle:yarn} -yarn add @sentry/esbuild-plugin --dev +yarn add @sentry/bundler-plugins --dev ``` ```bash {tabTitle:pnpm} -pnpm add @sentry/esbuild-plugin --save-dev +pnpm add @sentry/bundler-plugins --save-dev ``` ### Configure @@ -45,7 +45,7 @@ Alternatively, you can also use a [Personal Token](https://sentry.io/orgredirect Auth tokens can be passed to the plugin explicitly with the `authToken` option, with a `SENTRY_AUTH_TOKEN` environment variable, or with an `.env.sentry-build-plugin` file (don't forget to add it to your `.gitignore` file, as this is sensitive data) in the working directory when building your project. We recommend you add the auth token to your CI/CD environment as an environment variable. -Learn more about configuring the plugin in our [Sentry esbuild Plugin documentation](https://www.npmjs.com/package/@sentry/esbuild-plugin). +Learn more about configuring the plugin in our [Sentry esbuild Plugin documentation](/platforms/javascript/sourcemaps/uploading/bundler-plugin-options/). @@ -56,7 +56,7 @@ SENTRY_AUTH_TOKEN=___ORG_AUTH_TOKEN___ Example: ```javascript {filename:esbuild.config.js} -const { sentryEsbuildPlugin } = require("@sentry/esbuild-plugin"); +const { sentryEsbuildPlugin } = require("@sentry/bundler-plugins/esbuild"); require("esbuild").build({ sourcemap: "hidden", // Source map generation must be turned on ("hidden", true, etc.) @@ -81,7 +81,7 @@ require("esbuild").build({ Generating source maps **may expose them to the public**, potentially causing your source code to be leaked. You can prevent this by configuring your server to deny access to `.js.map` files, or by using [Sentry Esbuild Plugin's - `sourcemaps.filesToDeleteAfterUpload`](https://www.npmjs.com/package/@sentry/esbuild-plugin#sourcemapsfilestodeleteafterupload) + `sourcemaps.filesToDeleteAfterUpload`](/platforms/javascript/sourcemaps/uploading/bundler-plugin-options/#sourcemaps.filesToDeleteAfterUpload) option to delete source maps after they've been uploaded to Sentry. diff --git a/docs/platforms/javascript/guides/cordova/sourcemaps/uploading/rollup.mdx b/docs/platforms/javascript/guides/cordova/sourcemaps/uploading/rollup.mdx index 29b44acd07dd1..066d1b6ba87f4 100644 --- a/docs/platforms/javascript/guides/cordova/sourcemaps/uploading/rollup.mdx +++ b/docs/platforms/javascript/guides/cordova/sourcemaps/uploading/rollup.mdx @@ -26,15 +26,15 @@ If you'd rather manually configure source map uploading with the CLI, follow the Install the Sentry Rollup plugin: ```bash {tabTitle:npm} -npm install @sentry/rollup-plugin --save-dev +npm install @sentry/bundler-plugins --save-dev ``` ```bash {tabTitle:yarn} -yarn add @sentry/rollup-plugin --dev +yarn add @sentry/bundler-plugins --dev ``` ```bash {tabTitle:pnpm} -pnpm add @sentry/rollup-plugin --save-dev +pnpm add @sentry/bundler-plugins --save-dev ``` ### Configuration @@ -46,7 +46,7 @@ Alternatively, you can also use a [Personal Token](https://sentry.io/orgredirect Auth tokens can be passed to the plugin explicitly with the `authToken` option, with a `SENTRY_AUTH_TOKEN` environment variable, or with an `.env.sentry-build-plugin` file (don't forget to add it to your `.gitignore` file, as this is sensitive data) in the working directory when building your project. We recommend you add the auth token to your CI/CD environment as an environment variable. -Learn more about configuring the plugin in our [Sentry Rollup Plugin documentation](https://www.npmjs.com/package/@sentry/rollup-plugin). +Learn more about configuring the plugin in our [Sentry Rollup Plugin documentation](/platforms/javascript/sourcemaps/uploading/bundler-plugin-options/). @@ -57,7 +57,7 @@ SENTRY_AUTH_TOKEN=___ORG_AUTH_TOKEN___ Example: ```javascript {filename:rollup.config.js} -import { sentryRollupPlugin } from "@sentry/rollup-plugin"; +import { sentryRollupPlugin } from "@sentry/bundler-plugins/rollup"; export default { output: { @@ -83,6 +83,6 @@ export default { Generating source maps **may expose them to the public**, potentially causing your source code to be leaked. You can prevent this by configuring your server to deny access to `.js.map` files, or by using [Sentry Rollup Plugin's - `sourcemaps.filesToDeleteAfterUpload`](https://www.npmjs.com/package/@sentry/rollup-plugin#sourcemapsfilestodeleteafterupload) + `sourcemaps.filesToDeleteAfterUpload`](/platforms/javascript/sourcemaps/uploading/bundler-plugin-options/#sourcemaps.filesToDeleteAfterUpload) option to delete source maps after they've been uploaded to Sentry. diff --git a/docs/platforms/javascript/guides/cordova/sourcemaps/uploading/vite.mdx b/docs/platforms/javascript/guides/cordova/sourcemaps/uploading/vite.mdx index 7440da1fd816d..dc338d99470c8 100644 --- a/docs/platforms/javascript/guides/cordova/sourcemaps/uploading/vite.mdx +++ b/docs/platforms/javascript/guides/cordova/sourcemaps/uploading/vite.mdx @@ -26,15 +26,15 @@ If you'd rather configure source map uploading with Vite manually, follow the st Install the Sentry Vite plugin: ```bash {tabTitle:npm} -npm install @sentry/vite-plugin --save-dev +npm install @sentry/bundler-plugins --save-dev ``` ```bash {tabTitle:yarn} -yarn add @sentry/vite-plugin --dev +yarn add @sentry/bundler-plugins --dev ``` ```bash {tabTitle:pnpm} -pnpm add @sentry/vite-plugin --save-dev +pnpm add @sentry/bundler-plugins --save-dev ``` ### Configuration @@ -46,7 +46,7 @@ Alternatively, you can also use a [Personal Token](https://sentry.io/orgredirect Auth tokens can be passed to the plugin explicitly with the `authToken` option, with a `SENTRY_AUTH_TOKEN` environment variable, or with an `.env.sentry-build-plugin` file (don't forget to add it to your `.gitignore` file, as this is sensitive data) in the working directory when building your project. We recommend you add the auth token to your CI/CD environment as an environment variable. -Learn more about configuring the plugin in our [Sentry Vite Plugin documentation](https://www.npmjs.com/package/@sentry/vite-plugin). +Learn more about configuring the plugin in our [Sentry Vite Plugin documentation](/platforms/javascript/sourcemaps/uploading/bundler-plugin-options/). @@ -66,7 +66,7 @@ Example: ```javascript {filename:vite.config.js} import { defineConfig } from "vite"; -import { sentryVitePlugin } from "@sentry/vite-plugin"; +import { sentryVitePlugin } from "@sentry/bundler-plugins/vite"; export default defineConfig({ build: { @@ -93,7 +93,7 @@ export default defineConfig({ Generating source maps **may expose them to the public**, potentially causing your source code to be leaked. You can prevent this by configuring your server to deny access to `.js.map` files, or by using [Sentry Vite Plugin's - `sourcemaps.filesToDeleteAfterUpload`](https://www.npmjs.com/package/@sentry/vite-plugin#sourcemapsfilestodeleteafterupload) + `sourcemaps.filesToDeleteAfterUpload`](/platforms/javascript/sourcemaps/uploading/bundler-plugin-options/#sourcemaps.filesToDeleteAfterUpload) option to delete source maps after they've been uploaded to Sentry. diff --git a/docs/platforms/javascript/guides/cordova/sourcemaps/uploading/webpack.mdx b/docs/platforms/javascript/guides/cordova/sourcemaps/uploading/webpack.mdx index 64ddd6c3d923f..a2f2839024e8e 100644 --- a/docs/platforms/javascript/guides/cordova/sourcemaps/uploading/webpack.mdx +++ b/docs/platforms/javascript/guides/cordova/sourcemaps/uploading/webpack.mdx @@ -25,15 +25,15 @@ If you'd rather configure source map uploading with webpack manually, follow the Install the Sentry webpack plugin: ```bash {tabTitle:npm} -npm install @sentry/webpack-plugin --save-dev +npm install @sentry/bundler-plugins --save-dev ``` ```bash {tabTitle:yarn} -yarn add @sentry/webpack-plugin --dev +yarn add @sentry/bundler-plugins --dev ``` ```bash {tabTitle:pnpm} -pnpm add @sentry/webpack-plugin --save-dev +pnpm add @sentry/bundler-plugins --save-dev ``` ### Configuration @@ -45,7 +45,7 @@ Alternatively, you can also use a [Personal Token](https://sentry.io/orgredirect Auth tokens can be passed to the plugin explicitly with the `authToken` option, with a `SENTRY_AUTH_TOKEN` environment variable, or with an `.env.sentry-build-plugin` file (don't forget to add it to your `.gitignore` file, as this is sensitive data) in the working directory when building your project. We recommend you add the auth token to your CI/CD environment as an environment variable. -Learn more about configuring the plugin in our [Sentry webpack plugin documentation](https://www.npmjs.com/package/@sentry/webpack-plugin). +Learn more about configuring the plugin in our [Sentry webpack plugin documentation](/platforms/javascript/sourcemaps/uploading/bundler-plugin-options/). @@ -56,7 +56,7 @@ SENTRY_AUTH_TOKEN=___ORG_AUTH_TOKEN___ And the following webpack config: ```javascript {filename:webpack.config.js} -const { sentryWebpackPlugin } = require("@sentry/webpack-plugin"); +const { sentryWebpackPlugin } = require("@sentry/bundler-plugins/webpack"); module.exports = { // ... other config above ... @@ -82,7 +82,7 @@ module.exports = { Generating source maps **may expose them to the public**, potentially causing your source code to be leaked. You can prevent this by configuring your server to deny access to `.js.map` files, or by using [Sentry Webpack Plugin's - `sourcemaps.filesToDeleteAfterUpload`](https://www.npmjs.com/package/@sentry/webpack-plugin#sourcemapsfilestodeleteafterupload) + `sourcemaps.filesToDeleteAfterUpload`](/platforms/javascript/sourcemaps/uploading/bundler-plugin-options/#sourcemaps.filesToDeleteAfterUpload) option to delete source maps after they've been uploaded to Sentry. diff --git a/docs/platforms/javascript/guides/nextjs/configuration/build/index.mdx b/docs/platforms/javascript/guides/nextjs/configuration/build/index.mdx index 894b524e379ba..f67892b46815d 100644 --- a/docs/platforms/javascript/guides/nextjs/configuration/build/index.mdx +++ b/docs/platforms/javascript/guides/nextjs/configuration/build/index.mdx @@ -237,7 +237,7 @@ Learn more about tunneling in the Sentry's bundler plugins +2. By directly installing `@sentry/bundler-plugins/babel-plugin` We recommend that you use the first option because the Sentry bundler plugins come packed with additional useful features to enrich your Sentry workflows, including: automatic sourcemap upload, release creation, automatic release name discovery, and release injection. **Set up using bundler plugins**: -Follow the instructions in the npm page for the bundler that your project uses: -- [Rollup](https://www.npmjs.com/package/@sentry/rollup-plugin) -- [Vite](https://www.npmjs.com/package/@sentry/vite-plugin) -- [Webpack](https://www.npmjs.com/package/@sentry/webpack-plugin) +Follow the instructions in the guide for the bundler that your project uses: +- Rollup +- Vite +- Webpack Please note that although there is a Sentry bundler plugin for **esbuild**, React component name capturing is currently not supported. @@ -78,6 +78,30 @@ To avoid these errors, you can exclude specific components from annotation by us +**Set up using the Babel plugin**: + +Install `@sentry/bundler-plugins`: + +```bash {tabTitle:npm} +npm install @sentry/bundler-plugins --save-dev +``` + +```bash {tabTitle:yarn} +yarn add @sentry/bundler-plugins --dev +``` + +```bash {tabTitle:pnpm} +pnpm add @sentry/bundler-plugins --save-dev +``` + +Then add the plugin to your Babel config: + +```json {filename:.babelrc} +{ + "plugins": ["@sentry/bundler-plugins/babel-plugin"] +} +``` + Now, you will be able to see your component names in breadcrumbs, spans, and search for replays by component names. See [this page](/concepts/search/searchable-properties/session-replay/#clickcomponent_name) for more information on searching for Replays by component name. diff --git a/docs/platforms/javascript/guides/tanstackstart-react/features/sentryTanstackStart.mdx b/docs/platforms/javascript/guides/tanstackstart-react/features/sentryTanstackStart.mdx index ab4ae0a30a655..6eec0a2521cc6 100644 --- a/docs/platforms/javascript/guides/tanstackstart-react/features/sentryTanstackStart.mdx +++ b/docs/platforms/javascript/guides/tanstackstart-react/features/sentryTanstackStart.mdx @@ -51,7 +51,7 @@ export default defineConfig({ ## Configuration Options -The plugin passes through all options to the underlying [`@sentry/vite-plugin`](/platforms/javascript/sourcemaps/uploading/vite/). See the [Sentry Vite Plugin documentation](/platforms/javascript/sourcemaps/uploading/vite/) for the full list of available options. +The plugin passes through all options to the underlying [`@sentry/bundler-plugins/vite`](/platforms/javascript/sourcemaps/uploading/vite/). See the [Sentry Vite Plugin documentation](/platforms/javascript/sourcemaps/uploading/bundler-plugin-options/) for the full list of available options. ### Automatic Middleware Instrumentation diff --git a/docs/product/sentry-basics/getting-started-tutorial/enable-readable-stack-traces.mdx b/docs/product/sentry-basics/getting-started-tutorial/enable-readable-stack-traces.mdx index 12c7cd7f2ee7e..e2c22d765a748 100644 --- a/docs/product/sentry-basics/getting-started-tutorial/enable-readable-stack-traces.mdx +++ b/docs/product/sentry-basics/getting-started-tutorial/enable-readable-stack-traces.mdx @@ -29,15 +29,15 @@ The sample frontend app uses [Vite](https://vite.dev/) as its build tool, and th In the `tracing-tutorial-frontend` project folder, install the plugin as a dev dependency: ```bash {tabTitle:npm} -npm install @sentry/vite-plugin --save-dev +npm install @sentry/bundler-plugins --save-dev ``` ```bash {tabTitle:yarn} -yarn add @sentry/vite-plugin --dev +yarn add @sentry/bundler-plugins --dev ``` ```bash {tabTitle:pnpm} -pnpm add @sentry/vite-plugin --save-dev +pnpm add @sentry/bundler-plugins --save-dev ``` ## 2. Add an Auth Token @@ -72,7 +72,7 @@ Now open `vite.config.js` and add `sentryVitePlugin` as shown below, replacing ` ```javascript {filename:vite.config.js} import { defineConfig } from "vite"; import react from "@vitejs/plugin-react"; -import { sentryVitePlugin } from "@sentry/vite-plugin"; +import { sentryVitePlugin } from "@sentry/bundler-plugins/vite"; export default defineConfig({ build: { diff --git a/platform-includes/configuration/filter-application-key/javascript.mdx b/platform-includes/configuration/filter-application-key/javascript.mdx index d101bab6445fc..c827a88c670ce 100644 --- a/platform-includes/configuration/filter-application-key/javascript.mdx +++ b/platform-includes/configuration/filter-application-key/javascript.mdx @@ -1,7 +1,7 @@ ```ts {tabTitle:Vite} {mdExpandTabs} {8} // vite.config.ts import { defineConfig } from "vite"; -import { sentryVitePlugin } from "@sentry/vite-plugin"; +import { sentryVitePlugin } from "@sentry/bundler-plugins/vite"; export default defineConfig({ plugins: [ @@ -14,7 +14,7 @@ export default defineConfig({ ```js {tabTitle:Webpack} {7} // webpack.config.js -const { sentryWebpackPlugin } = require("@sentry/webpack-plugin"); +const { sentryWebpackPlugin } = require("@sentry/bundler-plugins/webpack"); module.exports = { plugins: [ @@ -27,7 +27,7 @@ module.exports = { ```js {tabTitle:esbuild} {7} // esbuild.config.js -const { sentryEsbuildPlugin } = require("@sentry/esbuild-plugin"); +const { sentryEsbuildPlugin } = require("@sentry/bundler-plugins/esbuild"); require("esbuild").build({ plugins: [ @@ -40,7 +40,7 @@ require("esbuild").build({ ```js {tabTitle:Rollup} {7} // rollup.config.mjs -import { sentryRollupPlugin } from "@sentry/rollup-plugin"; +import { sentryRollupPlugin } from "@sentry/bundler-plugins/rollup"; export default { plugins: [ diff --git a/platform-includes/sourcemaps/overview/javascript.astro.mdx b/platform-includes/sourcemaps/overview/javascript.astro.mdx index bbb9bc7a66ebb..6d2e2aa84d71e 100644 --- a/platform-includes/sourcemaps/overview/javascript.astro.mdx +++ b/platform-includes/sourcemaps/overview/javascript.astro.mdx @@ -61,5 +61,5 @@ Source maps work best with [organization-scoped auth tokens](/account/auth-token The Astro SDK uses the Sentry Vite plugin to upload source maps. This plugin collects telemetry data to help us improve the source map uploading experience. -Read more about this in our [Vite plugin documentation](https://www.npmjs.com/package/@sentry/vite-plugin#telemetry). +Read more about this in our [Vite plugin documentation](/platforms/javascript/sourcemaps/uploading/bundler-plugin-options/#telemetry). You can disable telemetry collection by setting `telemetry: false` in the `sentry` integration options. diff --git a/platform-includes/sourcemaps/overview/javascript.nuxt.mdx b/platform-includes/sourcemaps/overview/javascript.nuxt.mdx index ded141af5c79e..6cb5dd02670a6 100644 --- a/platform-includes/sourcemaps/overview/javascript.nuxt.mdx +++ b/platform-includes/sourcemaps/overview/javascript.nuxt.mdx @@ -76,7 +76,7 @@ export default defineNuxtConfig({ Generating source maps **may expose them to the public**, potentially causing your source code to be leaked. You can prevent this by configuring your server to deny access to `.js.map` files, or by using [Sentry Vite Plugin's - `sourcemaps.filesToDeleteAfterUpload`](https://www.npmjs.com/package/@sentry/vite-plugin#sourcemapsfilestodeleteafterupload) + `sourcemaps.filesToDeleteAfterUpload`](/platforms/javascript/sourcemaps/uploading/bundler-plugin-options/#sourcemaps.filesToDeleteAfterUpload) option to delete source maps after they've been uploaded to Sentry. diff --git a/platform-includes/sourcemaps/overview/javascript.svelte.mdx b/platform-includes/sourcemaps/overview/javascript.svelte.mdx index a7544f97288bf..75a2ed86f9691 100644 --- a/platform-includes/sourcemaps/overview/javascript.svelte.mdx +++ b/platform-includes/sourcemaps/overview/javascript.svelte.mdx @@ -38,15 +38,15 @@ export default config; If you're using Vite in you Svelte project, you can use Sentry's Vite plugin for convenience: ```bash {tabTitle:npm} -npm install @sentry/vite-plugin --save-dev +npm install @sentry/bundler-plugins --save-dev ``` ```bash {tabTitle:yarn} -yarn add @sentry/vite-plugin --dev +yarn add @sentry/bundler-plugins --dev ``` ```bash {tabTitle:pnpm} -pnpm add @sentry/vite-plugin --save-dev +pnpm add @sentry/bundler-plugins --save-dev ``` To upload source maps you have to configure an [Organization Token](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/). @@ -70,7 +70,7 @@ Configure Vite to emit source maps and use the Sentry Vite plugin: ```JavaScript {filename:vite.config.js} import { defineConfig } from "vite"; import { svelte } from "@sveltejs/vite-plugin-svelte"; -import { sentryVitePlugin } from "@sentry/vite-plugin"; +import { sentryVitePlugin } from "@sentry/bundler-plugins/vite"; export default defineConfig({ build: { @@ -98,8 +98,8 @@ export default defineConfig({ Generating source maps **may expose them to the public**, potentially causing your source code to be leaked. You can prevent this by configuring your server to deny access to `.js.map` files, or by - using [Sentry Vite Plugin's - `sourcemaps.filesToDeleteAfterUpload`](https://www.npmjs.com/package/@sentry/vite-plugin#sourcemapsfilestodeleteafterupload) + using Sentry Vite Plugin's + `sourcemaps.filesToDeleteAfterUpload` option to delete source maps after they've been uploaded to Sentry. diff --git a/platform-includes/sourcemaps/overview/javascript.vue.mdx b/platform-includes/sourcemaps/overview/javascript.vue.mdx index e0bbedc90db61..c99da813efd0d 100644 --- a/platform-includes/sourcemaps/overview/javascript.vue.mdx +++ b/platform-includes/sourcemaps/overview/javascript.vue.mdx @@ -24,20 +24,20 @@ You can use the Sentry Vite plugin to automatically create [releases](/product/r #### Installation ```bash {tabTitle:npm} -npm install @sentry/vite-plugin --save-dev +npm install @sentry/bundler-plugins --save-dev ``` ```bash {tabTitle:yarn} -yarn add @sentry/vite-plugin --dev +yarn add @sentry/bundler-plugins --dev ``` ```bash {tabTitle:pnpm} -pnpm add @sentry/vite-plugin --save-dev +pnpm add @sentry/bundler-plugins --save-dev ``` #### Configuration -Learn more about configuring the plugin in our [Sentry Vite Plugin documentation](https://www.npmjs.com/package/@sentry/vite-plugin). +Learn more about configuring the plugin in our Sentry Vite Plugin documentation. To upload source maps you have to configure an [Organization Token](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/). @@ -60,7 +60,7 @@ Example: ```javascript {filename:vite.config.js} import { defineConfig } from "vite"; import vue from "@vitejs/plugin-vue"; -import { sentryVitePlugin } from "@sentry/vite-plugin"; +import { sentryVitePlugin } from "@sentry/bundler-plugins/vite"; // https://vitejs.dev/config/ export default defineConfig({ @@ -89,8 +89,8 @@ export default defineConfig({ Generating source maps **may expose them to the public**, potentially causing your source code to be leaked. You can prevent this by configuring your server to deny access to `.js.map` files, or by - using [Sentry Vite Plugin's - `sourcemaps.filesToDeleteAfterUpload`](https://www.npmjs.com/package/@sentry/vite-plugin#sourcemapsfilestodeleteafterupload) + using Sentry Vite Plugin's + `sourcemaps.filesToDeleteAfterUpload` option to delete source maps after they've been uploaded to Sentry. diff --git a/platform-includes/sourcemaps/primer/javascript.astro.mdx b/platform-includes/sourcemaps/primer/javascript.astro.mdx index d78f181bc6b8a..a61dbf9f70ed7 100644 --- a/platform-includes/sourcemaps/primer/javascript.astro.mdx +++ b/platform-includes/sourcemaps/primer/javascript.astro.mdx @@ -1,3 +1,3 @@ The Sentry Astro SDK will generate and upload source maps automatically during a production build, so that errors in Sentry contain readable stack traces. -It uses the [Sentry Vite Plugin](https://www.npmjs.com/package/@sentry/vite-plugin/) to upload source maps. See the Manual Configuration page and the Sentry [Vite plugin documentation](https://www.npmjs.com/package/@sentry/vite-plugin/#configuration) for more details. +It uses the Sentry Vite Plugin to upload source maps. See the Manual Configuration page and the Sentry [Vite plugin documentation](/platforms/javascript/sourcemaps/uploading/bundler-plugin-options/) for more details. diff --git a/platform-includes/sourcemaps/primer/javascript.nuxt.mdx b/platform-includes/sourcemaps/primer/javascript.nuxt.mdx index 368f3c66327ea..59632620a68c6 100644 --- a/platform-includes/sourcemaps/primer/javascript.nuxt.mdx +++ b/platform-includes/sourcemaps/primer/javascript.nuxt.mdx @@ -1,4 +1,4 @@ -`@sentry/nuxt` uses the [Sentry Vite Plugin](https://www.npmjs.com/package/@sentry/vite-plugin) and the [Sentry Rollup Plugin](https://www.npmjs.com/package/@sentry/rollup-plugin) to generate and upload source maps automatically. This means that when you run a production build (`nuxt build`), source maps will be generated and uploaded to Sentry, so that errors in Sentry will contain readable stack traces. +`@sentry/nuxt` uses the Sentry Vite Plugin and the Sentry Rollup Plugin to generate and upload source maps automatically. This means that when you run a production build (`nuxt build`), source maps will be generated and uploaded to Sentry, so that errors in Sentry will contain readable stack traces. ## Configure Source Maps Upload @@ -50,7 +50,7 @@ export default defineNuxtConfig({ Generating source maps **may expose them to the public**, potentially causing your source code to be leaked. You can prevent this by configuring your server to deny access to `.js.map` files, or by using [Sentry Vite Plugin's - `sourcemaps.filesToDeleteAfterUpload`](https://www.npmjs.com/package/@sentry/vite-plugin#sourcemapsfilestodeleteafterupload) + `sourcemaps.filesToDeleteAfterUpload`](/platforms/javascript/sourcemaps/uploading/bundler-plugin-options/#sourcemaps.filesToDeleteAfterUpload) option to delete source maps after they've been uploaded to Sentry. diff --git a/platform-includes/sourcemaps/primer/javascript.solidstart.mdx b/platform-includes/sourcemaps/primer/javascript.solidstart.mdx index ba3bdf68156bd..0ea543c2bf354 100644 --- a/platform-includes/sourcemaps/primer/javascript.solidstart.mdx +++ b/platform-includes/sourcemaps/primer/javascript.solidstart.mdx @@ -6,7 +6,7 @@ The easiest way to configure uploading source maps is by using the [Sentry Wizar npx @sentry/wizard@latest -i solidstart ``` -The SolidStart SDK uses the Sentry Vite Plugin under the hood to upload source maps. See the [Vite plugin documentation](https://www.npmjs.com/package/@sentry/vite-plugin/#configuration) for more details. +The SolidStart SDK uses the Sentry Vite Plugin under the hood to upload source maps. See the [Vite plugin documentation](/platforms/javascript/sourcemaps/uploading/bundler-plugin-options/) for more details. **Note:** Source maps are only generated and uploaded during **production builds** (`npm run build`). Development builds (`npm run dev`) do not generate source maps for upload. diff --git a/platform-includes/sourcemaps/primer/javascript.sveltekit.mdx b/platform-includes/sourcemaps/primer/javascript.sveltekit.mdx index 7bfc3fb1a65b7..b494a6348344f 100644 --- a/platform-includes/sourcemaps/primer/javascript.sveltekit.mdx +++ b/platform-includes/sourcemaps/primer/javascript.sveltekit.mdx @@ -1,3 +1,3 @@ `@sentry/sveltekit` will generate and upload source maps automatically, so that errors in Sentry will contain readable stack traces. -The SvelteKit SDK uses the Sentry Vite Plugin to upload source maps. See the [Sentry Vite Plugin documentation](https://www.npmjs.com/package/@sentry/vite-plugin#options) for all available options. +The SvelteKit SDK uses the Sentry Vite Plugin to upload source maps. See the [Sentry Vite Plugin documentation](/platforms/javascript/sourcemaps/uploading/bundler-plugin-options/) for all available options. diff --git a/platform-includes/sourcemaps/upload/primer/javascript.svelte.mdx b/platform-includes/sourcemaps/upload/primer/javascript.svelte.mdx index deaafdc781c0a..bef71655697fa 100644 --- a/platform-includes/sourcemaps/upload/primer/javascript.svelte.mdx +++ b/platform-includes/sourcemaps/upload/primer/javascript.svelte.mdx @@ -1,6 +1,6 @@ To upload your Svelte project's source maps to Sentry, you currently have two options: -- Use the [Sentry Vite plugin](https://www.npmjs.com/package/@sentry/vite-plugin) to set releases and upload source maps. +- Use the Sentry Vite plugin to set releases and upload source maps. - Upload source maps manually using [Sentry-CLI](./cli/). Take a look at this [bash script](https://github.com/getsentry/sentry-javascript/tree/master/packages/svelte#sourcemaps-and-releases) as an example of how to configure the CLI for a typical Svelte project. For other bundlers or more advanced configurations, take a look at the following guides and options for uploading sourcemaps: diff --git a/platform-includes/sourcemaps/upload/primer/javascript.sveltekit.mdx b/platform-includes/sourcemaps/upload/primer/javascript.sveltekit.mdx index de8e5ec131a6a..79c93fe859d73 100644 --- a/platform-includes/sourcemaps/upload/primer/javascript.sveltekit.mdx +++ b/platform-includes/sourcemaps/upload/primer/javascript.sveltekit.mdx @@ -23,7 +23,7 @@ SENTRY_URL="https://your-sentry-instance.com" **Option 2** -You can also set your org and project slugs directly in the `sentrySvelteKit` options, as seen in the example below. For a full list of available options, see the [Sentry Vite Plugin documentation](https://www.npmjs.com/package/@sentry/vite-plugin#options). +You can also set your org and project slugs directly in the `sentrySvelteKit` options, as seen in the example below. For a full list of available options, see the [Sentry Vite Plugin documentation](/platforms/javascript/sourcemaps/uploading/bundler-plugin-options/). ```javascript {filename:vite.config.(js|ts)} {6-12} import { sveltekit } from "@sveltejs/kit/vite";