RemixSource Maps
To enable readable stack traces in your Sentry errors, you need to upload your source maps to Sentry.
Uploading Source Maps in a Remix Project
If you installed the Remix SDK with the Sentry Wizard, source maps upload was already configured for you. Whenever you run the build script in your package.json source maps will be uploaded automatically.
If you installed the SDK manually or the wizard failed, follow the steps below to manually configure source maps upload.
Configure Source Maps Upload
Uploading sourcemaps on Vite projects
Starting from version 2.2.0, Remix supports Vite as a build tool. If you use Vite to build your project, you can use the Vite plugin to upload source maps to Sentry. You do not need to follow the steps below.
The Sentry Remix SDK provides a script to automatically create a release and upload source maps after you've built your project. Under the hood, it uses the Sentry CLI.
This script requires setting an auth token, which can either be done through a .sentryclirc file in the root of your project or through environment variables:
.sentryclirc# Do not commit this file to your repository!
# Sentry Auth tokens should be treated as a secret.
[auth]
token=sntrys_YOUR_TOKEN_HERE
Next, adjust your package.json's production build command to include the sentry-upload-sourcemaps script:
package.json{
"scripts": {
"build": "remix build --sourcemap && sentry-upload-sourcemaps --org example-org --project example-project"
}
}
Alternatively, you can run the script directly with npx:
npx sentry-upload-sourcemaps --org example-org --project example-project
# For usage details run
npx sentry-upload-sourcemaps --help
To generate source maps with your Remix project, you need to call remix build with the --sourcemap option.
Please refer to the Remix CLI docs for more information.
Remove Remix Source Maps
Remix validly discourages hosting source maps in production. After uploading the maps to Sentry, we suggest you delete the .map files. The sentry-upload-sourcemaps script will automatically try to delete all generated source maps after they're uploaded (unless the --deleteAfterUpload flag is provided).
If you want to be extra sure they're deleted, you can use the following shell script:
find ./public/build -type f -name '*.map' -delete
find ./build -type f -name '*.map' -delete
Please note that these commands might vary for the operating system or shell you use.
By default, if Sentry can't find the uploaded files it needs, it will attempt to download them from the URLs in the stack trace. To disable this, turn off "Enable JavaScript source fetching" in either your organization's "Security & Privacy" settings or your project's general settings.
Additional Resources
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").
