feat(source-maps): Add doc explaining Debug IDs #13100

priscilawebdev · 2025-03-24T09:44:03Z

Contributes to We repeat Debug ID(s) over and over and it would be great if we could simplify the copies. sentry#85615

vercel · 2025-03-24T09:44:08Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
sentry-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 26, 2025 10:23am

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
changelog	⬜️ Ignored (Inspect)	Visit Preview		Mar 26, 2025 10:23am
develop-docs	⬜️ Ignored (Inspect)	Visit Preview		Mar 26, 2025 10:23am

codecov · 2025-03-24T09:49:59Z

Bundle Report

Changes will increase total bundle size by 741 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes

Bundle name	Size	Change
sentry-docs-server-cjs	10.59MB	747 bytes (0.01%) ⬆️
sentry-docs-client-array-push	9.43MB	-6 bytes (-0.0%) ⬇️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name	Size Change	Total Size	Change (%)
`1729.js`	-3 bytes	1.58MB	-0.0%
`../instrumentation.js`	-3 bytes	907.85kB	-0.0%
`9523.js`	-3 bytes	883.91kB	-0.0%
`../app/[[...path]]/page.js.nft.json`	252 bytes	382.98kB	0.07%
`../app/platform-redirect/page.js.nft.json`	252 bytes	382.89kB	0.07%
`../app/sitemap.xml/route.js.nft.json`	252 bytes	380.87kB	0.07%

view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name	Size Change	Total Size	Change (%)
`static/chunks/pages/_app-*.js`	-3 bytes	869.05kB	-0.0%
`static/chunks/3464-*.js`	-3 bytes	394.39kB	-0.0%
`server/middleware-*.js`	5.55kB	6.55kB	555.3% ⚠️
`server/middleware-*.js`	-5.55kB	1.0kB	-84.74%
`static/vZz0QHBBVNxI7FIGzwcu1/_buildManifest.js` (New)	578 bytes	578 bytes	100.0% 🚀
`static/vZz0QHBBVNxI7FIGzwcu1/_ssgManifest.js` (New)	77 bytes	77 bytes	100.0% 🚀
~~`static/lhMYwKv2B4K_hw_f9PDST/_buildManifest.js`~~ (Deleted)	-578 bytes	0 bytes	-100.0% 🗑️
~~`static/lhMYwKv2B4K_hw_f9PDST/_ssgManifest.js`~~ (Deleted)	-77 bytes	0 bytes	-100.0% 🗑️

krystofwoldrich · 2025-03-24T10:24:03Z

Thank you, I've read through it, and it makes sense to me.

For RN I can add it later to https://docs.sentry.io/platforms/react-native/sourcemaps/debug-ids with RN-specific links to https://metrobundler.dev/docs/concepts and https://github.com/facebook/hermes/blob/main/doc/Features.md

lforst

Just one thing I immediately saw

docs/platforms/javascript/common/sourcemaps/debug-ids/index.mdx

Co-authored-by: Luca Forstner <[email protected]>

priscilawebdev · 2025-03-25T08:28:33Z

redirects.js

+  {
+    source: '/platforms/javascript/sourcemaps/troubleshooting_js/artifact-bundles/',
+    destination: '/platforms/javascript/sourcemaps/troubleshooting_js/debug-ids/',
+  },


This was the only change I made to the file, the rest was likely due to my code formatter

priscilawebdev · 2025-03-25T08:36:08Z

platform-includes/sourcemaps/artifact-bundles/javascript.mdx

@@ -1,36 +0,0 @@
-This article explains the inner workings of Artifact Bundles, and the implications of using them. Visit [Uploading Source Maps](/platforms/javascript/guides/react/sourcemaps/uploading/) if you're looking for our guides on how to upload source maps.


it seems that this file is not being used.

priscilawebdev · 2025-03-25T08:37:53Z

docs/platforms/javascript/common/sourcemaps/troubleshooting_js/debug-ids/index.mdx

+#### Bad Stack Trace
+![bad stack trace example](./img/bad-stack-trace.png)
+
+#### Good Stack Trace
+![good stack trace example](./img/good-stack-trace.png)


