feat(cloudflare): Add Spotlight integration for local dev event forwarding#22490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JPeer264 merged 6 commits into from
Jul 24, 2026
Merged

feat(cloudflare): Add Spotlight integration for local dev event forwarding #22490

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
60fbfc1
feat(cloudflare): Add Spotlight integration for local dev event forwa…
MathurAditya724 Jul 22, 2026
320966e
fix(cloudflare): Add spotlight property to BaseCloudflareOptions
MathurAditya724 Jul 22, 2026
c1568fe
fix: Address review findings — spotlight precedence, indent, test gaps
MathurAditya724 Jul 22, 2026
169f735
fix(cloudflare): Remove non-functional dev-only markers around spotli…
MathurAditya724 Jul 22, 2026
bd9bc63
Merge branch 'develop' into feat/cloudflare-spotlight-integration
MathurAditya724 Jul 22, 2026
dff8f1b
feat(cloudflare): Add dev/prod bundle in favor of spotlight
JPeer264 Jul 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .size-limit.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -436,7 +436,7 @@ module.exports = [
// Cloudflare SDK (ESM) - compressed, minified to match `wrangler deploy --dry-run --minify` output
{
name: '@sentry/cloudflare (withSentry) - minified',
path: 'packages/cloudflare/build/esm/index.js',
path: 'packages/cloudflare/build/esm/prod/index.js',
import: createImport('withSentry', 'instrumentDurableObjectWithSentry', 'instrumentWorkflowWithSentry'),
ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
gzip: false,
Expand All@@ -456,7 +456,7 @@ module.exports = [
// Cloudflare SDK (ESM) - uncompressed, unminified to match `wrangler deploy --dry-run` output
{
name: '@sentry/cloudflare (withSentry)',
path: 'packages/cloudflare/build/esm/index.js',
path: 'packages/cloudflare/build/esm/prod/index.js',
import: createImport('withSentry', 'instrumentDurableObjectWithSentry', 'instrumentWorkflowWithSentry'),
ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
gzip: false,
Expand Down
56 changes: 23 additions & 33 deletions packages/cloudflare/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,50 +12,40 @@
"files": [
"/build"
],
"main": "build/cjs/index.js",
"module": "build/esm/index.js",
"main": "build/cjs/prod/index.js",
"module": "build/esm/prod/index.js",
"types": "build/types/index.d.ts",
"exports": {
"./package.json": "./package.json",
".": {
"import": {
"types": "./build/types/index.d.ts",
"default": "./build/esm/index.js"
"types": "./build/types/index.d.ts",
"development": {
"import": "./build/esm/dev/index.js",
"require": "./build/cjs/dev/index.js"
},
"require": {
"types": "./build/types/index.d.ts",
"default": "./build/cjs/index.js"
"production": {
"import": "./build/esm/prod/index.js",
"require": "./build/cjs/prod/index.js"
},
"default": {
"import": "./build/esm/prod/index.js",
"require": "./build/cjs/prod/index.js"
}
},
"./request": {
"import": {
"types": "./build/types/request.d.ts",
"default": "./build/esm/request.js"
},
"require": {
"types": "./build/types/request.d.ts",
"default": "./build/cjs/request.js"
}
"types": "./build/types/request.d.ts",
"import": "./build/esm/prod/request.js",
"require": "./build/cjs/prod/request.js"
},
"./nodejs_compat": {
"import": {
"types": "./build/types/nodejs_compat/index.d.ts",
"default": "./build/esm/nodejs_compat/index.js"
},
"require": {
"types": "./build/types/nodejs_compat/index.d.ts",
"default": "./build/cjs/nodejs_compat/index.js"
}
"types": "./build/types/nodejs_compat/index.d.ts",
"import": "./build/esm/prod/nodejs_compat/index.js",
"require": "./build/cjs/prod/nodejs_compat/index.js"
},
"./vite": {
"import": {
"types": "./build/types/vite/index.d.ts",
"default": "./build/esm/vite/index.js"
},
"require": {
"types": "./build/types/vite/index.d.ts",
"default": "./build/cjs/vite/index.js"
}
"types": "./build/types/vite/index.d.ts",
"import": "./build/esm/prod/vite/index.js",
"require": "./build/cjs/prod/vite/index.js"
}
},
"publishConfig": {
Expand DownExpand Up@@ -98,7 +88,7 @@
"clean": "rimraf build coverage sentry-cloudflare-*.tgz",
"lint:fix": "OXLINT_TSGOLINT_DANGEROUSLY_SUPPRESS_PROGRAM_DIAGNOSTICS=true oxlint . --fix --type-aware",
"lint": "OXLINT_TSGOLINT_DANGEROUSLY_SUPPRESS_PROGRAM_DIAGNOSTICS=true oxlint . --type-aware",
"lint:es-compatibility": "es-check es2022 ./build/cjs/*.js && es-check es2022 ./build/esm/*.js --module",
"lint:es-compatibility": "es-check es2022 ./build/cjs/prod/*.js && es-check es2022 ./build/esm/prod/*.js --module",
"test": "yarn test:unit",
"test:unit": "vitest run",
"test:watch": "vitest --watch",
Expand Down
1 change: 1 addition & 0 deletions packages/cloudflare/rollup.npm.config.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,4 +4,5 @@ export default makeNPMConfigVariants(
makeBaseNPMConfig({
entrypoints: ['src/index.ts', 'src/nodejs_compat/index.ts', 'src/vite/index.ts'],
}),
{ splitDevProd: true },
);
12 changes: 12 additions & 0 deletions packages/cloudflare/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -253,6 +253,18 @@ interface BaseCloudflareOptions {
* @default false
*/
instrumentPrototypeMethods?: boolean | string[];

/**
* If you use Spotlight by Sentry during development, use
* this option to forward captured Sentry events to Spotlight.
*
* Either set it to true, or provide a specific Spotlight Sidecar URL.
*
* More details: https://spotlightjs.com/
*
* IMPORTANT: Only set this option to `true` while developing, not in production!
*/
spotlight?: boolean | string;
}

/**
Expand Down
1 change: 1 addition & 0 deletions packages/cloudflare/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,7 @@ export { getDefaultIntegrations } from './sdk';

export { httpServerIntegration } from './integrations/httpServer';
export { fetchIntegration } from './integrations/fetch';
export { spotlightIntegration } from './integrations/spotlight';
export { vercelAIIntegration } from './integrations/tracing/vercelai';

// eslint-disable-next-line typescript/no-deprecated
Expand Down
89 changes: 89 additions & 0 deletions packages/cloudflare/src/integrations/spotlight.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
import type { Client, Envelope, IntegrationFn } from '@sentry/core';
import { debug, defineIntegration, serializeEnvelope, suppressTracing } from '@sentry/core';
import { DEBUG_BUILD } from '../debug-build';

type SpotlightConnectionOptions = {
/**
* Set this if the Spotlight Sidecar is not running on localhost:8969.
* By default, the URL is set to http://localhost:8969/stream
*/
sidecarUrl?: string;
};

export const INTEGRATION_NAME = 'Spotlight' as const;

const _spotlightIntegration = ((options: Partial<SpotlightConnectionOptions> = {}) => {
const sidecarUrl = options.sidecarUrl || 'http://localhost:8969/stream';

return {
name: INTEGRATION_NAME,
setup(client) {
DEBUG_BUILD && debug.log('[Spotlight] Using Sidecar URL', sidecarUrl);
setupSidecarForwarding(client, sidecarUrl);
},
};
}) satisfies IntegrationFn;

/**
* Use this integration to send errors and transactions to Spotlight.
*
* Learn more about spotlight at https://spotlightjs.com
*
* Important: This integration is intended for local development only.
* Each forwarded envelope counts as a Worker subrequest (50 free / 1000 paid
* per invocation), so it should not be enabled in production.
*/
export const spotlightIntegration = defineIntegration(_spotlightIntegration);

function setupSidecarForwarding(client: Client, sidecarUrl: string): void {
const parsedUrl = parseSidecarUrl(sidecarUrl);
if (!parsedUrl) {
return;
}

let failCount = 0;

client.on('beforeEnvelope', (envelope: Envelope) => {
if (failCount > 3) {
DEBUG_BUILD && debug.warn('[Spotlight] Disabled Sentry -> Spotlight forwarding due to too many failed requests');
return;
}

const body = serializeEnvelope(envelope);

suppressTracing(() => {
fetch(parsedUrl.href, {
method: 'POST',
body,
headers: {
'Content-Type': 'application/x-sentry-envelope',
},
}).then(
res => {
// Consume the response body to satisfy Cloudflare Workers' requirement
// that all fetch response bodies are read or cancelled.
res.text().catch(() => {
// no-op
});

if (res.status >= 200 && res.status < 400) {
failCount = 0;
}
},
() => {
failCount++;
DEBUG_BUILD && debug.warn('[Spotlight] Failed to send envelope to Spotlight Sidecar');
},
);
});
});
}

function parseSidecarUrl(url: string): URL | undefined {
try {
return new URL(url);
} catch {
DEBUG_BUILD && debug.warn(`[Spotlight] Invalid sidecar URL: ${url}`);
return undefined;
}
}
38 changes: 38 additions & 0 deletions packages/cloudflare/src/options.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,14 @@ export function getFinalOptions(userOptions: CloudflareOptions = {}, env: unknow
const tracesSampleRate =
userOptions.tracesSampleRate ?? parseFloat(getEnvVar(env, 'SENTRY_TRACES_SAMPLE_RATE') ?? '');

// Spotlight precedence (mirrors node-core's getSpotlightConfig):
// - false or explicit string from options: use as-is
// - true: enable, but prefer a custom URL from the env var if set
// - undefined: defer entirely to the env var (bool or URL)
/*! rollup-include-development-only */
const spotlight = getSpotlightFromEnv(userOptions.spotlight, getEnvVar(env, 'SENTRY_SPOTLIGHT'));
/*! rollup-include-development-only-end */

return {
release,
...userOptions,
Expand All@@ -62,5 +70,35 @@ export function getFinalOptions(userOptions: CloudflareOptions = {}, env: unknow
tracesSampleRate: isFinite(tracesSampleRate) ? tracesSampleRate : undefined,
debug: userOptions.debug ?? envToBool(getEnvVar(env, 'SENTRY_DEBUG')),
tunnel: userOptions.tunnel ?? getEnvVar(env, 'SENTRY_TUNNEL'),
/*! rollup-include-development-only */
spotlight,
/*! rollup-include-development-only-end */
};
}

/**
* Resolve the spotlight option from a user-supplied value and an env binding string.
* Mirrors node-core's `getSpotlightConfig` precedence:
* - `false` or explicit string from options → use as-is
* - `true` → enable, but prefer a custom URL from the env var if set
* - `undefined` → defer entirely to the env var (bool or URL)
*/
function getSpotlightFromEnv(
optionsSpotlight: boolean | string | undefined,
envVar: string | undefined,
): boolean | string | undefined {
if (optionsSpotlight === false) {
return false;
}
if (typeof optionsSpotlight === 'string') {
return optionsSpotlight;
}

// optionsSpotlight is true or undefined
const envBool = envToBool(envVar, { strict: true });
const envUrl = envBool === null && envVar ? envVar : undefined;

return optionsSpotlight === true
? (envUrl ?? true) // true: use env URL if present, otherwise true
: (envBool ?? envUrl); // undefined: use env var (bool or URL)
}
11 changes: 11 additions & 0 deletions packages/cloudflare/src/sdk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import { CloudflareClient } from './client';
import { makeFlushLock } from './flush';
import { httpServerIntegration } from './integrations/httpServer';
import { fetchIntegration } from './integrations/fetch';
import { INTEGRATION_NAME as SPOTLIGHT_INTEGRATION_NAME, spotlightIntegration } from './integrations/spotlight';
import { setupOpenTelemetryTracer } from './opentelemetry/tracer';
import { makeCloudflareTransport } from './transport';
import { defaultStackParser } from './vendor/stacktrace';
Expand DownExpand Up@@ -88,6 +89,16 @@ export function init(options: CloudflareOptions): CloudflareClient | undefined {
flushLock,
};

/*! rollup-include-development-only */
if (options.spotlight && !clientOptions.integrations.some(({ name }) => name === SPOTLIGHT_INTEGRATION_NAME)) {
clientOptions.integrations.push(
spotlightIntegration({
sidecarUrl: typeof options.spotlight === 'string' ? options.spotlight : undefined,
}),
);
}
/*! rollup-include-development-only-end */

/**
* The Cloudflare SDK is not OpenTelemetry native, however, we set up some OpenTelemetry compatibility
* via a custom trace provider.
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(cloudflare): Add Spotlight integration for local dev event forwarding#22490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

JPeer264
merged 6 commits into

from

Jul 24, 2026
 Merged


feat(cloudflare): Add Spotlight integration for local dev event forwarding
#22490
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
60fbfc1

feat(cloudflare): Add Spotlight integration for local dev event forwa…


MathurAditya724 Jul 22, 2026
320966e

fix(cloudflare): Add spotlight property to BaseCloudflareOptions


MathurAditya724 Jul 22, 2026
c1568fe

fix: Address review findings — spotlight precedence, indent, test gaps


MathurAditya724 Jul 22, 2026
169f735

fix(cloudflare): Remove non-functional dev-only markers around spotli…


MathurAditya724 Jul 22, 2026
bd9bc63

Merge branch 'develop' into feat/cloudflare-spotlight-integration


MathurAditya724 Jul 22, 2026
dff8f1b

feat(cloudflare): Add dev/prod bundle in favor of spotlight


JPeer264 Jul 22, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -436,7 +436,7 @@ module.exports = [
 // Cloudflare SDK (ESM) - compressed, minified to match `wrangler deploy --dry-run --minify` output
 {
 name: '@sentry/cloudflare (withSentry) - minified',
 path: 'packages/cloudflare/build/esm/index.js',
 path: 'packages/cloudflare/build/esm/prod/index.js',
 import: createImport('withSentry', 'instrumentDurableObjectWithSentry', 'instrumentWorkflowWithSentry'),
 ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
 gzip: false,
Expand All@@ -456,7 +456,7 @@ module.exports = [
 // Cloudflare SDK (ESM) - uncompressed, unminified to match `wrangler deploy --dry-run` output
 {
 name: '@sentry/cloudflare (withSentry)',
 path: 'packages/cloudflare/build/esm/index.js',
 path: 'packages/cloudflare/build/esm/prod/index.js',
 import: createImport('withSentry', 'instrumentDurableObjectWithSentry', 'instrumentWorkflowWithSentry'),
 ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
 gzip: false,
Expand Down

56 changes: 23 additions & 33 deletions
packages/cloudflare/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,50 +12,40 @@
 "files": [
 "/build"
 ],
 "main": "build/cjs/index.js",
 "module": "build/esm/index.js",
 "main": "build/cjs/prod/index.js",
 "module": "build/esm/prod/index.js",
 "types": "build/types/index.d.ts",
 "exports": {
 "./package.json": "./package.json",
 ".": {
 "import": {
 "types": "./build/types/index.d.ts",
 "default": "./build/esm/index.js"
 "types": "./build/types/index.d.ts",
 "development": {
 "import": "./build/esm/dev/index.js",
 "require": "./build/cjs/dev/index.js"
 },
 "require": {
 "types": "./build/types/index.d.ts",
 "default": "./build/cjs/index.js"
 "production": {
 "import": "./build/esm/prod/index.js",
 "require": "./build/cjs/prod/index.js"
 },
 "default": {
 "import": "./build/esm/prod/index.js",
 "require": "./build/cjs/prod/index.js"
 }
 },
 "./request": {
 "import": {
 "types": "./build/types/request.d.ts",
 "default": "./build/esm/request.js"
 },
 "require": {
 "types": "./build/types/request.d.ts",
 "default": "./build/cjs/request.js"
 }
 "types": "./build/types/request.d.ts",
 "import": "./build/esm/prod/request.js",
 "require": "./build/cjs/prod/request.js"
 },
 "./nodejs_compat": {
 "import": {
 "types": "./build/types/nodejs_compat/index.d.ts",
 "default": "./build/esm/nodejs_compat/index.js"
 },
 "require": {
 "types": "./build/types/nodejs_compat/index.d.ts",
 "default": "./build/cjs/nodejs_compat/index.js"
 }
 "types": "./build/types/nodejs_compat/index.d.ts",
 "import": "./build/esm/prod/nodejs_compat/index.js",
 "require": "./build/cjs/prod/nodejs_compat/index.js"
 },
 "./vite": {
 "import": {
 "types": "./build/types/vite/index.d.ts",
 "default": "./build/esm/vite/index.js"
 },
 "require": {
 "types": "./build/types/vite/index.d.ts",
 "default": "./build/cjs/vite/index.js"
 }
 "types": "./build/types/vite/index.d.ts",
 "import": "./build/esm/prod/vite/index.js",
 "require": "./build/cjs/prod/vite/index.js"
 }
 },
 "publishConfig": {
Expand DownExpand Up@@ -98,7 +88,7 @@
 "clean": "rimraf build coverage sentry-cloudflare-*.tgz",
 "lint:fix": "OXLINT_TSGOLINT_DANGEROUSLY_SUPPRESS_PROGRAM_DIAGNOSTICS=true oxlint . --fix --type-aware",
 "lint": "OXLINT_TSGOLINT_DANGEROUSLY_SUPPRESS_PROGRAM_DIAGNOSTICS=true oxlint . --type-aware",
 "lint:es-compatibility": "es-check es2022 ./build/cjs/*.js && es-check es2022 ./build/esm/*.js --module",
 "lint:es-compatibility": "es-check es2022 ./build/cjs/prod/*.js && es-check es2022 ./build/esm/prod/*.js --module",
 "test": "yarn test:unit",
 "test:unit": "vitest run",
 "test:watch": "vitest --watch",
Expand Down

1 change: 1 addition & 0 deletions
packages/cloudflare/rollup.npm.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,4 +4,5 @@ export default makeNPMConfigVariants(
 makeBaseNPMConfig({
 entrypoints: ['src/index.ts', 'src/nodejs_compat/index.ts', 'src/vite/index.ts'],
 }),
 { splitDevProd: true },
);

12 changes: 12 additions & 0 deletions
packages/cloudflare/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -253,6 +253,18 @@ interface BaseCloudflareOptions {
 * @default false
 */
 instrumentPrototypeMethods?: boolean | string[];

 /**
 * If you use Spotlight by Sentry during development, use
 * this option to forward captured Sentry events to Spotlight.
 *
 * Either set it to true, or provide a specific Spotlight Sidecar URL.
 *
 * More details: https://spotlightjs.com/
 *
 * IMPORTANT: Only set this option to `true` while developing, not in production!
 */
 spotlight?: boolean | string;
}

/**
Expand Down

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,7 @@ export { getDefaultIntegrations } from './sdk';

export { httpServerIntegration } from './integrations/httpServer';
export { fetchIntegration } from './integrations/fetch';
export { spotlightIntegration } from './integrations/spotlight';
export { vercelAIIntegration } from './integrations/tracing/vercelai';

// eslint-disable-next-line typescript/no-deprecated
Expand Down

89 changes: 89 additions & 0 deletions
packages/cloudflare/src/integrations/spotlight.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
import type { Client, Envelope, IntegrationFn } from '@sentry/core';
import { debug, defineIntegration, serializeEnvelope, suppressTracing } from '@sentry/core';
import { DEBUG_BUILD } from '../debug-build';

type SpotlightConnectionOptions = {
 /**
 * Set this if the Spotlight Sidecar is not running on localhost:8969.
 * By default, the URL is set to http://localhost:8969/stream
 */
 sidecarUrl?: string;
};

export const INTEGRATION_NAME = 'Spotlight' as const;

const _spotlightIntegration = ((options: Partial<SpotlightConnectionOptions> = {}) => {
 const sidecarUrl = options.sidecarUrl || 'http://localhost:8969/stream';

 return {
 name: INTEGRATION_NAME,
 setup(client) {
 DEBUG_BUILD && debug.log('[Spotlight] Using Sidecar URL', sidecarUrl);
 setupSidecarForwarding(client, sidecarUrl);
 },
 };
}) satisfies IntegrationFn;

/**
 * Use this integration to send errors and transactions to Spotlight.
 *
 * Learn more about spotlight at https://spotlightjs.com
 *
 * Important: This integration is intended for local development only.
 * Each forwarded envelope counts as a Worker subrequest (50 free / 1000 paid
 * per invocation), so it should not be enabled in production.
 */
export const spotlightIntegration = defineIntegration(_spotlightIntegration);

function setupSidecarForwarding(client: Client, sidecarUrl: string): void {
 const parsedUrl = parseSidecarUrl(sidecarUrl);
 if (!parsedUrl) {
 return;
 }

 let failCount = 0;

 client.on('beforeEnvelope', (envelope: Envelope) => {
 if (failCount > 3) {
 DEBUG_BUILD && debug.warn('[Spotlight] Disabled Sentry -> Spotlight forwarding due to too many failed requests');
 return;
 }

 const body = serializeEnvelope(envelope);

 suppressTracing(() => {
 fetch(parsedUrl.href, {
 method: 'POST',
 body,
 headers: {
 'Content-Type': 'application/x-sentry-envelope',
 },
 }).then(
 res => {
 // Consume the response body to satisfy Cloudflare Workers' requirement
 // that all fetch response bodies are read or cancelled.
 res.text().catch(() => {
 // no-op
 });

 if (res.status >= 200 && res.status < 400) {
 failCount = 0;
 }
 },
 () => {
 failCount++;
 DEBUG_BUILD && debug.warn('[Spotlight] Failed to send envelope to Spotlight Sidecar');
 },
 );
 });
 });
}

function parseSidecarUrl(url: string): URL | undefined {
 try {
 return new URL(url);
 } catch {
 DEBUG_BUILD && debug.warn(`[Spotlight] Invalid sidecar URL: ${url}`);
 return undefined;
 }
}

38 changes: 38 additions & 0 deletions
packages/cloudflare/src/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,14 @@ export function getFinalOptions(userOptions: CloudflareOptions = {}, env: unknow
 const tracesSampleRate =
 userOptions.tracesSampleRate ?? parseFloat(getEnvVar(env, 'SENTRY_TRACES_SAMPLE_RATE') ?? '');

 // Spotlight precedence (mirrors node-core's getSpotlightConfig):
 // - false or explicit string from options: use as-is
 // - true: enable, but prefer a custom URL from the env var if set
 // - undefined: defer entirely to the env var (bool or URL)
 /*! rollup-include-development-only */
 const spotlight = getSpotlightFromEnv(userOptions.spotlight, getEnvVar(env, 'SENTRY_SPOTLIGHT'));
 /*! rollup-include-development-only-end */

 return {
 release,
 ...userOptions,
Expand All@@ -62,5 +70,35 @@ export function getFinalOptions(userOptions: CloudflareOptions = {}, env: unknow
 tracesSampleRate: isFinite(tracesSampleRate) ? tracesSampleRate : undefined,
 debug: userOptions.debug ?? envToBool(getEnvVar(env, 'SENTRY_DEBUG')),
 tunnel: userOptions.tunnel ?? getEnvVar(env, 'SENTRY_TUNNEL'),
 /*! rollup-include-development-only */
 spotlight,
 /*! rollup-include-development-only-end */
 };
}

/**
 * Resolve the spotlight option from a user-supplied value and an env binding string.
 * Mirrors node-core's `getSpotlightConfig` precedence:
 * - `false` or explicit string from options → use as-is
 * - `true` → enable, but prefer a custom URL from the env var if set
 * - `undefined` → defer entirely to the env var (bool or URL)
 */
function getSpotlightFromEnv(
 optionsSpotlight: boolean | string | undefined,
 envVar: string | undefined,
): boolean | string | undefined {
 if (optionsSpotlight === false) {
 return false;
 }
 if (typeof optionsSpotlight === 'string') {
 return optionsSpotlight;
 }

 // optionsSpotlight is true or undefined
 const envBool = envToBool(envVar, { strict: true });
 const envUrl = envBool === null && envVar ? envVar : undefined;

 return optionsSpotlight === true
 ? (envUrl ?? true) // true: use env URL if present, otherwise true
 : (envBool ?? envUrl); // undefined: use env var (bool or URL)
}

11 changes: 11 additions & 0 deletions
packages/cloudflare/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import { CloudflareClient } from './client';
import { makeFlushLock } from './flush';
import { httpServerIntegration } from './integrations/httpServer';
import { fetchIntegration } from './integrations/fetch';
import { INTEGRATION_NAME as SPOTLIGHT_INTEGRATION_NAME, spotlightIntegration } from './integrations/spotlight';
import { setupOpenTelemetryTracer } from './opentelemetry/tracer';
import { makeCloudflareTransport } from './transport';
import { defaultStackParser } from './vendor/stacktrace';
Expand DownExpand Up@@ -88,6 +89,16 @@ export function init(options: CloudflareOptions): CloudflareClient | undefined {
 flushLock,
 };

 /*! rollup-include-development-only */
 if (options.spotlight && !clientOptions.integrations.some(({ name }) => name === SPOTLIGHT_INTEGRATION_NAME)) {
 clientOptions.integrations.push(
 spotlightIntegration({
 sidecarUrl: typeof options.spotlight === 'string' ? options.spotlight : undefined,
 }),
 );
 }
 /*! rollup-include-development-only-end */

 /**
 * The Cloudflare SDK is not OpenTelemetry native, however, we set up some OpenTelemetry compatibility
 * via a custom trace provider.
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(cloudflare): Add Spotlight integration for local dev event forwarding#22490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

JPeer264
merged 6 commits into

from

Jul 24, 2026
 Merged


feat(cloudflare): Add Spotlight integration for local dev event forwarding
#22490
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
60fbfc1

feat(cloudflare): Add Spotlight integration for local dev event forwa…


MathurAditya724 Jul 22, 2026
320966e

fix(cloudflare): Add spotlight property to BaseCloudflareOptions


MathurAditya724 Jul 22, 2026
c1568fe

fix: Address review findings — spotlight precedence, indent, test gaps


MathurAditya724 Jul 22, 2026
169f735

fix(cloudflare): Remove non-functional dev-only markers around spotli…


MathurAditya724 Jul 22, 2026
bd9bc63

Merge branch 'develop' into feat/cloudflare-spotlight-integration


MathurAditya724 Jul 22, 2026
dff8f1b

feat(cloudflare): Add dev/prod bundle in favor of spotlight


JPeer264 Jul 22, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -436,7 +436,7 @@ module.exports = [
 // Cloudflare SDK (ESM) - compressed, minified to match `wrangler deploy --dry-run --minify` output
 {
 name: '@sentry/cloudflare (withSentry) - minified',
 path: 'packages/cloudflare/build/esm/index.js',
 path: 'packages/cloudflare/build/esm/prod/index.js',
 import: createImport('withSentry', 'instrumentDurableObjectWithSentry', 'instrumentWorkflowWithSentry'),
 ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
 gzip: false,
Expand All@@ -456,7 +456,7 @@ module.exports = [
 // Cloudflare SDK (ESM) - uncompressed, unminified to match `wrangler deploy --dry-run` output
 {
 name: '@sentry/cloudflare (withSentry)',
 path: 'packages/cloudflare/build/esm/index.js',
 path: 'packages/cloudflare/build/esm/prod/index.js',
 import: createImport('withSentry', 'instrumentDurableObjectWithSentry', 'instrumentWorkflowWithSentry'),
 ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
 gzip: false,
Expand Down

56 changes: 23 additions & 33 deletions
packages/cloudflare/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,50 +12,40 @@
 "files": [
 "/build"
 ],
 "main": "build/cjs/index.js",
 "module": "build/esm/index.js",
 "main": "build/cjs/prod/index.js",
 "module": "build/esm/prod/index.js",
 "types": "build/types/index.d.ts",
 "exports": {
 "./package.json": "./package.json",
 ".": {
 "import": {
 "types": "./build/types/index.d.ts",
 "default": "./build/esm/index.js"
 "types": "./build/types/index.d.ts",
 "development": {
 "import": "./build/esm/dev/index.js",
 "require": "./build/cjs/dev/index.js"
 },
 "require": {
 "types": "./build/types/index.d.ts",
 "default": "./build/cjs/index.js"
 "production": {
 "import": "./build/esm/prod/index.js",
 "require": "./build/cjs/prod/index.js"
 },
 "default": {
 "import": "./build/esm/prod/index.js",
 "require": "./build/cjs/prod/index.js"
 }
 },
 "./request": {
 "import": {
 "types": "./build/types/request.d.ts",
 "default": "./build/esm/request.js"
 },
 "require": {
 "types": "./build/types/request.d.ts",
 "default": "./build/cjs/request.js"
 }
 "types": "./build/types/request.d.ts",
 "import": "./build/esm/prod/request.js",
 "require": "./build/cjs/prod/request.js"
 },
 "./nodejs_compat": {
 "import": {
 "types": "./build/types/nodejs_compat/index.d.ts",
 "default": "./build/esm/nodejs_compat/index.js"
 },
 "require": {
 "types": "./build/types/nodejs_compat/index.d.ts",
 "default": "./build/cjs/nodejs_compat/index.js"
 }
 "types": "./build/types/nodejs_compat/index.d.ts",
 "import": "./build/esm/prod/nodejs_compat/index.js",
 "require": "./build/cjs/prod/nodejs_compat/index.js"
 },
 "./vite": {
 "import": {
 "types": "./build/types/vite/index.d.ts",
 "default": "./build/esm/vite/index.js"
 },
 "require": {
 "types": "./build/types/vite/index.d.ts",
 "default": "./build/cjs/vite/index.js"
 }
 "types": "./build/types/vite/index.d.ts",
 "import": "./build/esm/prod/vite/index.js",
 "require": "./build/cjs/prod/vite/index.js"
 }
 },
 "publishConfig": {
Expand DownExpand Up@@ -98,7 +88,7 @@
 "clean": "rimraf build coverage sentry-cloudflare-*.tgz",
 "lint:fix": "OXLINT_TSGOLINT_DANGEROUSLY_SUPPRESS_PROGRAM_DIAGNOSTICS=true oxlint . --fix --type-aware",
 "lint": "OXLINT_TSGOLINT_DANGEROUSLY_SUPPRESS_PROGRAM_DIAGNOSTICS=true oxlint . --type-aware",
 "lint:es-compatibility": "es-check es2022 ./build/cjs/*.js && es-check es2022 ./build/esm/*.js --module",
 "lint:es-compatibility": "es-check es2022 ./build/cjs/prod/*.js && es-check es2022 ./build/esm/prod/*.js --module",
 "test": "yarn test:unit",
 "test:unit": "vitest run",
 "test:watch": "vitest --watch",
Expand Down

1 change: 1 addition & 0 deletions
packages/cloudflare/rollup.npm.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,4 +4,5 @@ export default makeNPMConfigVariants(
 makeBaseNPMConfig({
 entrypoints: ['src/index.ts', 'src/nodejs_compat/index.ts', 'src/vite/index.ts'],
 }),
 { splitDevProd: true },
);

12 changes: 12 additions & 0 deletions
packages/cloudflare/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -253,6 +253,18 @@ interface BaseCloudflareOptions {
 * @default false
 */
 instrumentPrototypeMethods?: boolean | string[];

 /**
 * If you use Spotlight by Sentry during development, use
 * this option to forward captured Sentry events to Spotlight.
 *
 * Either set it to true, or provide a specific Spotlight Sidecar URL.
 *
 * More details: https://spotlightjs.com/
 *
 * IMPORTANT: Only set this option to `true` while developing, not in production!
 */
 spotlight?: boolean | string;
}

/**
Expand Down

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,7 @@ export { getDefaultIntegrations } from './sdk';

export { httpServerIntegration } from './integrations/httpServer';
export { fetchIntegration } from './integrations/fetch';
export { spotlightIntegration } from './integrations/spotlight';
export { vercelAIIntegration } from './integrations/tracing/vercelai';

// eslint-disable-next-line typescript/no-deprecated
Expand Down

89 changes: 89 additions & 0 deletions
packages/cloudflare/src/integrations/spotlight.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
import type { Client, Envelope, IntegrationFn } from '@sentry/core';
import { debug, defineIntegration, serializeEnvelope, suppressTracing } from '@sentry/core';
import { DEBUG_BUILD } from '../debug-build';

type SpotlightConnectionOptions = {
 /**
 * Set this if the Spotlight Sidecar is not running on localhost:8969.
 * By default, the URL is set to http://localhost:8969/stream
 */
 sidecarUrl?: string;
};

export const INTEGRATION_NAME = 'Spotlight' as const;

const _spotlightIntegration = ((options: Partial<SpotlightConnectionOptions> = {}) => {
 const sidecarUrl = options.sidecarUrl || 'http://localhost:8969/stream';

 return {
 name: INTEGRATION_NAME,
 setup(client) {
 DEBUG_BUILD && debug.log('[Spotlight] Using Sidecar URL', sidecarUrl);
 setupSidecarForwarding(client, sidecarUrl);
 },
 };
}) satisfies IntegrationFn;

/**
 * Use this integration to send errors and transactions to Spotlight.
 *
 * Learn more about spotlight at https://spotlightjs.com
 *
 * Important: This integration is intended for local development only.
 * Each forwarded envelope counts as a Worker subrequest (50 free / 1000 paid
 * per invocation), so it should not be enabled in production.
 */
export const spotlightIntegration = defineIntegration(_spotlightIntegration);

function setupSidecarForwarding(client: Client, sidecarUrl: string): void {
 const parsedUrl = parseSidecarUrl(sidecarUrl);
 if (!parsedUrl) {
 return;
 }

 let failCount = 0;

 client.on('beforeEnvelope', (envelope: Envelope) => {
 if (failCount > 3) {
 DEBUG_BUILD && debug.warn('[Spotlight] Disabled Sentry -> Spotlight forwarding due to too many failed requests');
 return;
 }

 const body = serializeEnvelope(envelope);

 suppressTracing(() => {
 fetch(parsedUrl.href, {
 method: 'POST',
 body,
 headers: {
 'Content-Type': 'application/x-sentry-envelope',
 },
 }).then(
 res => {
 // Consume the response body to satisfy Cloudflare Workers' requirement
 // that all fetch response bodies are read or cancelled.
 res.text().catch(() => {
 // no-op
 });

 if (res.status >= 200 && res.status < 400) {
 failCount = 0;
 }
 },
 () => {
 failCount++;
 DEBUG_BUILD && debug.warn('[Spotlight] Failed to send envelope to Spotlight Sidecar');
 },
 );
 });
 });
}

function parseSidecarUrl(url: string): URL | undefined {
 try {
 return new URL(url);
 } catch {
 DEBUG_BUILD && debug.warn(`[Spotlight] Invalid sidecar URL: ${url}`);
 return undefined;
 }
}

38 changes: 38 additions & 0 deletions
packages/cloudflare/src/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,14 @@ export function getFinalOptions(userOptions: CloudflareOptions = {}, env: unknow
 const tracesSampleRate =
 userOptions.tracesSampleRate ?? parseFloat(getEnvVar(env, 'SENTRY_TRACES_SAMPLE_RATE') ?? '');

 // Spotlight precedence (mirrors node-core's getSpotlightConfig):
 // - false or explicit string from options: use as-is
 // - true: enable, but prefer a custom URL from the env var if set
 // - undefined: defer entirely to the env var (bool or URL)
 /*! rollup-include-development-only */
 const spotlight = getSpotlightFromEnv(userOptions.spotlight, getEnvVar(env, 'SENTRY_SPOTLIGHT'));
 /*! rollup-include-development-only-end */

 return {
 release,
 ...userOptions,
Expand All@@ -62,5 +70,35 @@ export function getFinalOptions(userOptions: CloudflareOptions = {}, env: unknow
 tracesSampleRate: isFinite(tracesSampleRate) ? tracesSampleRate : undefined,
 debug: userOptions.debug ?? envToBool(getEnvVar(env, 'SENTRY_DEBUG')),
 tunnel: userOptions.tunnel ?? getEnvVar(env, 'SENTRY_TUNNEL'),
 /*! rollup-include-development-only */
 spotlight,
 /*! rollup-include-development-only-end */
 };
}

/**
 * Resolve the spotlight option from a user-supplied value and an env binding string.
 * Mirrors node-core's `getSpotlightConfig` precedence:
 * - `false` or explicit string from options → use as-is
 * - `true` → enable, but prefer a custom URL from the env var if set
 * - `undefined` → defer entirely to the env var (bool or URL)
 */
function getSpotlightFromEnv(
 optionsSpotlight: boolean | string | undefined,
 envVar: string | undefined,
): boolean | string | undefined {
 if (optionsSpotlight === false) {
 return false;
 }
 if (typeof optionsSpotlight === 'string') {
 return optionsSpotlight;
 }

 // optionsSpotlight is true or undefined
 const envBool = envToBool(envVar, { strict: true });
 const envUrl = envBool === null && envVar ? envVar : undefined;

 return optionsSpotlight === true
 ? (envUrl ?? true) // true: use env URL if present, otherwise true
 : (envBool ?? envUrl); // undefined: use env var (bool or URL)
}

11 changes: 11 additions & 0 deletions
packages/cloudflare/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import { CloudflareClient } from './client';
import { makeFlushLock } from './flush';
import { httpServerIntegration } from './integrations/httpServer';
import { fetchIntegration } from './integrations/fetch';
import { INTEGRATION_NAME as SPOTLIGHT_INTEGRATION_NAME, spotlightIntegration } from './integrations/spotlight';
import { setupOpenTelemetryTracer } from './opentelemetry/tracer';
import { makeCloudflareTransport } from './transport';
import { defaultStackParser } from './vendor/stacktrace';
Expand DownExpand Up@@ -88,6 +89,16 @@ export function init(options: CloudflareOptions): CloudflareClient | undefined {
 flushLock,
 };

 /*! rollup-include-development-only */
 if (options.spotlight && !clientOptions.integrations.some(({ name }) => name === SPOTLIGHT_INTEGRATION_NAME)) {
 clientOptions.integrations.push(
 spotlightIntegration({
 sidecarUrl: typeof options.spotlight === 'string' ? options.spotlight : undefined,
 }),
 );
 }
 /*! rollup-include-development-only-end */

 /**
 * The Cloudflare SDK is not OpenTelemetry native, however, we set up some OpenTelemetry compatibility
 * via a custom trace provider.
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(cloudflare): Add Spotlight integration for local dev event forwarding#22490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

JPeer264
merged 6 commits into

from

Jul 24, 2026
 Merged


feat(cloudflare): Add Spotlight integration for local dev event forwarding
#22490
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
60fbfc1

feat(cloudflare): Add Spotlight integration for local dev event forwa…


MathurAditya724 Jul 22, 2026
320966e

fix(cloudflare): Add spotlight property to BaseCloudflareOptions


MathurAditya724 Jul 22, 2026
c1568fe

fix: Address review findings — spotlight precedence, indent, test gaps


MathurAditya724 Jul 22, 2026
169f735

fix(cloudflare): Remove non-functional dev-only markers around spotli…


MathurAditya724 Jul 22, 2026
bd9bc63

Merge branch 'develop' into feat/cloudflare-spotlight-integration


MathurAditya724 Jul 22, 2026
dff8f1b

feat(cloudflare): Add dev/prod bundle in favor of spotlight


JPeer264 Jul 22, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -436,7 +436,7 @@ module.exports = [
 // Cloudflare SDK (ESM) - compressed, minified to match `wrangler deploy --dry-run --minify` output
 {
 name: '@sentry/cloudflare (withSentry) - minified',
 path: 'packages/cloudflare/build/esm/index.js',
 path: 'packages/cloudflare/build/esm/prod/index.js',
 import: createImport('withSentry', 'instrumentDurableObjectWithSentry', 'instrumentWorkflowWithSentry'),
 ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
 gzip: false,
Expand All@@ -456,7 +456,7 @@ module.exports = [
 // Cloudflare SDK (ESM) - uncompressed, unminified to match `wrangler deploy --dry-run` output
 {
 name: '@sentry/cloudflare (withSentry)',
 path: 'packages/cloudflare/build/esm/index.js',
 path: 'packages/cloudflare/build/esm/prod/index.js',
 import: createImport('withSentry', 'instrumentDurableObjectWithSentry', 'instrumentWorkflowWithSentry'),
 ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
 gzip: false,
Expand Down

56 changes: 23 additions & 33 deletions
packages/cloudflare/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,50 +12,40 @@
 "files": [
 "/build"
 ],
 "main": "build/cjs/index.js",
 "module": "build/esm/index.js",
 "main": "build/cjs/prod/index.js",
 "module": "build/esm/prod/index.js",
 "types": "build/types/index.d.ts",
 "exports": {
 "./package.json": "./package.json",
 ".": {
 "import": {
 "types": "./build/types/index.d.ts",
 "default": "./build/esm/index.js"
 "types": "./build/types/index.d.ts",
 "development": {
 "import": "./build/esm/dev/index.js",
 "require": "./build/cjs/dev/index.js"
 },
 "require": {
 "types": "./build/types/index.d.ts",
 "default": "./build/cjs/index.js"
 "production": {
 "import": "./build/esm/prod/index.js",
 "require": "./build/cjs/prod/index.js"
 },
 "default": {
 "import": "./build/esm/prod/index.js",
 "require": "./build/cjs/prod/index.js"
 }
 },
 "./request": {
 "import": {
 "types": "./build/types/request.d.ts",
 "default": "./build/esm/request.js"
 },
 "require": {
 "types": "./build/types/request.d.ts",
 "default": "./build/cjs/request.js"
 }
 "types": "./build/types/request.d.ts",
 "import": "./build/esm/prod/request.js",
 "require": "./build/cjs/prod/request.js"
 },
 "./nodejs_compat": {
 "import": {
 "types": "./build/types/nodejs_compat/index.d.ts",
 "default": "./build/esm/nodejs_compat/index.js"
 },
 "require": {
 "types": "./build/types/nodejs_compat/index.d.ts",
 "default": "./build/cjs/nodejs_compat/index.js"
 }
 "types": "./build/types/nodejs_compat/index.d.ts",
 "import": "./build/esm/prod/nodejs_compat/index.js",
 "require": "./build/cjs/prod/nodejs_compat/index.js"
 },
 "./vite": {
 "import": {
 "types": "./build/types/vite/index.d.ts",
 "default": "./build/esm/vite/index.js"
 },
 "require": {
 "types": "./build/types/vite/index.d.ts",
 "default": "./build/cjs/vite/index.js"
 }
 "types": "./build/types/vite/index.d.ts",
 "import": "./build/esm/prod/vite/index.js",
 "require": "./build/cjs/prod/vite/index.js"
 }
 },
 "publishConfig": {
Expand DownExpand Up@@ -98,7 +88,7 @@
 "clean": "rimraf build coverage sentry-cloudflare-*.tgz",
 "lint:fix": "OXLINT_TSGOLINT_DANGEROUSLY_SUPPRESS_PROGRAM_DIAGNOSTICS=true oxlint . --fix --type-aware",
 "lint": "OXLINT_TSGOLINT_DANGEROUSLY_SUPPRESS_PROGRAM_DIAGNOSTICS=true oxlint . --type-aware",
 "lint:es-compatibility": "es-check es2022 ./build/cjs/*.js && es-check es2022 ./build/esm/*.js --module",
 "lint:es-compatibility": "es-check es2022 ./build/cjs/prod/*.js && es-check es2022 ./build/esm/prod/*.js --module",
 "test": "yarn test:unit",
 "test:unit": "vitest run",
 "test:watch": "vitest --watch",
Expand Down

1 change: 1 addition & 0 deletions
packages/cloudflare/rollup.npm.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,4 +4,5 @@ export default makeNPMConfigVariants(
 makeBaseNPMConfig({
 entrypoints: ['src/index.ts', 'src/nodejs_compat/index.ts', 'src/vite/index.ts'],
 }),
 { splitDevProd: true },
);

12 changes: 12 additions & 0 deletions
packages/cloudflare/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -253,6 +253,18 @@ interface BaseCloudflareOptions {
 * @default false
 */
 instrumentPrototypeMethods?: boolean | string[];

 /**
 * If you use Spotlight by Sentry during development, use
 * this option to forward captured Sentry events to Spotlight.
 *
 * Either set it to true, or provide a specific Spotlight Sidecar URL.
 *
 * More details: https://spotlightjs.com/
 *
 * IMPORTANT: Only set this option to `true` while developing, not in production!
 */
 spotlight?: boolean | string;
}

/**
Expand Down

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,7 @@ export { getDefaultIntegrations } from './sdk';

export { httpServerIntegration } from './integrations/httpServer';
export { fetchIntegration } from './integrations/fetch';
export { spotlightIntegration } from './integrations/spotlight';
export { vercelAIIntegration } from './integrations/tracing/vercelai';

// eslint-disable-next-line typescript/no-deprecated
Expand Down

89 changes: 89 additions & 0 deletions
packages/cloudflare/src/integrations/spotlight.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
import type { Client, Envelope, IntegrationFn } from '@sentry/core';
import { debug, defineIntegration, serializeEnvelope, suppressTracing } from '@sentry/core';
import { DEBUG_BUILD } from '../debug-build';

type SpotlightConnectionOptions = {
 /**
 * Set this if the Spotlight Sidecar is not running on localhost:8969.
 * By default, the URL is set to http://localhost:8969/stream
 */
 sidecarUrl?: string;
};

export const INTEGRATION_NAME = 'Spotlight' as const;

const _spotlightIntegration = ((options: Partial<SpotlightConnectionOptions> = {}) => {
 const sidecarUrl = options.sidecarUrl || 'http://localhost:8969/stream';

 return {
 name: INTEGRATION_NAME,
 setup(client) {
 DEBUG_BUILD && debug.log('[Spotlight] Using Sidecar URL', sidecarUrl);
 setupSidecarForwarding(client, sidecarUrl);
 },
 };
}) satisfies IntegrationFn;

/**
 * Use this integration to send errors and transactions to Spotlight.
 *
 * Learn more about spotlight at https://spotlightjs.com
 *
 * Important: This integration is intended for local development only.
 * Each forwarded envelope counts as a Worker subrequest (50 free / 1000 paid
 * per invocation), so it should not be enabled in production.
 */
export const spotlightIntegration = defineIntegration(_spotlightIntegration);

function setupSidecarForwarding(client: Client, sidecarUrl: string): void {
 const parsedUrl = parseSidecarUrl(sidecarUrl);
 if (!parsedUrl) {
 return;
 }

 let failCount = 0;

 client.on('beforeEnvelope', (envelope: Envelope) => {
 if (failCount > 3) {
 DEBUG_BUILD && debug.warn('[Spotlight] Disabled Sentry -> Spotlight forwarding due to too many failed requests');
 return;
 }

 const body = serializeEnvelope(envelope);

 suppressTracing(() => {
 fetch(parsedUrl.href, {
 method: 'POST',
 body,
 headers: {
 'Content-Type': 'application/x-sentry-envelope',
 },
 }).then(
 res => {
 // Consume the response body to satisfy Cloudflare Workers' requirement
 // that all fetch response bodies are read or cancelled.
 res.text().catch(() => {
 // no-op
 });

 if (res.status >= 200 && res.status < 400) {
 failCount = 0;
 }
 },
 () => {
 failCount++;
 DEBUG_BUILD && debug.warn('[Spotlight] Failed to send envelope to Spotlight Sidecar');
 },
 );
 });
 });
}

function parseSidecarUrl(url: string): URL | undefined {
 try {
 return new URL(url);
 } catch {
 DEBUG_BUILD && debug.warn(`[Spotlight] Invalid sidecar URL: ${url}`);
 return undefined;
 }
}

38 changes: 38 additions & 0 deletions
packages/cloudflare/src/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,14 @@ export function getFinalOptions(userOptions: CloudflareOptions = {}, env: unknow
 const tracesSampleRate =
 userOptions.tracesSampleRate ?? parseFloat(getEnvVar(env, 'SENTRY_TRACES_SAMPLE_RATE') ?? '');

 // Spotlight precedence (mirrors node-core's getSpotlightConfig):
 // - false or explicit string from options: use as-is
 // - true: enable, but prefer a custom URL from the env var if set
 // - undefined: defer entirely to the env var (bool or URL)
 /*! rollup-include-development-only */
 const spotlight = getSpotlightFromEnv(userOptions.spotlight, getEnvVar(env, 'SENTRY_SPOTLIGHT'));
 /*! rollup-include-development-only-end */

 return {
 release,
 ...userOptions,
Expand All@@ -62,5 +70,35 @@ export function getFinalOptions(userOptions: CloudflareOptions = {}, env: unknow
 tracesSampleRate: isFinite(tracesSampleRate) ? tracesSampleRate : undefined,
 debug: userOptions.debug ?? envToBool(getEnvVar(env, 'SENTRY_DEBUG')),
 tunnel: userOptions.tunnel ?? getEnvVar(env, 'SENTRY_TUNNEL'),
 /*! rollup-include-development-only */
 spotlight,
 /*! rollup-include-development-only-end */
 };
}

/**
 * Resolve the spotlight option from a user-supplied value and an env binding string.
 * Mirrors node-core's `getSpotlightConfig` precedence:
 * - `false` or explicit string from options → use as-is
 * - `true` → enable, but prefer a custom URL from the env var if set
 * - `undefined` → defer entirely to the env var (bool or URL)
 */
function getSpotlightFromEnv(
 optionsSpotlight: boolean | string | undefined,
 envVar: string | undefined,
): boolean | string | undefined {
 if (optionsSpotlight === false) {
 return false;
 }
 if (typeof optionsSpotlight === 'string') {
 return optionsSpotlight;
 }

 // optionsSpotlight is true or undefined
 const envBool = envToBool(envVar, { strict: true });
 const envUrl = envBool === null && envVar ? envVar : undefined;

 return optionsSpotlight === true
 ? (envUrl ?? true) // true: use env URL if present, otherwise true
 : (envBool ?? envUrl); // undefined: use env var (bool or URL)
}

11 changes: 11 additions & 0 deletions
packages/cloudflare/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import { CloudflareClient } from './client';
import { makeFlushLock } from './flush';
import { httpServerIntegration } from './integrations/httpServer';
import { fetchIntegration } from './integrations/fetch';
import { INTEGRATION_NAME as SPOTLIGHT_INTEGRATION_NAME, spotlightIntegration } from './integrations/spotlight';
import { setupOpenTelemetryTracer } from './opentelemetry/tracer';
import { makeCloudflareTransport } from './transport';
import { defaultStackParser } from './vendor/stacktrace';
Expand DownExpand Up@@ -88,6 +89,16 @@ export function init(options: CloudflareOptions): CloudflareClient | undefined {
 flushLock,
 };

 /*! rollup-include-development-only */
 if (options.spotlight && !clientOptions.integrations.some(({ name }) => name === SPOTLIGHT_INTEGRATION_NAME)) {
 clientOptions.integrations.push(
 spotlightIntegration({
 sidecarUrl: typeof options.spotlight === 'string' ? options.spotlight : undefined,
 }),
 );
 }
 /*! rollup-include-development-only-end */

 /**
 * The Cloudflare SDK is not OpenTelemetry native, however, we set up some OpenTelemetry compatibility
 * via a custom trace provider.
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(cloudflare): Add Spotlight integration for local dev event forwarding#22490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

JPeer264
merged 6 commits into

from

Jul 24, 2026
 Merged


feat(cloudflare): Add Spotlight integration for local dev event forwarding
#22490
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
60fbfc1

feat(cloudflare): Add Spotlight integration for local dev event forwa…


MathurAditya724 Jul 22, 2026
320966e

fix(cloudflare): Add spotlight property to BaseCloudflareOptions


MathurAditya724 Jul 22, 2026
c1568fe

fix: Address review findings — spotlight precedence, indent, test gaps


MathurAditya724 Jul 22, 2026
169f735

fix(cloudflare): Remove non-functional dev-only markers around spotli…


MathurAditya724 Jul 22, 2026
bd9bc63

Merge branch 'develop' into feat/cloudflare-spotlight-integration


MathurAditya724 Jul 22, 2026
dff8f1b

feat(cloudflare): Add dev/prod bundle in favor of spotlight


JPeer264 Jul 22, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -436,7 +436,7 @@ module.exports = [
 // Cloudflare SDK (ESM) - compressed, minified to match `wrangler deploy --dry-run --minify` output
 {
 name: '@sentry/cloudflare (withSentry) - minified',
 path: 'packages/cloudflare/build/esm/index.js',
 path: 'packages/cloudflare/build/esm/prod/index.js',
 import: createImport('withSentry', 'instrumentDurableObjectWithSentry', 'instrumentWorkflowWithSentry'),
 ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
 gzip: false,
Expand All@@ -456,7 +456,7 @@ module.exports = [
 // Cloudflare SDK (ESM) - uncompressed, unminified to match `wrangler deploy --dry-run` output
 {
 name: '@sentry/cloudflare (withSentry)',
 path: 'packages/cloudflare/build/esm/index.js',
 path: 'packages/cloudflare/build/esm/prod/index.js',
 import: createImport('withSentry', 'instrumentDurableObjectWithSentry', 'instrumentWorkflowWithSentry'),
 ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
 gzip: false,
Expand Down

56 changes: 23 additions & 33 deletions
packages/cloudflare/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,50 +12,40 @@
 "files": [
 "/build"
 ],
 "main": "build/cjs/index.js",
 "module": "build/esm/index.js",
 "main": "build/cjs/prod/index.js",
 "module": "build/esm/prod/index.js",
 "types": "build/types/index.d.ts",
 "exports": {
 "./package.json": "./package.json",
 ".": {
 "import": {
 "types": "./build/types/index.d.ts",
 "default": "./build/esm/index.js"
 "types": "./build/types/index.d.ts",
 "development": {
 "import": "./build/esm/dev/index.js",
 "require": "./build/cjs/dev/index.js"
 },
 "require": {
 "types": "./build/types/index.d.ts",
 "default": "./build/cjs/index.js"
 "production": {
 "import": "./build/esm/prod/index.js",
 "require": "./build/cjs/prod/index.js"
 },
 "default": {
 "import": "./build/esm/prod/index.js",
 "require": "./build/cjs/prod/index.js"
 }
 },
 "./request": {
 "import": {
 "types": "./build/types/request.d.ts",
 "default": "./build/esm/request.js"
 },
 "require": {
 "types": "./build/types/request.d.ts",
 "default": "./build/cjs/request.js"
 }
 "types": "./build/types/request.d.ts",
 "import": "./build/esm/prod/request.js",
 "require": "./build/cjs/prod/request.js"
 },
 "./nodejs_compat": {
 "import": {
 "types": "./build/types/nodejs_compat/index.d.ts",
 "default": "./build/esm/nodejs_compat/index.js"
 },
 "require": {
 "types": "./build/types/nodejs_compat/index.d.ts",
 "default": "./build/cjs/nodejs_compat/index.js"
 }
 "types": "./build/types/nodejs_compat/index.d.ts",
 "import": "./build/esm/prod/nodejs_compat/index.js",
 "require": "./build/cjs/prod/nodejs_compat/index.js"
 },
 "./vite": {
 "import": {
 "types": "./build/types/vite/index.d.ts",
 "default": "./build/esm/vite/index.js"
 },
 "require": {
 "types": "./build/types/vite/index.d.ts",
 "default": "./build/cjs/vite/index.js"
 }
 "types": "./build/types/vite/index.d.ts",
 "import": "./build/esm/prod/vite/index.js",
 "require": "./build/cjs/prod/vite/index.js"
 }
 },
 "publishConfig": {
Expand DownExpand Up@@ -98,7 +88,7 @@
 "clean": "rimraf build coverage sentry-cloudflare-*.tgz",
 "lint:fix": "OXLINT_TSGOLINT_DANGEROUSLY_SUPPRESS_PROGRAM_DIAGNOSTICS=true oxlint . --fix --type-aware",
 "lint": "OXLINT_TSGOLINT_DANGEROUSLY_SUPPRESS_PROGRAM_DIAGNOSTICS=true oxlint . --type-aware",
 "lint:es-compatibility": "es-check es2022 ./build/cjs/*.js && es-check es2022 ./build/esm/*.js --module",
 "lint:es-compatibility": "es-check es2022 ./build/cjs/prod/*.js && es-check es2022 ./build/esm/prod/*.js --module",
 "test": "yarn test:unit",
 "test:unit": "vitest run",
 "test:watch": "vitest --watch",
Expand Down

1 change: 1 addition & 0 deletions
packages/cloudflare/rollup.npm.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,4 +4,5 @@ export default makeNPMConfigVariants(
 makeBaseNPMConfig({
 entrypoints: ['src/index.ts', 'src/nodejs_compat/index.ts', 'src/vite/index.ts'],
 }),
 { splitDevProd: true },
);

12 changes: 12 additions & 0 deletions
packages/cloudflare/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -253,6 +253,18 @@ interface BaseCloudflareOptions {
 * @default false
 */
 instrumentPrototypeMethods?: boolean | string[];

 /**
 * If you use Spotlight by Sentry during development, use
 * this option to forward captured Sentry events to Spotlight.
 *
 * Either set it to true, or provide a specific Spotlight Sidecar URL.
 *
 * More details: https://spotlightjs.com/
 *
 * IMPORTANT: Only set this option to `true` while developing, not in production!
 */
 spotlight?: boolean | string;
}

/**
Expand Down

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,7 @@ export { getDefaultIntegrations } from './sdk';

export { httpServerIntegration } from './integrations/httpServer';
export { fetchIntegration } from './integrations/fetch';
export { spotlightIntegration } from './integrations/spotlight';
export { vercelAIIntegration } from './integrations/tracing/vercelai';

// eslint-disable-next-line typescript/no-deprecated
Expand Down

89 changes: 89 additions & 0 deletions
packages/cloudflare/src/integrations/spotlight.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
import type { Client, Envelope, IntegrationFn } from '@sentry/core';
import { debug, defineIntegration, serializeEnvelope, suppressTracing } from '@sentry/core';
import { DEBUG_BUILD } from '../debug-build';

type SpotlightConnectionOptions = {
 /**
 * Set this if the Spotlight Sidecar is not running on localhost:8969.
 * By default, the URL is set to http://localhost:8969/stream
 */
 sidecarUrl?: string;
};

export const INTEGRATION_NAME = 'Spotlight' as const;

const _spotlightIntegration = ((options: Partial<SpotlightConnectionOptions> = {}) => {
 const sidecarUrl = options.sidecarUrl || 'http://localhost:8969/stream';

 return {
 name: INTEGRATION_NAME,
 setup(client) {
 DEBUG_BUILD && debug.log('[Spotlight] Using Sidecar URL', sidecarUrl);
 setupSidecarForwarding(client, sidecarUrl);
 },
 };
}) satisfies IntegrationFn;

/**
 * Use this integration to send errors and transactions to Spotlight.
 *
 * Learn more about spotlight at https://spotlightjs.com
 *
 * Important: This integration is intended for local development only.
 * Each forwarded envelope counts as a Worker subrequest (50 free / 1000 paid
 * per invocation), so it should not be enabled in production.
 */
export const spotlightIntegration = defineIntegration(_spotlightIntegration);

function setupSidecarForwarding(client: Client, sidecarUrl: string): void {
 const parsedUrl = parseSidecarUrl(sidecarUrl);
 if (!parsedUrl) {
 return;
 }

 let failCount = 0;

 client.on('beforeEnvelope', (envelope: Envelope) => {
 if (failCount > 3) {
 DEBUG_BUILD && debug.warn('[Spotlight] Disabled Sentry -> Spotlight forwarding due to too many failed requests');
 return;
 }

 const body = serializeEnvelope(envelope);

 suppressTracing(() => {
 fetch(parsedUrl.href, {
 method: 'POST',
 body,
 headers: {
 'Content-Type': 'application/x-sentry-envelope',
 },
 }).then(
 res => {
 // Consume the response body to satisfy Cloudflare Workers' requirement
 // that all fetch response bodies are read or cancelled.
 res.text().catch(() => {
 // no-op
 });

 if (res.status >= 200 && res.status < 400) {
 failCount = 0;
 }
 },
 () => {
 failCount++;
 DEBUG_BUILD && debug.warn('[Spotlight] Failed to send envelope to Spotlight Sidecar');
 },
 );
 });
 });
}

function parseSidecarUrl(url: string): URL | undefined {
 try {
 return new URL(url);
 } catch {
 DEBUG_BUILD && debug.warn(`[Spotlight] Invalid sidecar URL: ${url}`);
 return undefined;
 }
}

38 changes: 38 additions & 0 deletions
packages/cloudflare/src/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,14 @@ export function getFinalOptions(userOptions: CloudflareOptions = {}, env: unknow
 const tracesSampleRate =
 userOptions.tracesSampleRate ?? parseFloat(getEnvVar(env, 'SENTRY_TRACES_SAMPLE_RATE') ?? '');

 // Spotlight precedence (mirrors node-core's getSpotlightConfig):
 // - false or explicit string from options: use as-is
 // - true: enable, but prefer a custom URL from the env var if set
 // - undefined: defer entirely to the env var (bool or URL)
 /*! rollup-include-development-only */
 const spotlight = getSpotlightFromEnv(userOptions.spotlight, getEnvVar(env, 'SENTRY_SPOTLIGHT'));
 /*! rollup-include-development-only-end */

 return {
 release,
 ...userOptions,
Expand All@@ -62,5 +70,35 @@ export function getFinalOptions(userOptions: CloudflareOptions = {}, env: unknow
 tracesSampleRate: isFinite(tracesSampleRate) ? tracesSampleRate : undefined,
 debug: userOptions.debug ?? envToBool(getEnvVar(env, 'SENTRY_DEBUG')),
 tunnel: userOptions.tunnel ?? getEnvVar(env, 'SENTRY_TUNNEL'),
 /*! rollup-include-development-only */
 spotlight,
 /*! rollup-include-development-only-end */
 };
}

/**
 * Resolve the spotlight option from a user-supplied value and an env binding string.
 * Mirrors node-core's `getSpotlightConfig` precedence:
 * - `false` or explicit string from options → use as-is
 * - `true` → enable, but prefer a custom URL from the env var if set
 * - `undefined` → defer entirely to the env var (bool or URL)
 */
function getSpotlightFromEnv(
 optionsSpotlight: boolean | string | undefined,
 envVar: string | undefined,
): boolean | string | undefined {
 if (optionsSpotlight === false) {
 return false;
 }
 if (typeof optionsSpotlight === 'string') {
 return optionsSpotlight;
 }

 // optionsSpotlight is true or undefined
 const envBool = envToBool(envVar, { strict: true });
 const envUrl = envBool === null && envVar ? envVar : undefined;

 return optionsSpotlight === true
 ? (envUrl ?? true) // true: use env URL if present, otherwise true
 : (envBool ?? envUrl); // undefined: use env var (bool or URL)
}

11 changes: 11 additions & 0 deletions
packages/cloudflare/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import { CloudflareClient } from './client';
import { makeFlushLock } from './flush';
import { httpServerIntegration } from './integrations/httpServer';
import { fetchIntegration } from './integrations/fetch';
import { INTEGRATION_NAME as SPOTLIGHT_INTEGRATION_NAME, spotlightIntegration } from './integrations/spotlight';
import { setupOpenTelemetryTracer } from './opentelemetry/tracer';
import { makeCloudflareTransport } from './transport';
import { defaultStackParser } from './vendor/stacktrace';
Expand DownExpand Up@@ -88,6 +89,16 @@ export function init(options: CloudflareOptions): CloudflareClient | undefined {
 flushLock,
 };

 /*! rollup-include-development-only */
 if (options.spotlight && !clientOptions.integrations.some(({ name }) => name === SPOTLIGHT_INTEGRATION_NAME)) {
 clientOptions.integrations.push(
 spotlightIntegration({
 sidecarUrl: typeof options.spotlight === 'string' ? options.spotlight : undefined,
 }),
 );
 }
 /*! rollup-include-development-only-end */

 /**
 * The Cloudflare SDK is not OpenTelemetry native, however, we set up some OpenTelemetry compatibility
 * via a custom trace provider.
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(cloudflare): Add Spotlight integration for local dev event forwarding#22490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

JPeer264
merged 6 commits into

from

Jul 24, 2026
 Merged


feat(cloudflare): Add Spotlight integration for local dev event forwarding
#22490
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
60fbfc1

feat(cloudflare): Add Spotlight integration for local dev event forwa…


MathurAditya724 Jul 22, 2026
320966e

fix(cloudflare): Add spotlight property to BaseCloudflareOptions


MathurAditya724 Jul 22, 2026
c1568fe

fix: Address review findings — spotlight precedence, indent, test gaps


MathurAditya724 Jul 22, 2026
169f735

fix(cloudflare): Remove non-functional dev-only markers around spotli…


MathurAditya724 Jul 22, 2026
bd9bc63

Merge branch 'develop' into feat/cloudflare-spotlight-integration


MathurAditya724 Jul 22, 2026
dff8f1b

feat(cloudflare): Add dev/prod bundle in favor of spotlight


JPeer264 Jul 22, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -436,7 +436,7 @@ module.exports = [
 // Cloudflare SDK (ESM) - compressed, minified to match `wrangler deploy --dry-run --minify` output
 {
 name: '@sentry/cloudflare (withSentry) - minified',
 path: 'packages/cloudflare/build/esm/index.js',
 path: 'packages/cloudflare/build/esm/prod/index.js',
 import: createImport('withSentry', 'instrumentDurableObjectWithSentry', 'instrumentWorkflowWithSentry'),
 ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
 gzip: false,
Expand All@@ -456,7 +456,7 @@ module.exports = [
 // Cloudflare SDK (ESM) - uncompressed, unminified to match `wrangler deploy --dry-run` output
 {
 name: '@sentry/cloudflare (withSentry)',
 path: 'packages/cloudflare/build/esm/index.js',
 path: 'packages/cloudflare/build/esm/prod/index.js',
 import: createImport('withSentry', 'instrumentDurableObjectWithSentry', 'instrumentWorkflowWithSentry'),
 ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
 gzip: false,
Expand Down

56 changes: 23 additions & 33 deletions
packages/cloudflare/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,50 +12,40 @@
 "files": [
 "/build"
 ],
 "main": "build/cjs/index.js",
 "module": "build/esm/index.js",
 "main": "build/cjs/prod/index.js",
 "module": "build/esm/prod/index.js",
 "types": "build/types/index.d.ts",
 "exports": {
 "./package.json": "./package.json",
 ".": {
 "import": {
 "types": "./build/types/index.d.ts",
 "default": "./build/esm/index.js"
 "types": "./build/types/index.d.ts",
 "development": {
 "import": "./build/esm/dev/index.js",
 "require": "./build/cjs/dev/index.js"
 },
 "require": {
 "types": "./build/types/index.d.ts",
 "default": "./build/cjs/index.js"
 "production": {
 "import": "./build/esm/prod/index.js",
 "require": "./build/cjs/prod/index.js"
 },
 "default": {
 "import": "./build/esm/prod/index.js",
 "require": "./build/cjs/prod/index.js"
 }
 },
 "./request": {
 "import": {
 "types": "./build/types/request.d.ts",
 "default": "./build/esm/request.js"
 },
 "require": {
 "types": "./build/types/request.d.ts",
 "default": "./build/cjs/request.js"
 }
 "types": "./build/types/request.d.ts",
 "import": "./build/esm/prod/request.js",
 "require": "./build/cjs/prod/request.js"
 },
 "./nodejs_compat": {
 "import": {
 "types": "./build/types/nodejs_compat/index.d.ts",
 "default": "./build/esm/nodejs_compat/index.js"
 },
 "require": {
 "types": "./build/types/nodejs_compat/index.d.ts",
 "default": "./build/cjs/nodejs_compat/index.js"
 }
 "types": "./build/types/nodejs_compat/index.d.ts",
 "import": "./build/esm/prod/nodejs_compat/index.js",
 "require": "./build/cjs/prod/nodejs_compat/index.js"
 },
 "./vite": {
 "import": {
 "types": "./build/types/vite/index.d.ts",
 "default": "./build/esm/vite/index.js"
 },
 "require": {
 "types": "./build/types/vite/index.d.ts",
 "default": "./build/cjs/vite/index.js"
 }
 "types": "./build/types/vite/index.d.ts",
 "import": "./build/esm/prod/vite/index.js",
 "require": "./build/cjs/prod/vite/index.js"
 }
 },
 "publishConfig": {
Expand DownExpand Up@@ -98,7 +88,7 @@
 "clean": "rimraf build coverage sentry-cloudflare-*.tgz",
 "lint:fix": "OXLINT_TSGOLINT_DANGEROUSLY_SUPPRESS_PROGRAM_DIAGNOSTICS=true oxlint . --fix --type-aware",
 "lint": "OXLINT_TSGOLINT_DANGEROUSLY_SUPPRESS_PROGRAM_DIAGNOSTICS=true oxlint . --type-aware",
 "lint:es-compatibility": "es-check es2022 ./build/cjs/*.js && es-check es2022 ./build/esm/*.js --module",
 "lint:es-compatibility": "es-check es2022 ./build/cjs/prod/*.js && es-check es2022 ./build/esm/prod/*.js --module",
 "test": "yarn test:unit",
 "test:unit": "vitest run",
 "test:watch": "vitest --watch",
Expand Down

1 change: 1 addition & 0 deletions
packages/cloudflare/rollup.npm.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,4 +4,5 @@ export default makeNPMConfigVariants(
 makeBaseNPMConfig({
 entrypoints: ['src/index.ts', 'src/nodejs_compat/index.ts', 'src/vite/index.ts'],
 }),
 { splitDevProd: true },
);

12 changes: 12 additions & 0 deletions
packages/cloudflare/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -253,6 +253,18 @@ interface BaseCloudflareOptions {
 * @default false
 */
 instrumentPrototypeMethods?: boolean | string[];

 /**
 * If you use Spotlight by Sentry during development, use
 * this option to forward captured Sentry events to Spotlight.
 *
 * Either set it to true, or provide a specific Spotlight Sidecar URL.
 *
 * More details: https://spotlightjs.com/
 *
 * IMPORTANT: Only set this option to `true` while developing, not in production!
 */
 spotlight?: boolean | string;
}

/**
Expand Down

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,7 @@ export { getDefaultIntegrations } from './sdk';

export { httpServerIntegration } from './integrations/httpServer';
export { fetchIntegration } from './integrations/fetch';
export { spotlightIntegration } from './integrations/spotlight';
export { vercelAIIntegration } from './integrations/tracing/vercelai';

// eslint-disable-next-line typescript/no-deprecated
Expand Down

89 changes: 89 additions & 0 deletions
packages/cloudflare/src/integrations/spotlight.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
import type { Client, Envelope, IntegrationFn } from '@sentry/core';
import { debug, defineIntegration, serializeEnvelope, suppressTracing } from '@sentry/core';
import { DEBUG_BUILD } from '../debug-build';

type SpotlightConnectionOptions = {
 /**
 * Set this if the Spotlight Sidecar is not running on localhost:8969.
 * By default, the URL is set to http://localhost:8969/stream
 */
 sidecarUrl?: string;
};

export const INTEGRATION_NAME = 'Spotlight' as const;

const _spotlightIntegration = ((options: Partial<SpotlightConnectionOptions> = {}) => {
 const sidecarUrl = options.sidecarUrl || 'http://localhost:8969/stream';

 return {
 name: INTEGRATION_NAME,
 setup(client) {
 DEBUG_BUILD && debug.log('[Spotlight] Using Sidecar URL', sidecarUrl);
 setupSidecarForwarding(client, sidecarUrl);
 },
 };
}) satisfies IntegrationFn;

/**
 * Use this integration to send errors and transactions to Spotlight.
 *
 * Learn more about spotlight at https://spotlightjs.com
 *
 * Important: This integration is intended for local development only.
 * Each forwarded envelope counts as a Worker subrequest (50 free / 1000 paid
 * per invocation), so it should not be enabled in production.
 */
export const spotlightIntegration = defineIntegration(_spotlightIntegration);

function setupSidecarForwarding(client: Client, sidecarUrl: string): void {
 const parsedUrl = parseSidecarUrl(sidecarUrl);
 if (!parsedUrl) {
 return;
 }

 let failCount = 0;

 client.on('beforeEnvelope', (envelope: Envelope) => {
 if (failCount > 3) {
 DEBUG_BUILD && debug.warn('[Spotlight] Disabled Sentry -> Spotlight forwarding due to too many failed requests');
 return;
 }

 const body = serializeEnvelope(envelope);

 suppressTracing(() => {
 fetch(parsedUrl.href, {
 method: 'POST',
 body,
 headers: {
 'Content-Type': 'application/x-sentry-envelope',
 },
 }).then(
 res => {
 // Consume the response body to satisfy Cloudflare Workers' requirement
 // that all fetch response bodies are read or cancelled.
 res.text().catch(() => {
 // no-op
 });

 if (res.status >= 200 && res.status < 400) {
 failCount = 0;
 }
 },
 () => {
 failCount++;
 DEBUG_BUILD && debug.warn('[Spotlight] Failed to send envelope to Spotlight Sidecar');
 },
 );
 });
 });
}

function parseSidecarUrl(url: string): URL | undefined {
 try {
 return new URL(url);
 } catch {
 DEBUG_BUILD && debug.warn(`[Spotlight] Invalid sidecar URL: ${url}`);
 return undefined;
 }
}

38 changes: 38 additions & 0 deletions
packages/cloudflare/src/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,14 @@ export function getFinalOptions(userOptions: CloudflareOptions = {}, env: unknow
 const tracesSampleRate =
 userOptions.tracesSampleRate ?? parseFloat(getEnvVar(env, 'SENTRY_TRACES_SAMPLE_RATE') ?? '');

 // Spotlight precedence (mirrors node-core's getSpotlightConfig):
 // - false or explicit string from options: use as-is
 // - true: enable, but prefer a custom URL from the env var if set
 // - undefined: defer entirely to the env var (bool or URL)
 /*! rollup-include-development-only */
 const spotlight = getSpotlightFromEnv(userOptions.spotlight, getEnvVar(env, 'SENTRY_SPOTLIGHT'));
 /*! rollup-include-development-only-end */

 return {
 release,
 ...userOptions,
Expand All@@ -62,5 +70,35 @@ export function getFinalOptions(userOptions: CloudflareOptions = {}, env: unknow
 tracesSampleRate: isFinite(tracesSampleRate) ? tracesSampleRate : undefined,
 debug: userOptions.debug ?? envToBool(getEnvVar(env, 'SENTRY_DEBUG')),
 tunnel: userOptions.tunnel ?? getEnvVar(env, 'SENTRY_TUNNEL'),
 /*! rollup-include-development-only */
 spotlight,
 /*! rollup-include-development-only-end */
 };
}

/**
 * Resolve the spotlight option from a user-supplied value and an env binding string.
 * Mirrors node-core's `getSpotlightConfig` precedence:
 * - `false` or explicit string from options → use as-is
 * - `true` → enable, but prefer a custom URL from the env var if set
 * - `undefined` → defer entirely to the env var (bool or URL)
 */
function getSpotlightFromEnv(
 optionsSpotlight: boolean | string | undefined,
 envVar: string | undefined,
): boolean | string | undefined {
 if (optionsSpotlight === false) {
 return false;
 }
 if (typeof optionsSpotlight === 'string') {
 return optionsSpotlight;
 }

 // optionsSpotlight is true or undefined
 const envBool = envToBool(envVar, { strict: true });
 const envUrl = envBool === null && envVar ? envVar : undefined;

 return optionsSpotlight === true
 ? (envUrl ?? true) // true: use env URL if present, otherwise true
 : (envBool ?? envUrl); // undefined: use env var (bool or URL)
}

11 changes: 11 additions & 0 deletions
packages/cloudflare/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import { CloudflareClient } from './client';
import { makeFlushLock } from './flush';
import { httpServerIntegration } from './integrations/httpServer';
import { fetchIntegration } from './integrations/fetch';
import { INTEGRATION_NAME as SPOTLIGHT_INTEGRATION_NAME, spotlightIntegration } from './integrations/spotlight';
import { setupOpenTelemetryTracer } from './opentelemetry/tracer';
import { makeCloudflareTransport } from './transport';
import { defaultStackParser } from './vendor/stacktrace';
Expand DownExpand Up@@ -88,6 +89,16 @@ export function init(options: CloudflareOptions): CloudflareClient | undefined {
 flushLock,
 };

 /*! rollup-include-development-only */
 if (options.spotlight && !clientOptions.integrations.some(({ name }) => name === SPOTLIGHT_INTEGRATION_NAME)) {
 clientOptions.integrations.push(
 spotlightIntegration({
 sidecarUrl: typeof options.spotlight === 'string' ? options.spotlight : undefined,
 }),
 );
 }
 /*! rollup-include-development-only-end */

 /**
 * The Cloudflare SDK is not OpenTelemetry native, however, we set up some OpenTelemetry compatibility
 * via a custom trace provider.
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(cloudflare): Add Spotlight integration for local dev event forwarding#22490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

JPeer264
merged 6 commits into

from

Jul 24, 2026
 Merged


feat(cloudflare): Add Spotlight integration for local dev event forwarding
#22490
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
60fbfc1

feat(cloudflare): Add Spotlight integration for local dev event forwa…


MathurAditya724 Jul 22, 2026
320966e

fix(cloudflare): Add spotlight property to BaseCloudflareOptions


MathurAditya724 Jul 22, 2026
c1568fe

fix: Address review findings — spotlight precedence, indent, test gaps


MathurAditya724 Jul 22, 2026
169f735

fix(cloudflare): Remove non-functional dev-only markers around spotli…


MathurAditya724 Jul 22, 2026
bd9bc63

Merge branch 'develop' into feat/cloudflare-spotlight-integration


MathurAditya724 Jul 22, 2026
dff8f1b

feat(cloudflare): Add dev/prod bundle in favor of spotlight


JPeer264 Jul 22, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -436,7 +436,7 @@ module.exports = [
 // Cloudflare SDK (ESM) - compressed, minified to match `wrangler deploy --dry-run --minify` output
 {
 name: '@sentry/cloudflare (withSentry) - minified',
 path: 'packages/cloudflare/build/esm/index.js',
 path: 'packages/cloudflare/build/esm/prod/index.js',
 import: createImport('withSentry', 'instrumentDurableObjectWithSentry', 'instrumentWorkflowWithSentry'),
 ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
 gzip: false,
Expand All@@ -456,7 +456,7 @@ module.exports = [
 // Cloudflare SDK (ESM) - uncompressed, unminified to match `wrangler deploy --dry-run` output
 {
 name: '@sentry/cloudflare (withSentry)',
 path: 'packages/cloudflare/build/esm/index.js',
 path: 'packages/cloudflare/build/esm/prod/index.js',
 import: createImport('withSentry', 'instrumentDurableObjectWithSentry', 'instrumentWorkflowWithSentry'),
 ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
 gzip: false,
Expand Down

56 changes: 23 additions & 33 deletions
packages/cloudflare/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,50 +12,40 @@
 "files": [
 "/build"
 ],
 "main": "build/cjs/index.js",
 "module": "build/esm/index.js",
 "main": "build/cjs/prod/index.js",
 "module": "build/esm/prod/index.js",
 "types": "build/types/index.d.ts",
 "exports": {
 "./package.json": "./package.json",
 ".": {
 "import": {
 "types": "./build/types/index.d.ts",
 "default": "./build/esm/index.js"
 "types": "./build/types/index.d.ts",
 "development": {
 "import": "./build/esm/dev/index.js",
 "require": "./build/cjs/dev/index.js"
 },
 "require": {
 "types": "./build/types/index.d.ts",
 "default": "./build/cjs/index.js"
 "production": {
 "import": "./build/esm/prod/index.js",
 "require": "./build/cjs/prod/index.js"
 },
 "default": {
 "import": "./build/esm/prod/index.js",
 "require": "./build/cjs/prod/index.js"
 }
 },
 "./request": {
 "import": {
 "types": "./build/types/request.d.ts",
 "default": "./build/esm/request.js"
 },
 "require": {
 "types": "./build/types/request.d.ts",
 "default": "./build/cjs/request.js"
 }
 "types": "./build/types/request.d.ts",
 "import": "./build/esm/prod/request.js",
 "require": "./build/cjs/prod/request.js"
 },
 "./nodejs_compat": {
 "import": {
 "types": "./build/types/nodejs_compat/index.d.ts",
 "default": "./build/esm/nodejs_compat/index.js"
 },
 "require": {
 "types": "./build/types/nodejs_compat/index.d.ts",
 "default": "./build/cjs/nodejs_compat/index.js"
 }
 "types": "./build/types/nodejs_compat/index.d.ts",
 "import": "./build/esm/prod/nodejs_compat/index.js",
 "require": "./build/cjs/prod/nodejs_compat/index.js"
 },
 "./vite": {
 "import": {
 "types": "./build/types/vite/index.d.ts",
 "default": "./build/esm/vite/index.js"
 },
 "require": {
 "types": "./build/types/vite/index.d.ts",
 "default": "./build/cjs/vite/index.js"
 }
 "types": "./build/types/vite/index.d.ts",
 "import": "./build/esm/prod/vite/index.js",
 "require": "./build/cjs/prod/vite/index.js"
 }
 },
 "publishConfig": {
Expand DownExpand Up@@ -98,7 +88,7 @@
 "clean": "rimraf build coverage sentry-cloudflare-*.tgz",
 "lint:fix": "OXLINT_TSGOLINT_DANGEROUSLY_SUPPRESS_PROGRAM_DIAGNOSTICS=true oxlint . --fix --type-aware",
 "lint": "OXLINT_TSGOLINT_DANGEROUSLY_SUPPRESS_PROGRAM_DIAGNOSTICS=true oxlint . --type-aware",
 "lint:es-compatibility": "es-check es2022 ./build/cjs/*.js && es-check es2022 ./build/esm/*.js --module",
 "lint:es-compatibility": "es-check es2022 ./build/cjs/prod/*.js && es-check es2022 ./build/esm/prod/*.js --module",
 "test": "yarn test:unit",
 "test:unit": "vitest run",
 "test:watch": "vitest --watch",
Expand Down

1 change: 1 addition & 0 deletions
packages/cloudflare/rollup.npm.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,4 +4,5 @@ export default makeNPMConfigVariants(
 makeBaseNPMConfig({
 entrypoints: ['src/index.ts', 'src/nodejs_compat/index.ts', 'src/vite/index.ts'],
 }),
 { splitDevProd: true },
);

12 changes: 12 additions & 0 deletions
packages/cloudflare/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -253,6 +253,18 @@ interface BaseCloudflareOptions {
 * @default false
 */
 instrumentPrototypeMethods?: boolean | string[];

 /**
 * If you use Spotlight by Sentry during development, use
 * this option to forward captured Sentry events to Spotlight.
 *
 * Either set it to true, or provide a specific Spotlight Sidecar URL.
 *
 * More details: https://spotlightjs.com/
 *
 * IMPORTANT: Only set this option to `true` while developing, not in production!
 */
 spotlight?: boolean | string;
}

/**
Expand Down

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,7 @@ export { getDefaultIntegrations } from './sdk';

export { httpServerIntegration } from './integrations/httpServer';
export { fetchIntegration } from './integrations/fetch';
export { spotlightIntegration } from './integrations/spotlight';
export { vercelAIIntegration } from './integrations/tracing/vercelai';

// eslint-disable-next-line typescript/no-deprecated
Expand Down

89 changes: 89 additions & 0 deletions
packages/cloudflare/src/integrations/spotlight.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
import type { Client, Envelope, IntegrationFn } from '@sentry/core';
import { debug, defineIntegration, serializeEnvelope, suppressTracing } from '@sentry/core';
import { DEBUG_BUILD } from '../debug-build';

type SpotlightConnectionOptions = {
 /**
 * Set this if the Spotlight Sidecar is not running on localhost:8969.
 * By default, the URL is set to http://localhost:8969/stream
 */
 sidecarUrl?: string;
};

