diff --git a/docs/platforms/javascript/guides/cloudflare/features/durableobject.mdx b/docs/platforms/javascript/guides/cloudflare/features/durableobject.mdx new file mode 100644 index 0000000000000..42ed662c57fa7 --- /dev/null +++ b/docs/platforms/javascript/guides/cloudflare/features/durableobject.mdx @@ -0,0 +1,25 @@ +--- +title: Cloudflare Durable Objects +description: "Learn how to add Sentry instrumentation for Cloudflare Durable Objects." +--- + +_(Available in version [9.16.0](https://github.com/getsentry/sentry-javascript/releases/tag/9.16.0) and above)_ + +You can use the `instrumentDurableObjectWithSentry` method to instrument [Cloudflare Durable Objects](https://developers.cloudflare.com/durable-objects/). + +```javascript +import * as Sentry from "@sentry/cloudflare"; + +class MyDurableObjectBase extends DurableObject { + // impl +} + +// Export your named class as defined in your wrangler config +export const MyDurableObject = Sentry.instrumentDurableObjectWithSentry( + (env) => ({ + dsn: "___PUBLIC_DSN___", + tracesSampleRate: 1.0, + }), + MyDurableObjectBase, +); +``` diff --git a/docs/platforms/javascript/guides/cloudflare/index.mdx b/docs/platforms/javascript/guides/cloudflare/index.mdx index 831cf0b29bde1..df4490598f1c3 100644 --- a/docs/platforms/javascript/guides/cloudflare/index.mdx +++ b/docs/platforms/javascript/guides/cloudflare/index.mdx @@ -72,11 +72,11 @@ export const onRequest = [ // Make sure Sentry is the first middleware Sentry.sentryPagesPlugin((context) => ({ dsn: "___PUBLIC_DSN___", - + // Adds request headers and IP for users, for more info visit: // https://docs.sentry.io/platforms/javascript/guides/cloudflare/configuration/options/#sendDefaultPii sendDefaultPii: true, - + // ___PRODUCT_OPTION_START___ performance // Set tracesSampleRate to 1.0 to capture 100% of spans for tracing. // Learn more at @@ -118,7 +118,7 @@ If you do not have access to the `onRequest` middleware API, you can use the `wr ```javascript // hooks.server.js -import * as Sentry from '@sentry/cloudflare'; +import * as Sentry from "@sentry/cloudflare"; export const handle = ({ event, resolve }) => { const requestHandlerOptions = { @@ -133,6 +133,12 @@ export const handle = ({ event, resolve }) => { }; ``` +### Cloudflare Durable Objects + +You can use the `instrumentDurableObjectWithSentry` method to instrument [Cloudflare Durable Objects](https://developers.cloudflare.com/durable-objects/). This will need to be done alongside the worker setup. + +See the [Cloudflare Durable Objects](features/durableobject/) guide for more information. + ## Add Readable Stack Traces to Errors Depending on how you've set up your project, the stack traces in your Sentry errors probably don't look like your actual code.