@smeubank I will improve this in a follow-up. will try to have something similar to what we display in that hydration issue

lforst

Love it! 👌

Gave it a pass for accuracy. All of my feedback is optional, apply as you see fit!

docs/platforms/javascript/common/sourcemaps/troubleshooting_js/debug-ids/index.mdx

lforst · 2025-03-26T09:10:59Z

docs/platforms/javascript/common/sourcemaps/troubleshooting_js/debug-ids/index.mdx

+
+## 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:


Suggested change

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:

To use Debug IDs, you need **version 7.47.0** 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:

technically for nextjs at least i think v8 is required

should we hide this info then? I got it from somewhere

I wouldn't hide it, but maybe show it differently if the selected platform is Next.js. The nextjs sdk indeed supports sourcemaps from 8.0.0 onwards.

yes but it can be that JavaScript is selected and it provides an overall info so I have to say about Next JS, right?

docs/platforms/javascript/common/sourcemaps/troubleshooting_js/debug-ids/index.mdx

smeubank · 2025-03-26T09:31:59Z

LGTM! I just read through and saw Luca addressed everything and more that I would've mentioned

smeubank · 2025-03-26T09:27:29Z

docs/platforms/javascript/common/sourcemaps/troubleshooting_js/debug-ids/index.mdx

+
+## 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:


technically for nextjs at least i think v8 is required

…/debug-ids/index.mdx Co-authored-by: Luca Forstner <[email protected]>

docs/platforms/javascript/common/sourcemaps/troubleshooting_js/debug-ids/index.mdx

…/debug-ids/index.mdx

…/debug-ids/index.mdx Co-authored-by: Luca Forstner <[email protected]>

docs/platforms/javascript/common/sourcemaps/troubleshooting_js/debug-ids/index.mdx

…/debug-ids/index.mdx

AbhiPrasad · 2025-03-26T15:44:44Z

@priscilawebdev this PR is causing some 404 issues: https://github.com/getsentry/sentry-docs/actions/runs/14080645380/job/39432623331