export const INTEGRATION_NAME = 'Spotlight' as const;

const _spotlightIntegration = ((options: Partial<SpotlightConnectionOptions> = {}) => {
 const sidecarUrl = options.sidecarUrl || 'http://localhost:8969/stream';

 return {
 name: INTEGRATION_NAME,
 setup(client) {
 DEBUG_BUILD && debug.log('[Spotlight] Using Sidecar URL', sidecarUrl);
 setupSidecarForwarding(client, sidecarUrl);
 },
 };
}) satisfies IntegrationFn;

/**
 * Use this integration to send errors and transactions to Spotlight.
 *
 * Learn more about spotlight at https://spotlightjs.com
 *
 * Important: This integration is intended for local development only.
 * Each forwarded envelope counts as a Worker subrequest (50 free / 1000 paid
 * per invocation), so it should not be enabled in production.
 */
export const spotlightIntegration = defineIntegration(_spotlightIntegration);

function setupSidecarForwarding(client: Client, sidecarUrl: string): void {
 const parsedUrl = parseSidecarUrl(sidecarUrl);
 if (!parsedUrl) {
 return;
 }

 let failCount = 0;

 client.on('beforeEnvelope', (envelope: Envelope) => {
 if (failCount > 3) {
 DEBUG_BUILD && debug.warn('[Spotlight] Disabled Sentry -> Spotlight forwarding due to too many failed requests');
 return;
 }

 const body = serializeEnvelope(envelope);

 suppressTracing(() => {
 fetch(parsedUrl.href, {
 method: 'POST',
 body,
 headers: {
 'Content-Type': 'application/x-sentry-envelope',
 },
 }).then(
 res => {
 // Consume the response body to satisfy Cloudflare Workers' requirement
 // that all fetch response bodies are read or cancelled.
 res.text().catch(() => {
 // no-op
 });

 if (res.status >= 200 && res.status < 400) {
 failCount = 0;
 }
 },
 () => {
 failCount++;
 DEBUG_BUILD && debug.warn('[Spotlight] Failed to send envelope to Spotlight Sidecar');
 },
 );
 });
 });
}

