Skip to content

ref(js): Mention debug ids in sourcemap docs #13646

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

mydea
Copy link
Member

@mydea mydea commented May 9, 2025

This PR:

  • Reorders the source maps troubleshooting docs to have the debug ids section first (makes more sense imho?)
  • Adds a section mentioning debug ids

Closes https://linear.app/getsentry/issue/FE-398/user-feedback-debug-ids-tooling

@mydea mydea requested review from lforst and andreiborza May 9, 2025 06:29
@mydea mydea self-assigned this May 9, 2025
Copy link

vercel bot commented May 9, 2025

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 May 9, 2025 7:04am
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview May 9, 2025 7:04am
develop-docs ⬜️ Ignored (Inspect) Visit Preview May 9, 2025 7:04am

Copy link

codecov bot commented May 9, 2025

Bundle Report

Changes will decrease total bundle size by 15 bytes (-0.0%) ⬇️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 11.16MB -9 bytes (-0.0%) ⬇️
sentry-docs-client-array-push 9.48MB -6 bytes (-0.0%) ⬇️

Affected Assets, Files, and Routes:

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 868.7kB -0.0%
static/chunks/8165-*.js -3 bytes 410.1kB -0.0%
static/AQx8oHM8qVFDMRYw9INW8/_buildManifest.js (New) 578 bytes 578 bytes 100.0% 🚀
static/AQx8oHM8qVFDMRYw9INW8/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/cQ9usO5IVs3WZvlZcuSeC/_buildManifest.js (Deleted) -578 bytes 0 bytes -100.0% 🗑️
static/cQ9usO5IVs3WZvlZcuSeC/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️
view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.75MB -0.0%
../instrumentation.js -3 bytes 1.08MB -0.0%
9523.js -3 bytes 1.05MB -0.0%

Copy link
Member

@lforst lforst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reordering 👍 the note idk.. It especially doesn't solve the feeback in the linked lnear issue.

<PlatformSection notSupported={["javascript.capacitor", "javascript.cordova"]}>
<Alert>

By default, Sentry will link source maps by injecting <PlatformLink to="/sourcemaps/troubleshooting_js/debug-ids/">Debug IDs</PlatformLink> into your build output. Alternatively, there are also <PlatformLink to="/sourcemaps/troubleshooting_js/legacy-uploading-methods/">other methods</PlatformLink> to associate source maps with Sentry that do not require modifying your build output.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Idk about "by default" here...

@@ -16,6 +16,14 @@ This guide assumes you are using a Browser JavaScript SDK. For instructions on h

If you want to configure source maps to upload manually, follow the guide for your bundler or build tool below.

<PlatformSection notSupported={["javascript.capacitor", "javascript.cordova"]}>
<Alert>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure I like this note. Feels out of place honestly.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm I am very open to rephrase this, but IMHO it does make sense to mention here what all the things we are talking about on this page and subpages actually does (=inject debug ids into your build files)?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants