Skip to content

docs(angular): Clarify native Debug IDs and integrity-safe uploads - #19888

Open
sansynx wants to merge 4 commits into
getsentry:masterfrom
sansynx:docs/angular-native-debug-ids
Open

sansynx wants to merge 4 commits into
getsentry:masterfrom
sansynx:docs/angular-native-debug-ids

Conversation

@sansynx

@sansynx sansynx commented Oct 10, 2026

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

The Angular CLI and Nx guides now distinguish application/esbuild builds from webpack builds. They document upload-only release-and-URL matching for applications that need to preserve Angular's integrity hashes, while keeping the existing bundler-plugin instructions.

Angular 22.1.0 adds an ECMA-426 comment and source-map field, but not the runtime registration Sentry's JavaScript SDK reads. Sentry CLI 3.8.0 also skips injection when that comment already exists. The guide explains this limitation instead of treating native IDs as a complete Sentry setup.

Verified against the Angular 22.1.0 release, Angular's injection implementation, Sentry SDK 11.6.0's ID lookup, and Sentry CLI 3.8.0's injection logic. A local CLI reproduction confirmed that an Angular-style artifact is skipped without adding runtime globals. Targeted formatting, link linting, and MDX compilation passed. Local site generation is blocked by the existing Windows missing parent and grandparent: api error, so the rendered preview still needs review.

Refs #18923

This change was prepared with AI assistance. It has not been tested against a live Sentry project.

IS YOUR CHANGE URGENT?

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: Not urgent, can wait up to 1 week+

PRE-MERGE CHECKLIST

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

@vercel

vercel Bot commented Oct 10, 2026

Copy link
Copy Markdown

@sansynx is attempting to deploy a commit to the Sentry Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Oct 10, 2026
@sansynx
sansynx marked this pull request as ready for review October 10, 2026 02:47
Copilot AI balanced review requested due to automatic review settings October 10, 2026 02:47

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 10, 2026 02:47
@cursor

cursor Bot commented Oct 10, 2026 •

Copy link
Copy Markdown
Contributor

Two source-map upload guides add an upload-only path and keep the bundler-plugin steps. The plan checks client errors on those guides, traffic on the same paths, and errors on sibling source-map pages. An issue escalates when a new error title appears or those page errors rise.

Services: sentry-docs.

Mention @change-monitor in a comment to update the plan.

Plan

What changed

Readers of the Angular CLI and Nx source-map upload pages now see a new Application and esbuild section. That section tells them to upload with Sentry CLI and match by release and URL. Webpack and bundler-plugin steps stay on the same pages under new headings.
This change is live after sentry-docs deploys. The pages are /platforms/javascript/guides/angular/sourcemaps/uploading/angular-webpack/ and /platforms/javascript/guides/angular/sourcemaps/uploading/angular-nx/.

Risk

A missing include returns nothing, so the new section can vanish while the page still loads. Any other include error can fail static generation of those two pages. Shared MDX render errors can also hit sibling Angular source-map pages. Customer apps that follow the new upload steps are outside this site.

Intended effect

This change is a docs edit. The new section text is not a queryable signal. Do not treat a live page or a file check as confirmation. absent means the new Application and esbuild wording is not on those pages. Telemetry cannot decide that axis.

Regression watch

A missing include does not throw. Watch client errors and page traffic instead. Traces use a 30 percent sample rate. The same promise-rejection title already fires once per source-map page in this window. Treat that title as background noise at one event per page.

Signal Baseline Window Source Rule
Client errors on the two changed page URLs 1 event per page. Title is Event: Event \Event` (type=error) captured as promise rejection`. Combined count 2. 2026-10-03T02:47:52Z to 2026-10-10T02:47:52Z Sentry project docs. Query environment:production url:*/platforms/javascript/guides/angular/sourcemaps/uploading/angular-webpack/* or the angular-nx URL. Hold at 0-2 events per page for that title. Escalate if a new title appears or either page rises above 2.
Client errors on sibling Angular source-map pages 18 events. One event per page across 18 URLs. Same promise-rejection title. Transaction is /:path*?. 2026-10-03T02:47:52Z to 2026-10-10T02:47:52Z Sentry project docs. Query environment:production url:*/platforms/javascript/guides/angular/sourcemaps/* Hold at 14-22 events for that title. Escalate if a new title appears or the count rises above 22.
Pageload and navigation volume on the webpack guide 17 sampled spans. p95 duration 4283ms. 2026-10-03T02:47:52Z to 2026-10-10T02:47:52Z Sentry project docs. Query environment:production AND (span.op:pageload OR span.op:navigation) AND url.path:"/platforms/javascript/guides/angular/sourcemaps/uploading/angular-webpack/" Hold near 10-24 sampled spans. Escalate if the count falls to 0 while the Angular source-map overview still has traffic.
Pageload and navigation volume on the Nx guide 3 sampled spans. p95 duration 1539ms. 2026-10-03T02:47:52Z to 2026-10-10T02:47:52Z Sentry project docs. Query environment:production AND (span.op:pageload OR span.op:navigation) AND url.path:"/platforms/javascript/guides/angular/sourcemaps/uploading/angular-nx/" Traffic is sparse. A zero count is not a regression by itself. Use it only with a new error title or a webpack-guide drop.

If errors rise, check logs for include or MDX compile failures on those two pages.

Not observable

Whether the new Application and esbuild section text is present on the page. HTTP status for these paths. No http.server spans returned in the 7d window. p95 latency bands. Only one 7d aggregate exists and the sample is small. Whether readers follow the CLI upload path. Whether customer integrity hashes or source-map matching stay valid.

@sansynx

sansynx commented Oct 13, 2026

Copy link
Copy Markdown
Contributor Author

the branch is up to date. could you approve the pending workflows and authorize the Vercel preview when you review this?

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants