docs(cloudflare): Add Vite usage - #18844
Open
JPeer264 wants to merge 1 commit into
Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
andreiborza
reviewed
Jul 28, 2026
|
|
||
| The Sentry Cloudflare Vite plugin (`sentryCloudflareVitePlugin`) instruments your Worker at build time. It can: | ||
|
|
||
| 1. **Instrument bundled dependencies** — injects [`diagnostics_channel.tracingChannel`](https://nodejs.org/api/diagnostics_channel.html#class-tracingchannel) calls into supported packages (such as database clients like `mysql`) so the SDK can trace them without monkey-patching, which the Cloudflare Workers runtime (`workerd`) doesn't support. This gives you more traces out of the box. |
Member
There was a problem hiding this comment.
l: For me this explains internal details too much. I wouldn't even talk about injecting channels and whatnot. Just that it automatically instruments your bundled dependencies at build time?
| 1. **Instrument bundled dependencies** — injects [`diagnostics_channel.tracingChannel`](https://nodejs.org/api/diagnostics_channel.html#class-tracingchannel) calls into supported packages (such as database clients like `mysql`) so the SDK can trace them without monkey-patching, which the Cloudflare Workers runtime (`workerd`) doesn't support. This gives you more traces out of the box. | ||
| 2. **Auto-instrument your Worker entry** — optionally wraps your default export with `Sentry.withSentry()` and Durable Objects with `instrumentDurableObjectWithSentry()` at build time, so you don't need to modify your code. | ||
|
|
||
| **We recommend building your Cloudflare Worker with Vite and this plugin.** It's the most complete way to get tracing for bundled dependencies in the Workers runtime, where runtime monkey-patching isn't available. If you already deploy with `wrangler` directly, see [Migrating From Wrangler](#migrating-from-wrangler). |
Member
There was a problem hiding this comment.
Suggested change
| **We recommend building your Cloudflare Worker with Vite and this plugin.** It's the most complete way to get tracing for bundled dependencies in the Workers runtime, where runtime monkey-patching isn't available. If you already deploy with `wrangler` directly, see [Migrating From Wrangler](#migrating-from-wrangler). | |
| **We recommend building your Cloudflare Worker with Vite and the `sentryCloudflareVitePlugin` plugin.** It's the most complete way to get tracing for bundled dependencies in the Workers runtime, where runtime monkey-patching isn't available. If you already deploy with `wrangler` directly, see [Migrating From Wrangler](#migrating-from-wrangler). |
| 1. **Instrument bundled dependencies** — injects [`diagnostics_channel.tracingChannel`](https://nodejs.org/api/diagnostics_channel.html#class-tracingchannel) calls into supported packages (such as database clients like `mysql`) so the SDK can trace them without monkey-patching, which the Cloudflare Workers runtime (`workerd`) doesn't support. This gives you more traces out of the box. | ||
| 2. **Auto-instrument your Worker entry** — optionally wraps your default export with `Sentry.withSentry()` and Durable Objects with `instrumentDurableObjectWithSentry()` at build time, so you don't need to modify your code. | ||
|
|
||
| **We recommend building your Cloudflare Worker with Vite and this plugin.** It's the most complete way to get tracing for bundled dependencies in the Workers runtime, where runtime monkey-patching isn't available. If you already deploy with `wrangler` directly, see [Migrating From Wrangler](#migrating-from-wrangler). |
Member
There was a problem hiding this comment.
l: I wouldn't talk about runtime monkey-patching. Again, too much internal detail. I'd just drop the "when runtime monkey-patchign isn't available" as a whole.
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
2 participants
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
With that we recommend to use Vite instead of plain
wrangler. This also documents the new 2 experimental flags withuseDiagnosticsChannelInjectionandautoInstrument. In the quick start we even adduseDiagnosticsChannelInjectionin order to get the most out of the instrumentationsIS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
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