docs(bun): Document the build plugin in the instrumentation step - #19361
Draft
JPeer264 wants to merge 1 commit into
Draft
docs(bun): Document the build plugin in the instrumentation step#19361JPeer264 wants to merge 1 commit into
JPeer264 wants to merge 1 commit into
Conversation
The guide told users to run `bun --preload ./instrument.js app.js` and then warned that auto-instrumentation doesn't work with bundled code, which is backwards: library and framework spans exist only in a build, and `@sentry/bun/plugin` was never named on the page. The two compose. `--preload` guarantees init order and is always needed; the plugin build adds library and framework spans on top. Verified in the runtime audit repro `quickstarts/bun` variant (c): a `sentryBunPlugin()` bundle run with `--preload` produced errors, route-named `Bun.serve` spans, `http.client` spans carrying `sentry-trace` and `baggage`, and logs. - Add an optional "Build With the Sentry Plugin" step using `sentryBunPlugin`, before the run step - Reframe the `--preload` step as what guarantees init order, and show it for both source and built output - Drop the "Bundled Code Limitation" alert, which claimed the opposite - Add a troubleshooting entry for an instrumented package left outside the bundle, which is what silences library spans in a plugin build - Add `logs` to the onboarding options, so the logs verify block already on the page can be selected Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
github-actions
Bot
added
the
Priority: Needs Triage
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
DESCRIBE YOUR PR
The guide told users to run
bun --preload ./instrument.js app.jsand then warned that auto-instrumentation doesn't work with bundled code, which is backwards: library and framework spans exist only in a build, and@sentry/bun/pluginwas never named on the page.The two compose.
--preloadguarantees init order and is always needed; the plugin build adds library and framework spans on top. Verified in the runtime audit reproquickstarts/bunvariant (c): asentryBunPlugin()bundle run with--preloadproduced errors, route-namedBun.servespans,http.clientspans carryingsentry-traceandbaggage, and logs.sentryBunPlugin, before the run step--preloadstep as what guarantees init order, and show it for both source and built outputlogsto the onboarding options, so the logs verify block already on the page can be selectedIS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace
YYYY-MM-DDwith the due date. You can update this information later by editing the PR description.SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
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.
EXTRA RESOURCES