function parseSidecarUrl(url: string): URL | undefined {
 try {
 return new URL(url);
 } catch {
 DEBUG_BUILD && debug.warn(`[Spotlight] Invalid sidecar URL: ${url}`);
 return undefined;
 }
}

38 changes: 38 additions & 0 deletions
packages/cloudflare/src/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,14 @@ export function getFinalOptions(userOptions: CloudflareOptions = {}, env: unknow
 const tracesSampleRate =
 userOptions.tracesSampleRate ?? parseFloat(getEnvVar(env, 'SENTRY_TRACES_SAMPLE_RATE') ?? '');

 // Spotlight precedence (mirrors node-core's getSpotlightConfig):
 // - false or explicit string from options: use as-is
 // - true: enable, but prefer a custom URL from the env var if set
 // - undefined: defer entirely to the env var (bool or URL)
 /*! rollup-include-development-only */
 const spotlight = getSpotlightFromEnv(userOptions.spotlight, getEnvVar(env, 'SENTRY_SPOTLIGHT'));
 /*! rollup-include-development-only-end */

 return {
 release,
 ...userOptions,
Expand All@@ -62,5 +70,35 @@ export function getFinalOptions(userOptions: CloudflareOptions = {}, env: unknow
 tracesSampleRate: isFinite(tracesSampleRate) ? tracesSampleRate : undefined,
 debug: userOptions.debug ?? envToBool(getEnvVar(env, 'SENTRY_DEBUG')),
 tunnel: userOptions.tunnel ?? getEnvVar(env, 'SENTRY_TUNNEL'),
 /*! rollup-include-development-only */
 spotlight,
 /*! rollup-include-development-only-end */
 };
}

/**
 * Resolve the spotlight option from a user-supplied value and an env binding string.
 * Mirrors node-core's `getSpotlightConfig` precedence:
 * - `false` or explicit string from options → use as-is
 * - `true` → enable, but prefer a custom URL from the env var if set
 * - `undefined` → defer entirely to the env var (bool or URL)
 */
function getSpotlightFromEnv(
 optionsSpotlight: boolean | string | undefined,
 envVar: string | undefined,
): boolean | string | undefined {
 if (optionsSpotlight === false) {
 return false;
 }
 if (typeof optionsSpotlight === 'string') {
 return optionsSpotlight;
 }

 // optionsSpotlight is true or undefined
 const envBool = envToBool(envVar, { strict: true });
 const envUrl = envBool === null && envVar ? envVar : undefined;

 return optionsSpotlight === true
 ? (envUrl ?? true) // true: use env URL if present, otherwise true
 : (envBool ?? envUrl); // undefined: use env var (bool or URL)
}

11 changes: 11 additions & 0 deletions
packages/cloudflare/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import { CloudflareClient } from './client';
import { makeFlushLock } from './flush';
import { httpServerIntegration } from './integrations/httpServer';
import { fetchIntegration } from './integrations/fetch';
import { INTEGRATION_NAME as SPOTLIGHT_INTEGRATION_NAME, spotlightIntegration } from './integrations/spotlight';
import { setupOpenTelemetryTracer } from './opentelemetry/tracer';
import { makeCloudflareTransport } from './transport';
import { defaultStackParser } from './vendor/stacktrace';
Expand DownExpand Up@@ -88,6 +89,16 @@ export function init(options: CloudflareOptions): CloudflareClient | undefined {
 flushLock,
 };

 /*! rollup-include-development-only */
 if (options.spotlight && !clientOptions.integrations.some(({ name }) => name === SPOTLIGHT_INTEGRATION_NAME)) {
 clientOptions.integrations.push(
 spotlightIntegration({
 sidecarUrl: typeof options.spotlight === 'string' ? options.spotlight : undefined,
 }),
 );
 }
 /*! rollup-include-development-only-end */

 /**
 * The Cloudflare SDK is not OpenTelemetry native, however, we set up some OpenTelemetry compatibility
 * via a custom trace provider.
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(cloudflare): Add Spotlight integration for local dev event forwarding#22490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

JPeer264
merged 6 commits into

from

Jul 24, 2026
 Merged


feat(cloudflare): Add Spotlight integration for local dev event forwarding
#22490
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
60fbfc1

feat(cloudflare): Add Spotlight integration for local dev event forwa…


MathurAditya724 Jul 22, 2026
320966e

fix(cloudflare): Add spotlight property to BaseCloudflareOptions


MathurAditya724 Jul 22, 2026
c1568fe

fix: Address review findings — spotlight precedence, indent, test gaps


MathurAditya724 Jul 22, 2026
169f735

fix(cloudflare): Remove non-functional dev-only markers around spotli…


MathurAditya724 Jul 22, 2026
bd9bc63

Merge branch 'develop' into feat/cloudflare-spotlight-integration


MathurAditya724 Jul 22, 2026
dff8f1b

feat(cloudflare): Add dev/prod bundle in favor of spotlight


JPeer264 Jul 22, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -436,7 +436,7 @@ module.exports = [
 // Cloudflare SDK (ESM) - compressed, minified to match `wrangler deploy --dry-run --minify` output
 {
 name: '@sentry/cloudflare (withSentry) - minified',
 path: 'packages/cloudflare/build/esm/index.js',
 path: 'packages/cloudflare/build/esm/prod/index.js',
 import: createImport('withSentry', 'instrumentDurableObjectWithSentry', 'instrumentWorkflowWithSentry'),
 ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
 gzip: false,
Expand All@@ -456,7 +456,7 @@ module.exports = [
 // Cloudflare SDK (ESM) - uncompressed, unminified to match `wrangler deploy --dry-run` output
 {
 name: '@sentry/cloudflare (withSentry)',
 path: 'packages/cloudflare/build/esm/index.js',
 path: 'packages/cloudflare/build/esm/prod/index.js',
 import: createImport('withSentry', 'instrumentDurableObjectWithSentry', 'instrumentWorkflowWithSentry'),
 ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
 gzip: false,
Expand Down

56 changes: 23 additions & 33 deletions
packages/cloudflare/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,50 +12,40 @@
 "files": [
 "/build"
 ],
 "main": "build/cjs/index.js",
 "module": "build/esm/index.js",
 "main": "build/cjs/prod/index.js",
 "module": "build/esm/prod/index.js",
 "types": "build/types/index.d.ts",
 "exports": {
 "./package.json": "./package.json",
 ".": {
 "import": {
 "types": "./build/types/index.d.ts",
 "default": "./build/esm/index.js"
 "types": "./build/types/index.d.ts",
 "development": {
 "import": "./build/esm/dev/index.js",
 "require": "./build/cjs/dev/index.js"
 },
 "require": {
 "types": "./build/types/index.d.ts",
 "default": "./build/cjs/index.js"
 "production": {
 "import": "./build/esm/prod/index.js",
 "require": "./build/cjs/prod/index.js"
 },
 "default": {
 "import": "./build/esm/prod/index.js",
 "require": "./build/cjs/prod/index.js"
 }
 },
 "./request": {
 "import": {
 "types": "./build/types/request.d.ts",
 "default": "./build/esm/request.js"
 },
 "require": {
 "types": "./build/types/request.d.ts",
 "default": "./build/cjs/request.js"
 }
 "types": "./build/types/request.d.ts",
 "import": "./build/esm/prod/request.js",
 "require": "./build/cjs/prod/request.js"
 },
 "./nodejs_compat": {
 "import": {
 "types": "./build/types/nodejs_compat/index.d.ts",
 "default": "./build/esm/nodejs_compat/index.js"
 },
 "require": {
 "types": "./build/types/nodejs_compat/index.d.ts",
 "default": "./build/cjs/nodejs_compat/index.js"
 }
 "types": "./build/types/nodejs_compat/index.d.ts",
 "import": "./build/esm/prod/nodejs_compat/index.js",
 "require": "./build/cjs/prod/nodejs_compat/index.js"
 },
 "./vite": {
 "import": {
 "types": "./build/types/vite/index.d.ts",
 "default": "./build/esm/vite/index.js"
 },
 "require": {
 "types": "./build/types/vite/index.d.ts",
 "default": "./build/cjs/vite/index.js"
 }
 "types": "./build/types/vite/index.d.ts",
 "import": "./build/esm/prod/vite/index.js",
 "require": "./build/cjs/prod/vite/index.js"
 }
 },
 "publishConfig": {
Expand DownExpand Up@@ -98,7 +88,7 @@
 "clean": "rimraf build coverage sentry-cloudflare-*.tgz",
 "lint:fix": "OXLINT_TSGOLINT_DANGEROUSLY_SUPPRESS_PROGRAM_DIAGNOSTICS=true oxlint . --fix --type-aware",
 "lint": "OXLINT_TSGOLINT_DANGEROUSLY_SUPPRESS_PROGRAM_DIAGNOSTICS=true oxlint . --type-aware",
 "lint:es-compatibility": "es-check es2022 ./build/cjs/*.js && es-check es2022 ./build/esm/*.js --module",
 "lint:es-compatibility": "es-check es2022 ./build/cjs/prod/*.js && es-check es2022 ./build/esm/prod/*.js --module",
 "test": "yarn test:unit",
 "test:unit": "vitest run",
 "test:watch": "vitest --watch",
Expand Down

1 change: 1 addition & 0 deletions
packages/cloudflare/rollup.npm.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,4 +4,5 @@ export default makeNPMConfigVariants(
 makeBaseNPMConfig({
 entrypoints: ['src/index.ts', 'src/nodejs_compat/index.ts', 'src/vite/index.ts'],
 }),
 { splitDevProd: true },
);

12 changes: 12 additions & 0 deletions
packages/cloudflare/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -253,6 +253,18 @@ interface BaseCloudflareOptions {
 * @default false
 */
 instrumentPrototypeMethods?: boolean | string[];

 /**
 * If you use Spotlight by Sentry during development, use
 * this option to forward captured Sentry events to Spotlight.
 *
 * Either set it to true, or provide a specific Spotlight Sidecar URL.
 *
 * More details: https://spotlightjs.com/
 *
 * IMPORTANT: Only set this option to `true` while developing, not in production!
 */
 spotlight?: boolean | string;
}

/**
Expand Down

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -128,6 +128,7 @@ export { getDefaultIntegrations } from './sdk';

export { httpServerIntegration } from './integrations/httpServer';
export { fetchIntegration } from './integrations/fetch';
export { spotlightIntegration } from './integrations/spotlight';
export { vercelAIIntegration } from './integrations/tracing/vercelai';

// eslint-disable-next-line typescript/no-deprecated
Expand Down

89 changes: 89 additions & 0 deletions
packages/cloudflare/src/integrations/spotlight.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
import type { Client, Envelope, IntegrationFn } from '@sentry/core';
import { debug, defineIntegration, serializeEnvelope, suppressTracing } from '@sentry/core';
import { DEBUG_BUILD } from '../debug-build';

type SpotlightConnectionOptions = {
 /**
 * Set this if the Spotlight Sidecar is not running on localhost:8969.
 * By default, the URL is set to http://localhost:8969/stream
 */
 sidecarUrl?: string;
};

export const INTEGRATION_NAME = 'Spotlight' as const;

const _spotlightIntegration = ((options: Partial<SpotlightConnectionOptions> = {}) => {
 const sidecarUrl = options.sidecarUrl || 'http://localhost:8969/stream';

 return {
 name: INTEGRATION_NAME,
 setup(client) {
 DEBUG_BUILD && debug.log('[Spotlight] Using Sidecar URL', sidecarUrl);
 setupSidecarForwarding(client, sidecarUrl);
 },
 };
}) satisfies IntegrationFn;

