\n\n[](https://www.npmjs.com/package/toucan-js)\n[](https://www.npmjs.com/package/toucan-js)\n[](https://www.npmjs.com/package/toucan-js)\n\n# toucan-js\n\n**Toucan** is a [Sentry](https://docs.sentry.io/) client for [Cloudflare Workers](https://developers.cloudflare.com/workers/) written in TypeScript.\n\n- **Reliable**: In Cloudflare Workers isolate model, it is inadvisable to [set or mutate global state within the event handler](https://developers.cloudflare.com/workers/about/how-it-works). Toucan was created with Workers' concurrent model in mind. No race-conditions, no undelivered logs, no nonsense metadata in Sentry.\n- **Flexible:** Supports `fetch` and `scheduled` Workers, their `.mjs` equivalents, and `Durable Objects`.\n- **Familiar API:** Follows [Sentry unified API guidelines](https://develop.sentry.dev/sdk/unified-api/).\n\n## Features\n\nThis SDK provides all options and methods of [ScopeClass](https://github.com/getsentry/sentry-javascript/blob/master/packages/core/src/scope.ts) and additionally:\n\n### Additional constructor options\n\n| Option | Type | Description |\n| ------------------ | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| context | Context | This can be any object that contains [waitUntil](https://developers.cloudflare.com/workers/about/tips/fetch-event-lifecycle/). It can be [FetchEvent](https://developers.cloudflare.com/workers/runtime-apis/fetch-event), [ScheduledEvent](https://developers.cloudflare.com/workers/runtime-apis/scheduled-event), [DurableObjectState](https://developers.cloudflare.com/workers/runtime-apis/durable-objects), or [.mjs context](https://community.cloudflare.com/t/2021-4-15-workers-runtime-release-notes/261917). |\n| request | Request | If set, the SDK will send information about incoming requests to Sentry. By default, only the request method and request origin + pathname are sent. If you want to include more data, you need to use `requestDataOptions` option. |\n| requestDataOptions | RequestDataOptions | Object containing allowlist for specific parts of request. Refer to sensitive data section below. |\n\n### Constructor options overrides\n\n#### Transport options\n\nOn top of base `transportOptions` you can pass additional configuration:\n\n| Option | Type | Description |\n| ------- | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| headers | Record | Custom headers passed to fetch. |\n| fetcher | typeof fetch | Custom fetch function. This can be useful for tests or when the global `fetch` used by `toucan-js` doesn't satisfy your use-cases. Note that custom fetcher must conform to `fetch` interface. |\n\n### Additional methods\n\n- `Toucan.setEnabled(enabled: boolean): void`: Can be used to disable and again enable the SDK later in your code.\n- `Toucan.setRequestBody(body: unknown): void`: Attaches request body to future events. `body` can be anything serializable.\n\n## Integrations\n\nYou can use custom integrations to enhance `toucan-js` as you would any other Sentry SDK. Some integrations are provided in various [Sentry packages](https://github.com/getsentry/sentry-javascript/tree/develop/packages), and you can also write your own! To ensure an integration will work properly in `toucan-js`, it must:\n\n- not enhance or wrap global runtime methods (such as `console.log`).\n- not use runtime APIs that aren't available in Cloudflare Workers (NodeJS runtime functions, `window` object, etc...).\n\nSupported integrations from [@sentry/core](https://github.com/getsentry/sentry-javascript/tree/develop/packages/core) are re-exported from `toucan-js`:\n\n- [dedupeIntegration](https://github.com/getsentry/sentry-javascript/blob/master/packages/integrations/src/dedupe.ts)\n- [extraErrorDataIntegration](https://github.com/getsentry/sentry-javascript/blob/master/packages/integrations/src/extraerrordata.ts)\n- [rewriteFramesIntegration](https://github.com/getsentry/sentry-javascript/blob/master/packages/integrations/src/rewriteframes.ts)\n- [sessionTimingIntegration](https://github.com/getsentry/sentry-javascript/blob/master/packages/integrations/src/sessiontiming.ts)\n\n`toucan-js` also provides 2 integrations that are enabled by default, but are provided if you need to reconfigure them:\n\n- [linkedErrorsIntegration](src/integrations/linkedErrors.ts)\n- [requestDataIntegration](src/integrations/requestData.ts)\n- [zodErrorsIntegration](src/integrations/zod/zoderrors.ts)\n\n### Custom integration example:\n\n```ts\nimport { Toucan, rewriteFramesIntegration } from 'toucan-js';\n\ntype Env = {\n SENTRY_DSN: string;\n};\n\nexport default {\n async fetch(request, env, context): Promise {\n const sentry = new Toucan({\n dsn: env.SENTRY_DSN,\n context,\n request,\n integrations: [rewriteFramesIntegration({ root: '/' })],\n });\n\n ...\n },\n} as ExportedHandler;\n```\n\n## Sensitive data\n\nBy default, Toucan does not send any request data that might contain [PII (Personally Identifiable Information)](https://docs.sentry.io/data-management/sensitive-data/) to Sentry.\n\nThis includes:\n\n- request headers\n- request cookies\n- request search params\n- request body\n- user's IP address (read from `CF-Connecting-Ip` header)\n\nYou will need to explicitly allow these data using:\n\n- `allowedHeaders` option (array of headers or Regex or boolean)\n- `allowedCookies` option (array of cookies or Regex or boolean)\n- `allowedSearchParams` option (array of search params or Regex or boolean)\n- `allowedIps` option (array of search params or Regex or boolean)\n\nThese options are available on [RequestData](src/integrations/requestData.ts) integration or `requestDataOptions` option (which is passed down to [RequestData](src/integrations/requestData.ts) automatically).\n","readmeFilename":"README.md"}
![\"Logo\"](\"https://i.imgur.com/zHw4F3x.jpg\")
\n