feat: Add initial documentation for cloudflare sdk

getsentry · Aug 26, 2024 · a25f852 · a25f852
1 parent 58ff6df
commit a25f852
Show file tree

Hide file tree

Showing 61 changed files with 399 additions and 47 deletions.
diff --git a/docs/platforms/javascript/common/configuration/integrations/breadcrumbs.mdx b/docs/platforms/javascript/common/configuration/integrations/breadcrumbs.mdx
@@ -14,6 +14,7 @@ notSupported:
   - javascript.koa
   - javascript.nestjs
   - javascript.deno
+  - javascript.cloudflare
   - javascript.bun
 ---
 

diff --git a/docs/platforms/javascript/common/configuration/integrations/browserapierrors.mdx b/docs/platforms/javascript/common/configuration/integrations/browserapierrors.mdx
@@ -14,6 +14,7 @@ notSupported:
   - javascript.koa
   - javascript.nestjs
   - javascript.deno
+  - javascript.cloudflare
   - javascript.bun
 ---
 

diff --git a/docs/platforms/javascript/common/configuration/integrations/browserprofiling.mdx b/docs/platforms/javascript/common/configuration/integrations/browserprofiling.mdx
@@ -13,7 +13,8 @@ notSupported:
   - javascript.hapi
   - javascript.koa
   - javascript.nestjs
-  - javascript.deno
+  - javascript.
+  - javascript.cloudflare
   - javascript.bun
 ---
 

diff --git a/docs/platforms/javascript/common/configuration/integrations/browsertracing.mdx b/docs/platforms/javascript/common/configuration/integrations/browsertracing.mdx
@@ -14,6 +14,7 @@ notSupported:
   - javascript.koa
   - javascript.nestjs
   - javascript.deno
+  - javascript.cloudflare
   - javascript.bun
 ---
 

diff --git a/docs/platforms/javascript/common/configuration/integrations/console.mdx b/docs/platforms/javascript/common/configuration/integrations/console.mdx
@@ -21,6 +21,7 @@ supported:
   - javascript.astro
   - javascript.bun
   - javascript.deno
+  - javascript.cloudflare
 ---
 
 <Alert level="info">

diff --git a/docs/platforms/javascript/common/configuration/integrations/contextlines.mdx b/docs/platforms/javascript/common/configuration/integrations/contextlines.mdx
@@ -14,6 +14,7 @@ notSupported:
   - javascript.koa
   - javascript.nestjs
   - javascript.deno
+  - javascript.cloudflare
   - javascript.bun
 ---
 

diff --git a/docs/platforms/javascript/common/configuration/integrations/httpclient.mdx b/docs/platforms/javascript/common/configuration/integrations/httpclient.mdx
@@ -13,6 +13,7 @@ notSupported:
   - javascript.koa
   - javascript.nestjs
   - javascript.deno
+  - javascript.cloudflare
   - javascript.bun
 ---
 

diff --git a/docs/platforms/javascript/common/configuration/integrations/httpcontext.mdx b/docs/platforms/javascript/common/configuration/integrations/httpcontext.mdx
@@ -14,6 +14,7 @@ notSupported:
   - javascript.koa
   - javascript.nestjs
   - javascript.deno
+  - javascript.cloudflare
   - javascript.bun
 ---
 

diff --git a/docs/platforms/javascript/common/configuration/integrations/localvariables.mdx b/docs/platforms/javascript/common/configuration/integrations/localvariables.mdx
@@ -20,6 +20,7 @@ supported:
   - javascript.remix
   - javascript.astro
   - javascript.bun
+  - javascript.cloudflare
   - javascript.deno
 ---
 

diff --git a/docs/platforms/javascript/common/configuration/integrations/modulemetadata.mdx b/docs/platforms/javascript/common/configuration/integrations/modulemetadata.mdx
@@ -15,8 +15,7 @@ notSupported:
   - javascript.nestjs
   - javascript.deno
   - javascript.bun
-  - javascript.deno
-  - javascript.bun
+  - javascript.cloudflare
 ---
 
 <Alert level="info">

diff --git a/docs/platforms/javascript/common/configuration/integrations/modules.mdx b/docs/platforms/javascript/common/configuration/integrations/modules.mdx
@@ -21,6 +21,7 @@ supported:
   - javascript.astro
   - javascript.bun
   - javascript.deno
+  - javascript.cloudflare
 ---
 
 <Alert level="info">

