-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
feat(source-maps): Add doc explaining Debug IDs #13100
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
priscilawebdev
merged 20 commits into
master
from
priscila/feat/source-maps/add-debug-ids-doc
Mar 26, 2025
Merged
Changes from 1 commit
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
047ad12
feat(source-maps): Add doc explaining Debug IDs
priscilawebdev 93b1327
Update docs/platforms/javascript/common/sourcemaps/debug-ids/index.mdx
priscilawebdev ee01726
feedback
priscilawebdev 087a347
add one more redirect
priscilawebdev 0ef287f
Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…
priscilawebdev 52ec520
Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…
priscilawebdev 0c762c0
Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…
priscilawebdev e24d193
Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…
priscilawebdev b8076fc
Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…
priscilawebdev 65d332c
Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…
priscilawebdev 1123482
Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…
priscilawebdev 9dbbff2
Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…
priscilawebdev f4124a2
Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…
priscilawebdev 9019f5f
Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…
priscilawebdev 295c533
Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…
priscilawebdev 72ad839
Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…
priscilawebdev 78f08df
Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…
priscilawebdev 59ebf8a
Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…
priscilawebdev 313ab62
Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…
priscilawebdev 0fc6e4c
add specific version for next.js
priscilawebdev File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file added
BIN
+191 KB
docs/platforms/javascript/common/sourcemaps/debug-ids/img/bad-stack-trace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+637 KB
docs/platforms/javascript/common/sourcemaps/debug-ids/img/debug-ids.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+107 KB
docs/platforms/javascript/common/sourcemaps/debug-ids/img/good-stack-trace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 48 additions & 0 deletions
48
docs/platforms/javascript/common/sourcemaps/debug-ids/index.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| --- | ||
| title: Debug IDs | ||
| description: "Debug IDs is Sentry's recommended and most reliable way to link minified JavaScript files to their original source code, improving the accuracy and readability of stack traces. By using Debug IDs, developers can easily trace errors back to the original code, making debugging faster and more effective." | ||
| --- | ||
|
|
||
| ## Introduction | ||
|
|
||
| Developers of modern websites often use some kind of build process when they add JavaScript to the site. This build process takes some input JavaScript, transforms it in some way, then outputs JavaScript that is served alongside the website. Some example transformations include minifying JavaScript code (so the final JavaScript bundle is smaller and faster to load) or removing TypeScript types (only JavaScript can run on the browser). | ||
|
|
||
| As a result, the JavaScript code running in production is typically not the same as the code written by the developer in the source editor. Instead, it has undergone several transformations, such as [minification](https://developer.mozilla.org/en-US/docs/Glossary/Minification), [transpilation](https://www.typescriptlang.org/), [downcompilation](https://babeljs.io/), [transformation](https://rollupjs.org/), [polyfilling](https://developer.mozilla.org/en-US/docs/Glossary/Polyfill), and others, aimed at improving performance and ensuring cross-browser compatibility. | ||
|
|
||
| Stack traces are essential to debug errors, but stack traces that come from generated JavaScript are often unreadable or unusable! They look nothing like the code you wrote, you can’t connect them to your source code repository, and minified variables or function names make you lose context about what is happening. | ||
|
|
||
| To ensure Sentry (and other tools) can provide stack traces that are both readable and useful, you’ll want to generate and use [source maps](https://firefox-source-docs.mozilla.org/devtools-user/debugger/how_to/use_a_source_map/index.html). Source maps are files that map the transformed JavaScript back to the original code. This allows Sentry to trace the error to your original source, which means you’ll get stack traces that look like the code you wrote, not the code you generated. | ||
|
|
||
| To connect source maps to a JavaScript file, we relied on filenames, but these often were unreliable. For example, a new deploy of a source map with the same filename would mean the source mapping gets incorrectly applied. | ||
|
|
||
| `//# source mappingURL=http://example.com/path/to/your/source map.map` | ||
|
|
||
| Given the url-based filename approach was unreliable, we came up with [Debug IDs](/platforms/javascript/sourcemaps/debug-ids#what-is-a-debug-id). | ||
|
|
||
| ## What is a Debug ID | ||
|
|
||
| Inspired by approaches in native language ecosystems, Debug IDs are globally unique, deterministic ids that identify a transformed JavaScript file and its associated source map. | ||
|
|
||
|  | ||
|
|
||
| ## How Sentry uses Debug IDs | ||
|
|
||
| To use Debug IDs, you need **version 7.47** or higher of one of our [JavaScript SDKs](https://github.com/getsentry/sentry-javascript). Once you're using a supported SDK, the process works as follows: | ||
|
|
||
| 1. **A globally unique debug id is generated**: During the build process a **debug id** is generated, which is globally unique and ideally deterministic (typically a UUID). | ||
|
|
||
| 2. **Debug IDs are embedded in minified files**: Each minified JavaScript file includes a special comment, such as `//# debugId=DEBUG_ID`, where `DEBUG_ID` is the unique identifier generated in the previous step. | ||
|
|
||
| 3. **The same debug id is added to source maps**: Source maps also include the same **debug id** as a new attribute, linking the minified JavaScript file to its corresponding source map. | ||
|
|
||
| 4. **Stack traces in Sentry link the debug id**: When an error occurs, Sentry's event contains the **debug id**, which allows Sentry to automatically link the error to the correct source map. This ensures the stack trace is resolved back to the original source code, providing you with clearer and more accurate debugging information—even if the JavaScript has been minified or transformed. | ||
|
|
||
| ### Why use Debug IDs to uniminify your code? | ||
|
|
||
| Unminifying your code is essential for effective debugging. While there are other [legacy ways](https://docs.sentry.io/platforms/javascript/sourcemaps/troubleshooting_js/legacy-uploading-methods/) to achieve this at Sentry, using Debug IDs is recommended by Sentry as it is the most reliable and deterministic method. By unminifying your code, you get much clearer stack traces when errors occur. Instead of seeing obfuscated code, you'll see the exact code you originally wrote, making it far easier to understand and resolve issues. Below are examples that demonstrates the difference: | ||
|
|
||
| #### Bad Stack Trace | ||
|  | ||
|
|
||
| #### Good Stack Trace | ||
|  | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.