|
| 1 | +--- |
| 2 | +title: What are Debug IDs |
| 3 | +sidebar_order: 7 |
| 4 | +--- |
| 5 | + |
| 6 | +This documentation provides an in-depth look at Debug IDs, explaining how they work and why Sentry recommends using them. Visit [Uploading Source Maps](https://docs.sentry.io/platforms/javascript/guides/react/sourcemaps/uploading/) if you're looking for our guides on how to upload source maps. |
| 7 | + |
| 8 | +## Introduction |
| 9 | + |
| 10 | +Modern web applications often use some kind of build process when using JavaScript. 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). |
| 11 | + |
| 12 | +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, transpilation, downcompilation, bundling, polyfilling, and others, aimed at improving performance and ensuring cross-browser compatibility. Some common tools that transform code in such ways are Babel, Vite, Webpack, Rollup, Terser, or SWC - which are often used by higher-level tools like Next.js, Nuxt, Create React App, and similar. |
| 13 | + |
| 14 | +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 and you can't connect them to your source code repository. |
| 15 | + |
| 16 | +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 additional pieces information (often stored as files) that map the transformed JavaScript back to the original code. This allows Sentry to associate the error with your original source, which means you’ll get stack traces that look like the code you wrote, not the code you generated. |
| 17 | + |
| 18 | +To connect source maps to a JavaScript file, we relied on filenames, but these often were unreliable. For example, when you changed the subpath of where your javascript files are served it would mean that the filenames no longer match and the corresponding sourcemap would not be able to be found by Sentry. |
| 19 | + |
| 20 | +`//# source mappingURL=http://example.com/path/to/your/source-map.js.map` |
| 21 | + |
| 22 | +Given the url-based filename approach was unreliable, we came up with [Debug IDs](/platforms/javascript/sourcemaps/debug-ids#what-are-debug-ids). |
| 23 | + |
| 24 | +## What are Debug IDs |
| 25 | + |
| 26 | +Inspired by approaches in native language ecosystems, Debug IDs are globally unique ids that identify a transformed JavaScript file and its associated source map. |
| 27 | + |
| 28 | + |
| 29 | + |
| 30 | +When using sentry-cli or Sentry plugins for Webpack, Vite, or Rollup, Debug IDs are deterministically generated based on the source file contents. Note that deterministic Debug IDs for esbuild are not currently supported. |
| 31 | + |
| 32 | +This approach is Sentry's recommended and most reliable method for associating minified JavaScript files with their original source code, making it easier to trace errors back to their source. Because debug IDs will generally change across releasess if the file content is changed **creating a release is no longer required**. Release names were previously used to disambiguate sourcemaps with the same name across deployments. |
| 33 | + |
| 34 | +<Alert> |
| 35 | + |
| 36 | +If you want to learn more about the rationale behind Debug IDs, we suggest taking a look at our [engineering blog](https://sentry.engineering/blog/the-case-for-debug-ids). |
| 37 | + |
| 38 | +</Alert> |
| 39 | + |
| 40 | +## How Sentry uses Debug IDs |
| 41 | + |
| 42 | +<PlatformSection notSupported={["javascript.nextjs"]}> |
| 43 | + To use Debug IDs, ensure that you're using **Sentry's SDK version 7.47 or higher**. Once you're on a supported version, follow the steps outlined below: |
| 44 | +</PlatformSection> |
| 45 | +<PlatformSection supported={["javascript.nextjs"]}> |
| 46 | + For Debug IDs with Next.js, you’ll need **Sentry's SDK version 8.0.0 or higher**. Once you're on a supported version, follow the steps outlined below: |
| 47 | +</PlatformSection> |
| 48 | + |
| 49 | + |
| 50 | +1. **A globally unique Debug ID is generated**: During the build process, if you are using one of Sentry's Bundler Plugins or Sentry CLI a Debug ID is generated, which is globally unique and ideally deterministic. |
| 51 | + |
| 52 | +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. |
| 53 | + |
| 54 | +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. |
| 55 | + |
| 56 | +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. |
| 57 | + |
| 58 | +### Why use Debug IDs to uniminify your code? |
| 59 | + |
| 60 | +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 are recommended by Sentry** as it is the most reliable 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: |
| 61 | + |
| 62 | +#### Bad Stack Trace |
| 63 | + |
| 64 | + |
| 65 | +#### Good Stack Trace |
| 66 | + |
| 67 | + |
| 68 | +## Retention Policy |
| 69 | + |
| 70 | +Artifacts including Debug IDs have a retention period of _90 days_, using a _time to idle_ expiration mechanism. |
| 71 | +This means that uploaded Debug IDs are retained for as long as they are actively being used for event processing. |
| 72 | +Once an ID has not been used to process incoming events for at least 90 days, it will automatically expire and be eligible for deletion. |
| 73 | + |
| 74 | +## Associating a Release with Debug IDs |
| 75 | + |
| 76 | +Since you might still want to know to which release an specific Debug ID is connected to, we designed a new way to still associate a `release` to your bundle. |
| 77 | + |
| 78 | +The new Debug ID format supports a new kind of association to a `release` and optionally `dist`, known as weak release association. This type of association **will not require the creation of a `release`** before uploading source maps and will consequently allow the creation of a `release` as a separate step down the pipeline. |
| 79 | + |
| 80 | +With an associated `release` and optionally `dist` you will be able to quickly go to the Debug ID from your `release` in Sentry, without having to worry about which Debug ID was used for your errors. |
0 commit comments