diff --git a/.../platforms/javascript/common/configuration/integrations/onuncaughtexception.mdx b/.../platforms/javascript/common/configuration/integrations/onuncaughtexception.mdx
@@ -21,6 +21,7 @@ supported:
   - javascript.astro
   - javascript.bun
   - javascript.deno
+  - javascript.cloudflare
 ---
 
 <Alert level="info">

diff --git a/docs/platforms/javascript/common/configuration/integrations/replay.mdx b/docs/platforms/javascript/common/configuration/integrations/replay.mdx
@@ -16,8 +16,7 @@ notSupported:
   - javascript.hapi
   - javascript.koa
   - javascript.nestjs
-  - javascript.deno
-  - javascript.bun
+  - javascript.cloudflare
 ---
 
 <Alert level="info">

diff --git a/docs/platforms/javascript/common/configuration/integrations/replaycanvas.mdx b/docs/platforms/javascript/common/configuration/integrations/replaycanvas.mdx
@@ -16,8 +16,7 @@ notSupported:
   - javascript.hapi
   - javascript.koa
   - javascript.nestjs
-  - javascript.deno
-  - javascript.bun
+  - javascript.cloudflare
 ---
 
 <Alert level="info">

diff --git a/docs/platforms/javascript/common/configuration/integrations/reportingobserver.mdx b/docs/platforms/javascript/common/configuration/integrations/reportingobserver.mdx
@@ -14,6 +14,7 @@ notSupported:
   - javascript.nestjs
   - javascript.deno
   - javascript.bun
+  - javascript.cloudflare
 ---
 
 <Alert level="info">

diff --git a/docs/platforms/javascript/common/configuration/integrations/requestdata.mdx b/docs/platforms/javascript/common/configuration/integrations/requestdata.mdx
@@ -20,8 +20,7 @@ supported:
   - javascript.sveltekit
   - javascript.remix
   - javascript.astro
-  - javascript.bun
-  - javascript.deno
+  - javascript.cloudflare
 ---
 
 <Alert level="info">

diff --git a/docs/platforms/javascript/common/configuration/integrations/trpc.mdx b/docs/platforms/javascript/common/configuration/integrations/trpc.mdx
@@ -21,6 +21,7 @@ supported:
   - javascript.astro
   - javascript.deno
   - javascript.bun
+  - javascript.cloudflare
 ---
 
 <Alert level="info">

diff --git a/docs/platforms/javascript/common/configuration/integrations/unhandledrejection.mdx b/docs/platforms/javascript/common/configuration/integrations/unhandledrejection.mdx
@@ -21,6 +21,7 @@ supported:
   - javascript.astro
   - javascript.bun
   - javascript.deno
+  - javascript.cloudflare
 ---
 
 <Alert level="info">

diff --git a/docs/platforms/javascript/common/crons/index.mdx b/docs/platforms/javascript/common/crons/index.mdx
@@ -20,11 +20,12 @@ supported:
   - javascript.koa
   - javascript.nestjs
   - javascript.nuxt
+  - javascript.cloudflare
 ---
 
 Once implemented, it'll allow you to get alerts and metrics to help you solve errors, detect timeouts, and prevent disruptions to your service.
 
-<PlatformSection supported={["javascript.nextjs", "javascript.sveltekit", "javascript.remix", "javascript.astro", "javascript.bun", "javascript.deno", 'javascript.node', 'javascript.aws-lambda', 'javascript.azure-functions', 'javascript.connect', 'javascript.express', "javascript.fastify", 'javascript.gcp-functions', 'javascript.hapi', 'javascript.koa', 'javascript.nestjs']}>
+<PlatformSection supported={['javascript.nextjs', 'javascript.sveltekit', 'javascript.remix', 'javascript.astro', 'javascript.bun', 'javascript.deno', 'javascript.cloudflare', 'javascript.node', 'javascript.aws-lambda', 'javascript.azure-functions', 'javascript.connect', 'javascript.express', "javascript.fastify", 'javascript.gcp-functions', 'javascript.hapi', 'javascript.koa', 'javascript.nestjs']}>
 
 ## Requirements
 
@@ -34,7 +35,7 @@ Once implemented, it'll allow you to get alerts and metrics to help you solve er
 
 </PlatformSection>
 
-<PlatformSection notSupported={["javascript.nextjs", "javascript.sveltekit", "javascript.remix", "javascript.astro", "javascript.bun", "javascript.deno", 'javascript.node', 'javascript.aws-lambda', 'javascript.azure-functions', 'javascript.connect', 'javascript.express', 'javascript.fastify', 'javascript.gcp-functions', 'javascript.hapi', 'javascript.koa', 'javascript.nestjs']}>
+<PlatformSection notSupported={['javascript.nextjs', 'javascript.sveltekit', 'javascript.remix', 'javascript.astro', 'javascript.bun', 'javascript.deno', 'javascript.cloudflare', 'javascript.node', 'javascript.aws-lambda', 'javascript.azure-functions', 'javascript.connect', 'javascript.express', 'javascript.fastify', 'javascript.gcp-functions', 'javascript.hapi', 'javascript.koa', 'javascript.nestjs']}>
 
 ## Requirements
 

diff --git a/docs/platforms/javascript/common/crons/troubleshooting.mdx b/docs/platforms/javascript/common/crons/troubleshooting.mdx
@@ -20,6 +20,7 @@ supported:
   - javascript.koa
   - javascript.nestjs
   - javascript.nuxt
+  - javascript.cloudflare
 ---
 
 <PlatformCategorySection supported={['server', 'serverless']}>

diff --git a/docs/platforms/javascript/common/install/index.mdx b/docs/platforms/javascript/common/install/index.mdx
@@ -25,6 +25,7 @@ notSupported:
   - javascript.aws-lambda
   - javascript.azure-functions
   - javascript.gcp-functions
+  - javascript.cloudflare
 ---
 
 <PageGrid />

diff --git a/docs/platforms/javascript/common/install/loader.mdx b/docs/platforms/javascript/common/install/loader.mdx
@@ -30,6 +30,7 @@ notSupported:
   - javascript.hapi
   - javascript.koa
   - javascript.nestjs
+  - javascript.cloudflare
 ---
 
 The Loader Script is the easiest way to initialize the Sentry SDK. The Loader Script also automatically keeps your Sentry SDK up to date and offers configuration for different Sentry features.

diff --git a/docs/platforms/javascript/common/install/npm.mdx b/docs/platforms/javascript/common/install/npm.mdx
@@ -32,6 +32,7 @@ notSupported:
   - javascript.hapi
   - javascript.koa
   - javascript.nestjs
+  - javascript.cloudflare
 ---
 
 <PlatformContent includePath="getting-started-install" />
diff --git a/docs/platforms/javascript/common/profiling/index.mdx b/docs/platforms/javascript/common/profiling/index.mdx
@@ -7,6 +7,7 @@ notSupported:
   - javascript.bun
   - javascript.cordova
   - javascript.deno
+  - javascript.cloudflare
 description: "Collect & view performance insights for JavaScript programs with Sentry’s JavaScript Profiling integration. Get started with browser profiling here."
 ---
 

diff --git a/docs/platforms/javascript/common/session-replay/configuration.mdx b/docs/platforms/javascript/common/session-replay/configuration.mdx
@@ -16,6 +16,7 @@ notSupported:
   - javascript.hapi
   - javascript.koa
   - javascript.nestjs
+  - javascript.cloudflare
 description: "Learn about the general Session Replay configuration fields."
 ---
 

diff --git a/docs/platforms/javascript/common/session-replay/index.mdx b/docs/platforms/javascript/common/session-replay/index.mdx
@@ -16,6 +16,7 @@ notSupported:
   - javascript.hapi
   - javascript.koa
   - javascript.nestjs
+  - javascript.cloudflare
 description: "Learn how to enable Session Replay in your app if it is not already set up."
 ---
 
@@ -44,7 +45,7 @@ To set up the integration, add the following to your Sentry initialization. Ther
   fallbackPlatform="javascript"
 />
 
-<PlatformSection notSupported={["javascript.deno", "javascript.bun", "javascript.wasm", "javascript.capacitor", "javascript.electron"]}>
+<PlatformSection notSupported={["javascript.deno", "javascript.bun", "javascript.wasm", "javascript.capacitor", "javascript.electron", "javascript.cloudflare"]}>
 
 ### Canvas Recording
 

diff --git a/docs/platforms/javascript/common/session-replay/issue-types.mdx b/docs/platforms/javascript/common/session-replay/issue-types.mdx
@@ -16,6 +16,7 @@ notSupported:
   - javascript.hapi
   - javascript.koa
   - javascript.nestjs
+  - javascript.cloudflare
 description: "Learn about the Issue types that Session Replay can detect."
 ---
 
