Vite
Upload your source maps with the Sentry Vite Plugin.
This guide assumes you're using a Sentry SDK version 7.47.0
or higher. If you're on an older version and you want to upload source maps, we recommend upgrading your SDK to the newest version.
You can use the Sentry Vite plugin to automatically create releases and upload source maps to Sentry when bundling your app.
The easiest way to configure uploading source maps with Vite is by using the Sentry Wizard:
npx @sentry/wizard@latest -i sourcemaps
The wizard will guide you through the following steps:
- Logging into Sentry and selecting a project
- Installing the necessary Sentry packages
- Configuring your build tool to generate and upload source maps
- Configuring your CI to upload source maps
If you'd rather configure source map uploading with Vite manually, follow the steps below.
Install the Sentry Vite plugin:
npm install @sentry/vite-plugin --save-dev
To upload source maps you have to configure an Organization Auth Token.
Alternatively, you can also use a User Auth Token, with the "Project: Read & Write" and "Release: Admin" permissions.
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.
.env.sentry-build-plugin
SENTRY_AUTH_TOKEN=sntrys_YOUR_TOKEN_HERE
Example:
vite.config.js
import { defineConfig } from "vite";
import { sentryVitePlugin } from "@sentry/vite-plugin";
export default defineConfig({
build: {
sourcemap: true, // Source map generation must be turned on
},
plugins: [
// Put the Sentry vite plugin after all other plugins
sentryVitePlugin({
org: "example-org",
project: "example-project",
authToken: process.env.SENTRY_AUTH_TOKEN,
}),
],
});
Generating sourcemaps 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
option to delete source maps after they've been uploaded to Sentry.
The Sentry Vite plugin doesn't upload source maps in watch-mode/development-mode. We recommend running a production build to test your configuration.
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").