SystemJS
Upload your source maps using SystemJS and Sentry CLI.
In this guide, you'll learn how to successfully upload source maps for SystemJS using our sentry-cli tool.
This guide assumes the following:
sentry-cliversion >=2.17.0- Sentry Javascript SDK version >=
7.47.0
First, configure SystemJS to output source maps:
builder.bundle("src/app.js", "dist/app.min.js", {
minify: true,
sourceMaps: true,
sourceMapContents: true,
});
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 deleting the sourcemaps before deploying your application.
You can find installation instructions for Sentry CLI here: https://docs.sentry.io/cli/installation/
For more info on sentry-cli configuration visit the Sentry CLI configuration docs.
Make sure sentry-cli is configured for your project. For that you can use environment variables:
.env.localSENTRY_ORG=example-org
SENTRY_PROJECT=example-project
SENTRY_AUTH_TOKEN=sntrys_YOUR_TOKEN_HERE
Debug IDs are used to match the stack frame of an event with its corresponding minified source and source map file. Visit What are Artifact Bundles if you want to learn more about Artifact Bundles and Debug IDs.
To inject Debug IDs, use the following command:
sentry-cli sourcemaps inject /path/to/directory
Minified source files should contain at the end a comment named debugId like:
example_minified_file.js...
//# debugId=<debug_id>
//# sourceMappingURL=<sourcemap_url>
Source maps should contain a field named debug_id like:
example_source_map.js.map{
...
"debug_id":"<debug_id>",
...
}
After you've injected Debug IDs into your artifacts, upload them using the following command.
sentry-cli sourcemaps upload /path/to/directory
Open up Sentry and navigate to Project Settings > Source Maps. If you choose “Artifact Bundles” in the tabbed navigation, you'll see all the artifact bundles that have been successfully uploaded to Sentry.
If you're following this guide from your local machine, then you've successfully:
- Generated minified source and source map files (artifacts) by running your application's build process
- Injected Debug IDs into the artifacts you've just generated
- Uploaded those artifacts to Sentry with our upload command
The last step is deploying a new version of your application using the generated artifacts you created in step one. We strongly recommend that you integrate sentry-cli into your CI/CD Pipeline, to ensure each subsequent deploy will automatically inject debug IDs into each artifact and upload them directly to Sentry.
Warning
Only follow these optional steps if you have concluded that you absolutely need them. Using release and dist values will make your artifact upload more specific, but will also make the entire process less forgiving, which may lead to your code not being unminified by Sentry.
Provide a release property in your SDK options.
Sentry.init({
// This value must be identical to the release name specified during upload
// with the `sentry-cli`.
release: "<release_name>",
});
Afterwards, run the sourcemaps upload command with the additional --release option. Please ensure that the value specified for <release_name> is the same value specified in your SDK options.
sentry-cli sourcemaps upload --release=<release_name> /path/to/directory
Running upload with --release doesn't automatically create a release in Sentry. Either wait until the first event with the new release set in Sentry.init is sent to Sentry, or create a release with the same name in a separate step with the CLI.
In addition to release, you can also add a dist to your uploaded artifacts, to set the distribution identifier for uploaded files. To do so, run the sourcemaps upload command with the additional --dist option.
Provide release and dist properties in your SDK options.
Sentry.init({
// These values must be identical to the release and dist names specified during upload
// with the `sentry-cli`.
release: "<release_name>",
dist: "<dist_name>",
});
The distribution identifier is used to distinguish between multiple files of the same name within a single release. dist can be used to disambiguate build or deployment variants.
sentry-cli sourcemaps upload --release=<release_name> --dist=<dist_name> /path/to/directory
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").