feat: Add initial documentation for cloudflare sdk #11145
Conversation
AbhiPrasad
requested review from
andreiborza,
a team and
mydea
and removed request for
a team
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
Bundle ReportChanges will increase total bundle size by 5.55kB ⬆️
|
| @@ -13,7 +13,8 @@ notSupported: | |||
| - javascript.hapi | |||
| - javascript.koa | |||
| - javascript.nestjs | |||
| - javascript.deno | |||
| - javascript. | |||
There was a problem hiding this comment.
Accidentally replaced deno here?
| @@ -0,0 +1,8 @@ | |||
| title: Cloudflare | |||
| description: 'Official Sentry SDK for Cloudflare Workers and Cloudflare Pages.' | |||
| sdk: sentry.javascript.bun | |||
There was a problem hiding this comment.
| sdk: sentry.javascript.bun | |
| sdk: sentry.javascript.cloudflare |
| app. | ||
|
|
||
| ```javascript | ||
| // functions/_middleware.js |
There was a problem hiding this comment.
Can we move that into the { filename } directive instead?
| To use this SDK, wrap your handler with the `withSentry` function. This will initialize the SDK and hook into the | ||
| environment. Note that you can turn off almost all side effects using the respective options. | ||
|
|
||
| Currently only ESM handlers are supported. |
There was a problem hiding this comment.
l: I'd pack this into a <Note> and move it to after the snippet, wdyt?
There was a problem hiding this comment.
Yeah I like that, will make the change.
| <SignInNote /> | ||
|
|
||
| ```javascript | ||
| import * as Sentry from "@sentry/bun"; |
There was a problem hiding this comment.
| import * as Sentry from "@sentry/bun"; | |
| import * as Sentry from "@sentry/cloudflare"; |
| app. | ||
|
|
||
| ```javascript | ||
| // functions/_middleware.js |
There was a problem hiding this comment.
Same suggestion as above, can we move that into the { filename } directive instead?
| To use this SDK, wrap your handler with the `withSentry` function. This will initialize the SDK and hook into the | ||
| environment. Note that you can turn off almost all side effects using the respective options. | ||
|
|
||
| Currently only ESM handlers are supported. |
There was a problem hiding this comment.
l: Same as above: I'd pack this into a <Note> and move it to after the snippet, wdyt?
AbhiPrasad
force-pushed
the
abhi-cloudflare-sdk-docs
branch
from
8bd801f
to
959db0f
Compare
DESCRIBE YOUR PR
ref getsentry/sentry-javascript#13363
This PR adds docs for the Sentry Cloudflare SDK. It adds basic instructions for Cloudflare Workers, and Cloudflare Pages.
In follow-up PRs to this, I'll add framework specific guides.
IS 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