@@ -32,7 +33,8 @@ You can configure which issue types are created by visiting Project Settings > R
 Sometimes rage or dead clicks will be detected on elements which are not expected to mutate the DOM, like a "Print" or "Download" button. In this case, you can configure `slowClickIgnoreSelectors`, which will prevent those buttons from generating new issues.
 
 <Note>
-You'll need to have SDK version 7.60.1 or higher in order to be able to see **rage click issues**.
+  You'll need to have SDK version 7.60.1 or higher in order to be able to see
+  **rage click issues**.
 </Note>
 
 ## Configuring Hydration Errors
@@ -52,5 +54,6 @@ You can have your preferences configured in one of four ways:
 | disabled | disabled | Issue created from captured error data. |
 
 <Note>
-You'll need to have SDK version 7.87.0 or higher in order to be able to detect **hydration error issues** from replay data.
+  You'll need to have SDK version 7.87.0 or higher in order to be able to detect
+  **hydration error issues** from replay data.
 </Note>
diff --git a/docs/platforms/javascript/common/session-replay/privacy.mdx b/docs/platforms/javascript/common/session-replay/privacy.mdx
@@ -16,6 +16,7 @@ notSupported:
   - javascript.hapi
   - javascript.koa
   - javascript.nestjs
+  - javascript.cloudflare
 description: "Configuring Session Replay to maintain user and data privacy."
 ---
 

diff --git a/docs/platforms/javascript/common/session-replay/troubleshooting.mdx b/docs/platforms/javascript/common/session-replay/troubleshooting.mdx
@@ -16,6 +16,7 @@ notSupported:
   - javascript.hapi
   - javascript.koa
   - javascript.nestjs
+  - javascript.cloudflare
 excerpt: ""
 description: "Troubleshooting Session Replay-specific Issues"
 ---
@@ -31,6 +32,7 @@ If you are on a supported SDK version and your `canvas` elements still aren't ge
 <Expandable title="Replay is slowing down my `canvas`" permalink>
 
 The integration needs to enable `preserveDrawingBuffer` to export images from 3D and WebGL canvases. This can negatively affect canvas performance. If your canvas application is impacted by enabling `preserveDrawingBuffer`, you'll need to <PlatformLink to="/session-replay/#canvas-recording-performance">enable manual snapshotting</PlatformLink> and call a `snapshot()` method inside of your re-paint loop.
+
 </Expandable>
 
 <Expandable title="My custom CSS/images/fonts/media aren't appearing when I view the Replay" permalink>