/**
 * Use this integration to send errors and transactions to Spotlight.
 *
 * Learn more about spotlight at https://spotlightjs.com
 *
 * Important: This integration is intended for local development only.
 * Each forwarded envelope counts as a Worker subrequest (50 free / 1000 paid
 * per invocation), so it should not be enabled in production.
 */
export const spotlightIntegration = defineIntegration(_spotlightIntegration);

function setupSidecarForwarding(client: Client, sidecarUrl: string): void {
 const parsedUrl = parseSidecarUrl(sidecarUrl);
 if (!parsedUrl) {
 return;
 }

 let failCount = 0;

 client.on('beforeEnvelope', (envelope: Envelope) => {
 if (failCount > 3) {
 DEBUG_BUILD && debug.warn('[Spotlight] Disabled Sentry -> Spotlight forwarding due to too many failed requests');
 return;
 }

 const body = serializeEnvelope(envelope);

 suppressTracing(() => {
 fetch(parsedUrl.href, {
 method: 'POST',
 body,
 headers: {
 'Content-Type': 'application/x-sentry-envelope',
 },
 }).then(
 res => {
 // Consume the response body to satisfy Cloudflare Workers' requirement
 // that all fetch response bodies are read or cancelled.
 res.text().catch(() => {
 // no-op
 });

 if (res.status >= 200 && res.status < 400) {
 failCount = 0;
 }
 },
 () => {
 failCount++;
 DEBUG_BUILD && debug.warn('[Spotlight] Failed to send envelope to Spotlight Sidecar');
 },
 );
 });
 });
}