🌐 http://localhost:3000/platforms/javascript/guides/fastify/sourcemaps/troubleshooting_js/debug-ids
    - [Debug IDs](/platforms/javascript/sourcemaps/debug-ids/#what-are-debug-ids)

🌐 http://localhost:3000/platforms/javascript/guides/gatsby/sourcemaps/troubleshooting_js/debug-ids
    - [Debug IDs](/platforms/javascript/sourcemaps/debug-ids/#what-are-debug-ids)

🌐 http://localhost:3000/platforms/javascript/guides/gcp-functions/sourcemaps/troubleshooting_js/debug-ids
    - [Debug IDs](/platforms/javascript/sourcemaps/debug-ids/#what-are-debug-ids)

🌐 http://localhost:3000/platforms/javascript/guides/hapi/sourcemaps/troubleshooting_js/debug-ids
    - [Debug IDs](/platforms/javascript/sourcemaps/debug-ids/#what-are-debug-ids)

🌐 http://localhost:3000/platforms/javascript/guides/hono/sourcemaps/troubleshooting_js/debug-ids
    - [Debug IDs](/platforms/javascript/sourcemaps/debug-ids/#what-are-debug-ids)

🌐 http://localhost:3000/platforms/javascript/guides/koa/sourcemaps/troubleshooting_js/debug-ids
    - [Debug IDs](/platforms/javascript/sourcemaps/debug-ids/#what-are-debug-ids)

🌐 http://localhost:3000/platforms/javascript/guides/nestjs/sourcemaps/troubleshooting_js/debug-ids
    - [Debug IDs](/platforms/javascript/sourcemaps/debug-ids/#what-are-debug-ids)

🌐 http://localhost:3000/platforms/javascript/guides/nextjs/sourcemaps/troubleshooting_js/debug-ids
    - [Debug IDs](/platforms/javascript/sourcemaps/debug-ids/#what-are-debug-ids)

🌐 http://localhost:3000/platforms/javascript/guides/node/sourcemaps/troubleshooting_js/debug-ids
    - [Debug IDs](/platforms/javascript/sourcemaps/debug-ids/#what-are-debug-ids)

🌐 http://localhost:3000/platforms/javascript/guides/nuxt/sourcemaps/troubleshooting_js/debug-ids
    - [Debug IDs](/platforms/javascript/sourcemaps/debug-ids/#what-are-debug-ids)

🌐 http://localhost:3000/platforms/javascript/guides/react/sourcemaps/troubleshooting_js/debug-ids
    - [Debug IDs](/platforms/javascript/sourcemaps/debug-ids/#what-are-debug-ids)

🌐 http://localhost:3000/platforms/javascript/guides/react-router/sourcemaps/troubleshooting_js/debug-ids
    - [Debug IDs](/platforms/javascript/sourcemaps/debug-ids/#what-are-debug-ids)

🌐 http://localhost:3000/platforms/javascript/guides/remix/sourcemaps/troubleshooting_js/debug-ids
    - [Debug IDs](/platforms/javascript/sourcemaps/debug-ids/#what-are-debug-ids)

🌐 http://localhost:3000/platforms/javascript/guides/solid/sourcemaps/troubleshooting_js/debug-ids
    - [Debug IDs](/platforms/javascript/sourcemaps/debug-ids/#what-are-debug-ids)

🌐 http://localhost:3000/platforms/javascript/guides/solidstart/sourcemaps/troubleshooting_js/debug-ids
    - [Debug IDs](/platforms/javascript/sourcemaps/debug-ids/#what-are-debug-ids)

🌐 http://localhost:3000/platforms/javascript/guides/svelte/sourcemaps/troubleshooting_js/debug-ids
    - [Debug IDs](/platforms/javascript/sourcemaps/debug-ids/#what-are-debug-ids)

🌐 http://localhost:3000/platforms/javascript/guides/sveltekit/sourcemaps/troubleshooting_js/debug-ids
    - [Debug IDs](/platforms/javascript/sourcemaps/debug-ids/#what-are-debug-ids)

🌐 http://localhost:3000/platforms/javascript/guides/tanstackstart-react/sourcemaps/troubleshooting_js/debug-ids
    - [Debug IDs](/platforms/javascript/sourcemaps/debug-ids/#what-are-debug-ids)

🌐 http://localhost:3000/platforms/javascript/guides/vue/sourcemaps/troubleshooting_js/debug-ids
    - [Debug IDs](/platforms/javascript/sourcemaps/debug-ids/#what-are-debug-ids)

🌐 http://localhost:3000/platforms/javascript/guides/wasm/sourcemaps/troubleshooting_js/debug-ids
    - [Debug IDs](/platforms/javascript/sourcemaps/debug-ids/#what-are-debug-ids)

👉 Note: the markdown syntax is not necessarily present on the source files, but the links do exist on the final pages

feat(source-maps): Add doc explaining Debug IDs

047ad12

priscilawebdev requested review from krystofwoldrich, lforst and smeubank March 24, 2025 09:55

vercel bot deployed to Preview – sentry-docs March 24, 2025 09:57 View deployment

lforst reviewed Mar 24, 2025

View reviewed changes

docs/platforms/javascript/common/sourcemaps/debug-ids/index.mdx Outdated Show resolved Hide resolved

Update docs/platforms/javascript/common/sourcemaps/debug-ids/index.mdx

93b1327

Co-authored-by: Luca Forstner <[email protected]>

vercel bot deployed to Preview – sentry-docs March 24, 2025 12:04 View deployment

feedback

ee01726

priscilawebdev commented Mar 25, 2025

View reviewed changes

vercel bot deployed to Preview – develop-docs March 25, 2025 08:33 View deployment

add one more redirect

087a347

priscilawebdev commented Mar 25, 2025

View reviewed changes

priscilawebdev requested a review from lforst March 25, 2025 08:38

vercel bot deployed to Preview – develop-docs March 25, 2025 08:43 View deployment

vercel bot deployed to Preview – sentry-docs March 25, 2025 08:57 View deployment

priscilawebdev mentioned this pull request Mar 25, 2025

We repeat Debug ID(s) over and over and it would be great if we could simplify the copies. getsentry/sentry#85615

Closed

priscilawebdev requested a review from a team March 26, 2025 07:07

obostjancic approved these changes Mar 26, 2025

View reviewed changes

lforst approved these changes Mar 26, 2025

View reviewed changes

smeubank approved these changes Mar 26, 2025

View reviewed changes

priscilawebdev and others added 4 commits March 26, 2025 10:36

Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…

0ef287f

…/debug-ids/index.mdx Co-authored-by: Luca Forstner <[email protected]>

Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…

52ec520

…/debug-ids/index.mdx Co-authored-by: Luca Forstner <[email protected]>

Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…

0c762c0

…/debug-ids/index.mdx Co-authored-by: Luca Forstner <[email protected]>

Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…

e24d193

…/debug-ids/index.mdx Co-authored-by: Luca Forstner <[email protected]>

priscilawebdev and others added 7 commits March 26, 2025 10:40

Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…

b8076fc

…/debug-ids/index.mdx Co-authored-by: Luca Forstner <[email protected]>

Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…

65d332c

…/debug-ids/index.mdx Co-authored-by: Luca Forstner <[email protected]>

Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…

1123482

…/debug-ids/index.mdx Co-authored-by: Luca Forstner <[email protected]>

Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…

9dbbff2

…/debug-ids/index.mdx Co-authored-by: Luca Forstner <[email protected]>

Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…

f4124a2

…/debug-ids/index.mdx Co-authored-by: Luca Forstner <[email protected]>

Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…

9019f5f

…/debug-ids/index.mdx Co-authored-by: Luca Forstner <[email protected]>

Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…

295c533

…/debug-ids/index.mdx Co-authored-by: Luca Forstner <[email protected]>

priscilawebdev commented Mar 26, 2025

View reviewed changes

docs/platforms/javascript/common/sourcemaps/troubleshooting_js/debug-ids/index.mdx Outdated Show resolved Hide resolved

priscilawebdev and others added 3 commits March 26, 2025 10:44

Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…

72ad839

…/debug-ids/index.mdx

Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…

78f08df

…/debug-ids/index.mdx Co-authored-by: Luca Forstner <[email protected]>

Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…

59ebf8a

…/debug-ids/index.mdx Co-authored-by: Luca Forstner <[email protected]>

priscilawebdev commented Mar 26, 2025

View reviewed changes

docs/platforms/javascript/common/sourcemaps/troubleshooting_js/debug-ids/index.mdx Outdated Show resolved Hide resolved

Update docs/platforms/javascript/common/sourcemaps/troubleshooting_js…

313ab62

…/debug-ids/index.mdx

vercel bot deployed to Preview – sentry-docs March 26, 2025 10:06 View deployment

add specific version for next.js

0fc6e4c

vercel bot deployed to Preview – sentry-docs March 26, 2025 10:23 View deployment

priscilawebdev merged commit 8361005 into master Mar 26, 2025
12 of 13 checks passed

priscilawebdev deleted the priscila/feat/source-maps/add-debug-ids-doc branch March 26, 2025 10:25

priscilawebdev mentioned this pull request Mar 26, 2025

fix(debug-ids): Fix broken link #13133

Merged

github-actions bot locked and limited conversation to collaborators Apr 11, 2025

		@@ -1,36 +0,0 @@
		This article explains the inner workings of Artifact Bundles, and the implications of using them. Visit [Uploading Source Maps](/platforms/javascript/guides/react/sourcemaps/uploading/) if you're looking for our guides on how to upload source maps.


		## 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:

Uh oh!

feat(source-maps): Add doc explaining Debug IDs #13100

feat(source-maps): Add doc explaining Debug IDs #13100

Uh oh!

Conversation

priscilawebdev commented Mar 24, 2025

Uh oh!

vercel bot commented Mar 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Mar 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bundle Report

Affected Assets, Files, and Routes:

Assets Changed:

Assets Changed:

Uh oh!

krystofwoldrich commented Mar 24, 2025

Uh oh!

lforst left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lforst left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

smeubank commented Mar 26, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AbhiPrasad commented Mar 26, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

vercel bot commented Mar 24, 2025 •

edited

Loading

codecov bot commented Mar 24, 2025 •

edited

Loading

lforst left a comment •

edited

Loading