@@ -48,7 +50,7 @@ Due to [browser limitations](https://developer.mozilla.org/en-US/docs/Web/SVG/El
 
 <Expandable title="Why am I seeing too many or too few rage clicks?" permalink>
 
-There might be fewer rage clicks than you expect if the user stopped waiting for the site to respond before the 7 second threshold. This is why the rage click issues that you *do* see are so valuable, because the user that clicked at least 3 times and continued waiting at least 7 seconds for the site to respond is likely very frustrated.
+There might be fewer rage clicks than you expect if the user stopped waiting for the site to respond before the 7 second threshold. This is why the rage click issues that you _do_ see are so valuable, because the user that clicked at least 3 times and continued waiting at least 7 seconds for the site to respond is likely very frustrated.
 
 You might also see more rage clicks than you expected from buttons that don't trigger a DOM mutation or page scroll (such as "Print" and "Download" buttons). There is no reliable way for the SDK to detect that a download or print has initiated, so a slow click might be generated even if the button is not actually "dead". For these cases, you can configure the SDK via `slowClickIgnoreSelectors` - see [Configuration](/platforms/javascript/session-replay/configuration/) for more details.
 
@@ -66,7 +68,6 @@ Sentry.replayIntegration({
 
 </Expandable>
 
-
 <Expandable title="Why can't I see the full HTTP request body or all the headers?" permalink>
 
 By default, Replay will capture basic information about all outgoing fetch and XHR requests in your application. This includes the URL, request and response body size, method, and status code.
@@ -103,6 +104,7 @@ We're always working on ways to reduce the bundle size. Additionally, there are
 The Sentry SDK attempts to minimize potential [performance overhead](/product/explore/session-replay/performance-overhead/#how-is-session-replay-optimized) in a few different ways. For example, by keeping track of the number of DOM mutations that are happening then disabling recording when a large number of changes are detected. Many simultaneous mutations can slow down a web page whether Session Replay is installed or not, but when a large number of mutations happen, the Replay client can incur an additional slowdown because it records each change.
 
 If you're seeing the "A large number of mutations was detected" message while watching a replay, it means that your page could be optimized. For example, a dropdown list with thousands of entries could be refactored so that rows are virtualized where only the visible rows are rendered in the DOM. Another potential solution is to paginate the results fetch more data as the user scrolls through it. The SDK has a <PlatformLink to="/session-replay/configuration/#mutation-limits">configuration</PlatformLink> that allows you to configure the limits before recording stops.
+
 </Expandable>
 
 <Expandable title="Text in the iframe isn't masked" permalink>
@@ -142,12 +144,17 @@ With this configuration, Replay is able to capture response bodies from Apollo C
 </Expandable>
 
 <Expandable title="`console` calls are triggering replays to record" permalink>
-Using the [`captureConsoleIntegration`](https://docs.sentry.io/platforms/javascript/configuration/integrations/captureconsole/) can cause replays to record as if you have triggered an exception. You can use [`beforeErrorSampling`](https://docs.sentry.io/platforms/javascript/guides/sveltekit/session-replay/understanding-sessions/#ignore-certain-errors-for-error-sampling) to avoid this behavior.
+  Using the
+  [`captureConsoleIntegration`](https://docs.sentry.io/platforms/javascript/configuration/integrations/captureconsole/)
+  can cause replays to record as if you have triggered an exception. You can use
+  [`beforeErrorSampling`](https://docs.sentry.io/platforms/javascript/guides/sveltekit/session-replay/understanding-sessions/#ignore-certain-errors-for-error-sampling)
+  to avoid this behavior.
 </Expandable>
 
 <Expandable title="Clicks are incorrectly resulting in a dead or rage click" permalink>
 
 There are certain cases (such as clicking a button to play an audio clip) where Sentry incorrectly records a click as a dead click (note: rage clicks are a subset of dead clicks). As a workaround, you can use the [`slowClickIgnoreSelector`](/platforms/javascript/session-replay/configuration/#general-integration-configuration) configuration option to ignore dead clicks for specific selectors.
 
 If you want to turn off [rage click issues](/product/issues/issue-details/replay-issues/) altogether, you can disable them by going to the **Settings** page in Sentry, clicking "Projects", and selecting the project for which you want to disable rage clicks. From here, select "Replays" under the "PROCESSING" heading and toggle off "Create Rage Click Issues".
+
 </Expandable>
diff --git a/docs/platforms/javascript/common/session-replay/understanding-sessions.mdx b/docs/platforms/javascript/common/session-replay/understanding-sessions.mdx
@@ -16,6 +16,7 @@ notSupported:
   - javascript.hapi
   - javascript.koa
   - javascript.nestjs
+  - javascript.cloudflare
 description: "Learn about customizing sessions with the Session Replay SDK."
 ---
 
@@ -198,7 +199,6 @@ replayIntegration({
 If you return `false` from this method for a given error, we will not check the error sample rate for this error.
 If you return `true`, we will continue to check the error sample rate as normal.
 
-
 ### Connect Replays with Support Software
 
 Replays do not need to be connected to an application error, they can also be used to supplement your support tickets.
@@ -227,13 +227,13 @@ Sentry.init({
  * Your widget will need to have an event/hook to trigger flushing the replay to
  * Sentry.
  */
-MySupportWidget.on('open', () => {
+MySupportWidget.on("open", () => {
   const replay = Sentry.getReplay();
   // Send replay to Sentry
   replay.flush();
   // Retrieve the replay id that was saved and attach it to your support widget
   const replayId = replay.getReplayId();
-  MySupportWidget.setTag('replayId', replayId);
+  MySupportWidget.setTag("replayId", replayId);
 });
 
 /**

diff --git a/docs/platforms/javascript/common/tracing/index.mdx b/docs/platforms/javascript/common/tracing/index.mdx
@@ -13,7 +13,9 @@ If you’re adopting Tracing in a high-throughput environment, we recommend test
 
 </Note>
 
-<PlatformSection notSupported={["javascript.deno", "javascript.bun"]}>
+<PlatformSection
+  notSupported={["javascript.deno", "javascript.bun", "javascript.cloudflare"]}
+>
   <Alert level="note">
     Sentry can integrate with <strong>OpenTelemetry</strong>. You can find more
     information about it