function parseSidecarUrl(url: string): URL | undefined {
 try {
 return new URL(url);
 } catch {
 DEBUG_BUILD && debug.warn(`[Spotlight] Invalid sidecar URL: ${url}`);
 return undefined;
 }
}

38 changes: 38 additions & 0 deletions
packages/cloudflare/src/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,14 @@ export function getFinalOptions(userOptions: CloudflareOptions = {}, env: unknow
 const tracesSampleRate =
 userOptions.tracesSampleRate ?? parseFloat(getEnvVar(env, 'SENTRY_TRACES_SAMPLE_RATE') ?? '');

 // Spotlight precedence (mirrors node-core's getSpotlightConfig):
 // - false or explicit string from options: use as-is
 // - true: enable, but prefer a custom URL from the env var if set
 // - undefined: defer entirely to the env var (bool or URL)
 /*! rollup-include-development-only */
 const spotlight = getSpotlightFromEnv(userOptions.spotlight, getEnvVar(env, 'SENTRY_SPOTLIGHT'));
 /*! rollup-include-development-only-end */

 return {
 release,
 ...userOptions,
Expand All@@ -62,5 +70,35 @@ export function getFinalOptions(userOptions: CloudflareOptions = {}, env: unknow
 tracesSampleRate: isFinite(tracesSampleRate) ? tracesSampleRate : undefined,
 debug: userOptions.debug ?? envToBool(getEnvVar(env, 'SENTRY_DEBUG')),
 tunnel: userOptions.tunnel ?? getEnvVar(env, 'SENTRY_TUNNEL'),
 /*! rollup-include-development-only */
 spotlight,
 /*! rollup-include-development-only-end */
 };
}

/**
 * Resolve the spotlight option from a user-supplied value and an env binding string.
 * Mirrors node-core's `getSpotlightConfig` precedence:
 * - `false` or explicit string from options → use as-is
 * - `true` → enable, but prefer a custom URL from the env var if set
 * - `undefined` → defer entirely to the env var (bool or URL)
 */
function getSpotlightFromEnv(
 optionsSpotlight: boolean | string | undefined,
 envVar: string | undefined,
): boolean | string | undefined {
 if (optionsSpotlight === false) {
 return false;
 }
 if (typeof optionsSpotlight === 'string') {
 return optionsSpotlight;
 }

 // optionsSpotlight is true or undefined
 const envBool = envToBool(envVar, { strict: true });
 const envUrl = envBool === null && envVar ? envVar : undefined;

 return optionsSpotlight === true
 ? (envUrl ?? true) // true: use env URL if present, otherwise true
 : (envBool ?? envUrl); // undefined: use env var (bool or URL)
}

11 changes: 11 additions & 0 deletions
packages/cloudflare/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ import { CloudflareClient } from './client';
import { makeFlushLock } from './flush';
import { httpServerIntegration } from './integrations/httpServer';
import { fetchIntegration } from './integrations/fetch';
import { INTEGRATION_NAME as SPOTLIGHT_INTEGRATION_NAME, spotlightIntegration } from './integrations/spotlight';
import { setupOpenTelemetryTracer } from './opentelemetry/tracer';
import { makeCloudflareTransport } from './transport';
import { defaultStackParser } from './vendor/stacktrace';
Expand DownExpand Up@@ -88,6 +89,16 @@ export function init(options: CloudflareOptions): CloudflareClient | undefined {
 flushLock,
 };

 /*! rollup-include-development-only */
 if (options.spotlight && !clientOptions.integrations.some(({ name }) => name === SPOTLIGHT_INTEGRATION_NAME)) {
 clientOptions.integrations.push(
 spotlightIntegration({
 sidecarUrl: typeof options.spotlight === 'string' ? options.spotlight : undefined,
 }),
 );
 }
 /*! rollup-include-development-only-end */

 /**
 * The Cloudflare SDK is not OpenTelemetry native, however, we set up some OpenTelemetry compatibility
 * via a custom trace provider.
Expand Down
Loading
Loading