Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,16 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
);
});

// The greet() call goes over the websocket, so its storage spans land in a webSocketMessage
// transaction. Filter for the one carrying our put span — control messages produce their own
// webSocketMessage transactions without storage spans.
const storageTransactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
return (
transactionEvent.transaction === 'webSocketMessage' &&
(transactionEvent.spans ?? []).some(span => span.description === 'durable_object_storage_put')
);
});

await page.goto(baseURL!);

await expect(page.getByText('Connected')).toBeVisible();
Expand All@@ -32,24 +42,7 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
culture: { timezone: expect.any(String) },
runtime: { name: 'cloudflare' },
},
spans: expect.arrayContaining([
expect.objectContaining({
data: {
'db.operation.name': 'get',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
]),
spans: [],
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
transaction: 'GET /agents/my-agent/user-123',
Expand All@@ -72,4 +65,65 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
packages: expect.any(Array),
},
});

// greet() touches 6 storage keys: 2 user ops + 3 framework-internal keys (cf_, __ps_, /) that
// must be filtered + 1 allowlisted cf_ key. Spans carry no key attribute, so filtering can only
// be verified by count — exactly these 3 storage spans (in execution order) should survive, and
// any framework-internal span leaking through shows up as an extra entry here.
const storageTransaction = await storageTransactionPromise;

const storageSpans = (storageTransaction.spans ?? []).filter(
span => span.origin === 'auto.db.cloudflare.durable_object',
);

expect(storageSpans).toEqual([
expect.objectContaining({
data: {
'db.operation.name': 'put',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_put',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
expect.objectContaining({
data: {
'db.operation.name': 'get',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
expect.objectContaining({
data: {
'db.operation.name': 'get',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
]);
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,18 @@ import { routeAgentRequest, Agent, callable } from 'agents';
class MyBaseAgent extends Agent {
@callable()
async greet(name: string): Promise<string> {
// User keys — instrumented, spans expected
await this.ctx.storage.put('test', 'any value');
await this.ctx.storage.get('test');

// Framework-internal keys (agents/partyserver/MCP OAuth conventions) — filtered, no spans expected
await this.ctx.storage.put('cf_e2e_internal', 'bookkeeping');
await this.ctx.storage.get('__ps_name');
await this.ctx.storage.get('/oauth/client/token');

// Allowlisted cf_ key — span expected
await this.ctx.storage.get('cf_user_key');

return `Hello, ${name}!`;
}
}
Expand All@@ -14,6 +26,7 @@ export const MyAgent = Sentry.instrumentDurableObjectWithSentry(
tunnel: `http://localhost:3031/`,
tracesSampleRate: 1,
enableRpcTracePropagation: true,
durableObjectStorageSpanAllowlist: ['cf_user_key'],
}),
MyBaseAgent,
);
Expand Down
25 changes: 25 additions & 0 deletions packages/cloudflare/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -240,6 +240,31 @@ interface BaseCloudflareOptions {
*/
durableObjectSqlSpanAllowlist?: Array<string | RegExp>;

/**
* KV keys that should stay instrumented even though they match a reserved prefix used by Durable
* Object frameworks (`agents`, `partyserver`, ...) for their internal storage entries.
*
* By default, KV reads/writes (`get`, `put`, `delete`, `list`) of `cf_`- or `__ps_`-prefixed keys
* are treated as framework noise and no `durable_object_storage_*` span is created for them,
* mirroring how `cf_`-prefixed SQL tables are handled (see {@link durableObjectSqlSpanAllowlist}).
* If one of your own keys happens to use such a prefix, add it here to opt it back into
* instrumentation. Strings must match exactly, while regular expressions give you prefix/pattern
* matching.
*
* @default []
* @example
* ```ts
* export default Sentry.withSentry(
* (env) => ({
* dsn: env.SENTRY_DSN,
* durableObjectStorageSpanAllowlist: ['cf_my_key', /^cf_reports_/],
* }),
* handler,
* );
* ```
*/
durableObjectStorageSpanAllowlist?: Array<string | RegExp>;

/**
* @deprecated Use `enableRpcTracePropagation` instead. This option will be removed in a future major version.
*
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
import type { DurableObjectStorage, SyncKvStorage, SqlStorage } from '@cloudflare/workers-types';
import { isThenable, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import { getClient, isThenable, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import type { CloudflareClientOptions } from '../client';
import { getStorageKeys, targetsCloudflareInternalKey } from '../utils/internalStorageKey';
import { storeSpanContext } from '../utils/traceLinks';
import { instrumentDurableObjectSyncKvStorage } from './instrumentDurableObjectSyncKvStorage';
import { instrumentSqlStorage } from './instrumentSqlStorage';
Expand DownExpand Up@@ -55,6 +57,15 @@ export function instrumentDurableObjectStorage(
}

return function (this: unknown, ...args: unknown[]) {
// KV entries managed by the DO framework itself (agents/partyserver state) are bookkeeping
// rather than user work — skip the span, mirroring how `cf_` SQL tables are treated.
const allowlist = (getClient()?.getOptions() as CloudflareClientOptions | undefined)
?.durableObjectStorageSpanAllowlist;
const keys = getStorageKeys(methodName, args);
if (keys && keys.length > 0 && keys.every(key => targetsCloudflareInternalKey(key, allowlist))) {
return (original as (...a: unknown[]) => unknown).apply(target, args);
}

return startSpan(
{
// Use underscore naming to match Cloudflare's native instrumentation (e.g., "durable_object_storage_get")
Expand Down
75 changes: 75 additions & 0 deletions packages/cloudflare/src/utils/internalStorageKey.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
import { stringMatchesSomePattern } from '@sentry/core';

/**
* Cloudflare frameworks that build on Durable Objects (`agents`, `partyserver`, ...) also manage
* their own internal KV entries alongside their internal SQLite tables, namespaced with a reserved
* prefix — e.g. `cf_agents_state`, `cf_agents_mcp_servers`, `__ps_name`. Reads/writes of these
* (message persistence, MCP connection bookkeeping, name hydration) are framework implementation
* details that otherwise flood traces with dozens of zero-signal `durable_object_storage_*` spans
* per request, so we match the reserved prefixes rather than an enumerated list. This mirrors the
* `cf_` convention used for internal SQL tables (see `targetsCloudflareInternalTable`).
*
* The prefixes are a reserved convention for framework-managed entries, so user keys should not use
* them. In case a user key does collide, the `durableObjectStorageSpanAllowlist` option lets them
* opt those keys back into instrumentation.
*/
export function targetsCloudflareInternalKey(key: string | undefined, allowlist?: Array<string | RegExp>): boolean {
if (!key) {
return false;
}

// Framework-managed KV namespaces:
// - `cf_` — agents / ai-chat internal state (mirrors the internal SQL table convention)
// - `__ps_` — partyserver internals (e.g. `__ps_name`)
// - `/` — MCP OAuth client state (`/<clientName>/<serverId>/{token,client_info,state,...}`),
// read on every MCP tool call. User keys on an Agent rarely use a leading slash; if one does,
// the allowlist opts it back in.
const isFrameworkKey = key.startsWith('cf_') || key.startsWith('__ps_') || key.startsWith('/');
if (!isFrameworkKey) {
return false;
}

// A key on the allowlist is treated as a user key and stays instrumented, even though it matches
// a reserved prefix.
return !allowlist?.length || !stringMatchesSomePattern(key, allowlist, true);
}

/**
* Extracts the KV keys a Durable Object storage call targets, so the caller can decide whether the
* operation only touches framework-internal entries. Returns `undefined` when the keys can't be
* determined from the arguments (e.g. `list()` without a prefix), in which case the call is treated
* as user work and stays instrumented.
*/
export function getStorageKeys(methodName: string, args: unknown[]): string[] | undefined {
const [first] = args;

if (methodName === 'get' || methodName === 'delete') {
// get(key) / get(keys[]) / delete(key) / delete(keys[])
if (typeof first === 'string') {
return [first];
}
if (Array.isArray(first)) {
return first.filter((k): k is string => typeof k === 'string');
}
return undefined;
}

if (methodName === 'put') {
// put(key, value) or put({ key: value, ... })
if (typeof first === 'string') {
return [first];
}
if (first && typeof first === 'object' && !Array.isArray(first)) {
return Object.keys(first);
}
return undefined;
}

if (methodName === 'list') {
// list({ prefix })
const prefix = first && typeof first === 'object' ? (first as { prefix?: unknown }).prefix : undefined;
return typeof prefix === 'string' ? [prefix] : undefined;
}

return undefined;
}
74 changes: 74 additions & 0 deletions packages/cloudflare/test/instrumentDurableObjectStorage.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -324,6 +324,80 @@ describe('instrumentDurableObjectStorage', () => {
);
});

describe('framework-internal KV keys', () => {
it('does not create a span for a cf_-prefixed get', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get('cf_agents_state');

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a __ps_-prefixed get', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get('__ps_name');

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a cf_-prefixed put with object entries', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.put({ cf_agents_a: 1, cf_agents_b: 2 });

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a cf_-prefixed delete with an array of keys', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.delete(['cf_agents_a', 'cf_agents_b']);

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a list with a cf_ prefix', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.list({ prefix: 'cf_agents_' });

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('still creates a span when a batch mixes framework and user keys', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get(['cf_agents_state', 'myKey']);

expect(startSpanSpy).toHaveBeenCalled();
});

it('still creates a span for a list without a prefix', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.list();

expect(startSpanSpy).toHaveBeenCalled();
});

it('still creates a span for a user key', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get('myKey');

expect(startSpanSpy).toHaveBeenCalled();
});
});

describe('non-instrumented methods', () => {
it('does not instrument deleteAll, sync, transaction', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,16 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
);
});

// The greet() call goes over the websocket, so its storage spans land in a webSocketMessage
// transaction. Filter for the one carrying our put span — control messages produce their own
// webSocketMessage transactions without storage spans.
const storageTransactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
return (
transactionEvent.transaction === 'webSocketMessage' &&
(transactionEvent.spans ?? []).some(span => span.description === 'durable_object_storage_put')
);
});

await page.goto(baseURL!);

await expect(page.getByText('Connected')).toBeVisible();
Expand All@@ -32,24 +42,7 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
culture: { timezone: expect.any(String) },
runtime: { name: 'cloudflare' },
},
spans: expect.arrayContaining([
expect.objectContaining({
data: {
'db.operation.name': 'get',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
]),
spans: [],
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
transaction: 'GET /agents/my-agent/user-123',
Expand All@@ -72,4 +65,65 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
packages: expect.any(Array),
},
});

// greet() touches 6 storage keys: 2 user ops + 3 framework-internal keys (cf_, __ps_, /) that
// must be filtered + 1 allowlisted cf_ key. Spans carry no key attribute, so filtering can only
// be verified by count — exactly these 3 storage spans (in execution order) should survive, and
// any framework-internal span leaking through shows up as an extra entry here.
const storageTransaction = await storageTransactionPromise;

const storageSpans = (storageTransaction.spans ?? []).filter(
span => span.origin === 'auto.db.cloudflare.durable_object',
);

expect(storageSpans).toEqual([
expect.objectContaining({
data: {
'db.operation.name': 'put',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_put',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
expect.objectContaining({
data: {
'db.operation.name': 'get',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
expect.objectContaining({
data: {
'db.operation.name': 'get',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
]);
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,18 @@ import { routeAgentRequest, Agent, callable } from 'agents';
class MyBaseAgent extends Agent {
@callable()
async greet(name: string): Promise<string> {
// User keys — instrumented, spans expected
await this.ctx.storage.put('test', 'any value');
await this.ctx.storage.get('test');

// Framework-internal keys (agents/partyserver/MCP OAuth conventions) — filtered, no spans expected
await this.ctx.storage.put('cf_e2e_internal', 'bookkeeping');
await this.ctx.storage.get('__ps_name');
await this.ctx.storage.get('/oauth/client/token');

// Allowlisted cf_ key — span expected
await this.ctx.storage.get('cf_user_key');

return `Hello, ${name}!`;
}
}
Expand All@@ -14,6 +26,7 @@ export const MyAgent = Sentry.instrumentDurableObjectWithSentry(
tunnel: `http://localhost:3031/`,
tracesSampleRate: 1,
enableRpcTracePropagation: true,
durableObjectStorageSpanAllowlist: ['cf_user_key'],
}),
MyBaseAgent,
);
Expand Down
25 changes: 25 additions & 0 deletions packages/cloudflare/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -240,6 +240,31 @@ interface BaseCloudflareOptions {
*/
durableObjectSqlSpanAllowlist?: Array<string | RegExp>;

/**
* KV keys that should stay instrumented even though they match a reserved prefix used by Durable
* Object frameworks (`agents`, `partyserver`, ...) for their internal storage entries.
*
* By default, KV reads/writes (`get`, `put`, `delete`, `list`) of `cf_`- or `__ps_`-prefixed keys
* are treated as framework noise and no `durable_object_storage_*` span is created for them,
* mirroring how `cf_`-prefixed SQL tables are handled (see {@link durableObjectSqlSpanAllowlist}).
* If one of your own keys happens to use such a prefix, add it here to opt it back into
* instrumentation. Strings must match exactly, while regular expressions give you prefix/pattern
* matching.
*
* @default []
* @example
* ```ts
* export default Sentry.withSentry(
* (env) => ({
* dsn: env.SENTRY_DSN,
* durableObjectStorageSpanAllowlist: ['cf_my_key', /^cf_reports_/],
* }),
* handler,
* );
* ```
*/
durableObjectStorageSpanAllowlist?: Array<string | RegExp>;

/**
* @deprecated Use `enableRpcTracePropagation` instead. This option will be removed in a future major version.
*
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
import type { DurableObjectStorage, SyncKvStorage, SqlStorage } from '@cloudflare/workers-types';
import { isThenable, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import { getClient, isThenable, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import type { CloudflareClientOptions } from '../client';
import { getStorageKeys, targetsCloudflareInternalKey } from '../utils/internalStorageKey';
import { storeSpanContext } from '../utils/traceLinks';
import { instrumentDurableObjectSyncKvStorage } from './instrumentDurableObjectSyncKvStorage';
import { instrumentSqlStorage } from './instrumentSqlStorage';
Expand DownExpand Up@@ -55,6 +57,15 @@ export function instrumentDurableObjectStorage(
}

return function (this: unknown, ...args: unknown[]) {
// KV entries managed by the DO framework itself (agents/partyserver state) are bookkeeping
// rather than user work — skip the span, mirroring how `cf_` SQL tables are treated.
const allowlist = (getClient()?.getOptions() as CloudflareClientOptions | undefined)
?.durableObjectStorageSpanAllowlist;
const keys = getStorageKeys(methodName, args);
if (keys && keys.length > 0 && keys.every(key => targetsCloudflareInternalKey(key, allowlist))) {
return (original as (...a: unknown[]) => unknown).apply(target, args);
}

return startSpan(
{
// Use underscore naming to match Cloudflare's native instrumentation (e.g., "durable_object_storage_get")
Expand Down
75 changes: 75 additions & 0 deletions packages/cloudflare/src/utils/internalStorageKey.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
import { stringMatchesSomePattern } from '@sentry/core';

/**
* Cloudflare frameworks that build on Durable Objects (`agents`, `partyserver`, ...) also manage
* their own internal KV entries alongside their internal SQLite tables, namespaced with a reserved
* prefix — e.g. `cf_agents_state`, `cf_agents_mcp_servers`, `__ps_name`. Reads/writes of these
* (message persistence, MCP connection bookkeeping, name hydration) are framework implementation
* details that otherwise flood traces with dozens of zero-signal `durable_object_storage_*` spans
* per request, so we match the reserved prefixes rather than an enumerated list. This mirrors the
* `cf_` convention used for internal SQL tables (see `targetsCloudflareInternalTable`).
*
* The prefixes are a reserved convention for framework-managed entries, so user keys should not use
* them. In case a user key does collide, the `durableObjectStorageSpanAllowlist` option lets them
* opt those keys back into instrumentation.
*/
export function targetsCloudflareInternalKey(key: string | undefined, allowlist?: Array<string | RegExp>): boolean {
if (!key) {
return false;
}

// Framework-managed KV namespaces:
// - `cf_` — agents / ai-chat internal state (mirrors the internal SQL table convention)
// - `__ps_` — partyserver internals (e.g. `__ps_name`)
// - `/` — MCP OAuth client state (`/<clientName>/<serverId>/{token,client_info,state,...}`),
// read on every MCP tool call. User keys on an Agent rarely use a leading slash; if one does,
// the allowlist opts it back in.
const isFrameworkKey = key.startsWith('cf_') || key.startsWith('__ps_') || key.startsWith('/');
if (!isFrameworkKey) {
return false;
}

// A key on the allowlist is treated as a user key and stays instrumented, even though it matches
// a reserved prefix.
return !allowlist?.length || !stringMatchesSomePattern(key, allowlist, true);
}

/**
* Extracts the KV keys a Durable Object storage call targets, so the caller can decide whether the
* operation only touches framework-internal entries. Returns `undefined` when the keys can't be
* determined from the arguments (e.g. `list()` without a prefix), in which case the call is treated
* as user work and stays instrumented.
*/
export function getStorageKeys(methodName: string, args: unknown[]): string[] | undefined {
const [first] = args;

if (methodName === 'get' || methodName === 'delete') {
// get(key) / get(keys[]) / delete(key) / delete(keys[])
if (typeof first === 'string') {
return [first];
}
if (Array.isArray(first)) {
return first.filter((k): k is string => typeof k === 'string');
}
return undefined;
}

if (methodName === 'put') {
// put(key, value) or put({ key: value, ... })
if (typeof first === 'string') {
return [first];
}
if (first && typeof first === 'object' && !Array.isArray(first)) {
return Object.keys(first);
}
return undefined;
}

if (methodName === 'list') {
// list({ prefix })
const prefix = first && typeof first === 'object' ? (first as { prefix?: unknown }).prefix : undefined;
return typeof prefix === 'string' ? [prefix] : undefined;
}

return undefined;
}
74 changes: 74 additions & 0 deletions packages/cloudflare/test/instrumentDurableObjectStorage.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -324,6 +324,80 @@ describe('instrumentDurableObjectStorage', () => {
);
});

describe('framework-internal KV keys', () => {
it('does not create a span for a cf_-prefixed get', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get('cf_agents_state');

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a __ps_-prefixed get', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get('__ps_name');

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a cf_-prefixed put with object entries', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.put({ cf_agents_a: 1, cf_agents_b: 2 });

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a cf_-prefixed delete with an array of keys', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.delete(['cf_agents_a', 'cf_agents_b']);

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a list with a cf_ prefix', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.list({ prefix: 'cf_agents_' });

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('still creates a span when a batch mixes framework and user keys', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get(['cf_agents_state', 'myKey']);

expect(startSpanSpy).toHaveBeenCalled();
});

it('still creates a span for a list without a prefix', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.list();

expect(startSpanSpy).toHaveBeenCalled();
});

it('still creates a span for a user key', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get('myKey');

expect(startSpanSpy).toHaveBeenCalled();
});
});

describe('non-instrumented methods', () => {
it('does not instrument deleteAll, sync, transaction', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,16 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
);
});

// The greet() call goes over the websocket, so its storage spans land in a webSocketMessage
// transaction. Filter for the one carrying our put span — control messages produce their own
// webSocketMessage transactions without storage spans.
const storageTransactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
return (
transactionEvent.transaction === 'webSocketMessage' &&
(transactionEvent.spans ?? []).some(span => span.description === 'durable_object_storage_put')
);
});

await page.goto(baseURL!);

await expect(page.getByText('Connected')).toBeVisible();
Expand All@@ -32,24 +42,7 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
culture: { timezone: expect.any(String) },
runtime: { name: 'cloudflare' },
},
spans: expect.arrayContaining([
expect.objectContaining({
data: {
'db.operation.name': 'get',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
]),
spans: [],
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
transaction: 'GET /agents/my-agent/user-123',
Expand All@@ -72,4 +65,65 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
packages: expect.any(Array),
},
});

// greet() touches 6 storage keys: 2 user ops + 3 framework-internal keys (cf_, __ps_, /) that
// must be filtered + 1 allowlisted cf_ key. Spans carry no key attribute, so filtering can only
// be verified by count — exactly these 3 storage spans (in execution order) should survive, and
// any framework-internal span leaking through shows up as an extra entry here.
const storageTransaction = await storageTransactionPromise;

const storageSpans = (storageTransaction.spans ?? []).filter(
span => span.origin === 'auto.db.cloudflare.durable_object',
);

expect(storageSpans).toEqual([
expect.objectContaining({
data: {
'db.operation.name': 'put',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_put',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
expect.objectContaining({
data: {
'db.operation.name': 'get',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
expect.objectContaining({
data: {
'db.operation.name': 'get',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
]);
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,18 @@ import { routeAgentRequest, Agent, callable } from 'agents';
class MyBaseAgent extends Agent {
@callable()
async greet(name: string): Promise<string> {
// User keys — instrumented, spans expected
await this.ctx.storage.put('test', 'any value');
await this.ctx.storage.get('test');

// Framework-internal keys (agents/partyserver/MCP OAuth conventions) — filtered, no spans expected
await this.ctx.storage.put('cf_e2e_internal', 'bookkeeping');
await this.ctx.storage.get('__ps_name');
await this.ctx.storage.get('/oauth/client/token');

// Allowlisted cf_ key — span expected
await this.ctx.storage.get('cf_user_key');

return `Hello, ${name}!`;
}
}
Expand All@@ -14,6 +26,7 @@ export const MyAgent = Sentry.instrumentDurableObjectWithSentry(
tunnel: `http://localhost:3031/`,
tracesSampleRate: 1,
enableRpcTracePropagation: true,
durableObjectStorageSpanAllowlist: ['cf_user_key'],
}),
MyBaseAgent,
);
Expand Down
25 changes: 25 additions & 0 deletions packages/cloudflare/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -240,6 +240,31 @@ interface BaseCloudflareOptions {
*/
durableObjectSqlSpanAllowlist?: Array<string | RegExp>;

/**
* KV keys that should stay instrumented even though they match a reserved prefix used by Durable
* Object frameworks (`agents`, `partyserver`, ...) for their internal storage entries.
*
* By default, KV reads/writes (`get`, `put`, `delete`, `list`) of `cf_`- or `__ps_`-prefixed keys
* are treated as framework noise and no `durable_object_storage_*` span is created for them,
* mirroring how `cf_`-prefixed SQL tables are handled (see {@link durableObjectSqlSpanAllowlist}).
* If one of your own keys happens to use such a prefix, add it here to opt it back into
* instrumentation. Strings must match exactly, while regular expressions give you prefix/pattern
* matching.
*
* @default []
* @example
* ```ts
* export default Sentry.withSentry(
* (env) => ({
* dsn: env.SENTRY_DSN,
* durableObjectStorageSpanAllowlist: ['cf_my_key', /^cf_reports_/],
* }),
* handler,
* );
* ```
*/
durableObjectStorageSpanAllowlist?: Array<string | RegExp>;

/**
* @deprecated Use `enableRpcTracePropagation` instead. This option will be removed in a future major version.
*
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
import type { DurableObjectStorage, SyncKvStorage, SqlStorage } from '@cloudflare/workers-types';
import { isThenable, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import { getClient, isThenable, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import type { CloudflareClientOptions } from '../client';
import { getStorageKeys, targetsCloudflareInternalKey } from '../utils/internalStorageKey';
import { storeSpanContext } from '../utils/traceLinks';
import { instrumentDurableObjectSyncKvStorage } from './instrumentDurableObjectSyncKvStorage';
import { instrumentSqlStorage } from './instrumentSqlStorage';
Expand DownExpand Up@@ -55,6 +57,15 @@ export function instrumentDurableObjectStorage(
}

return function (this: unknown, ...args: unknown[]) {
// KV entries managed by the DO framework itself (agents/partyserver state) are bookkeeping
// rather than user work — skip the span, mirroring how `cf_` SQL tables are treated.
const allowlist = (getClient()?.getOptions() as CloudflareClientOptions | undefined)
?.durableObjectStorageSpanAllowlist;
const keys = getStorageKeys(methodName, args);
if (keys && keys.length > 0 && keys.every(key => targetsCloudflareInternalKey(key, allowlist))) {
return (original as (...a: unknown[]) => unknown).apply(target, args);
}

return startSpan(
{
// Use underscore naming to match Cloudflare's native instrumentation (e.g., "durable_object_storage_get")
Expand Down
75 changes: 75 additions & 0 deletions packages/cloudflare/src/utils/internalStorageKey.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
import { stringMatchesSomePattern } from '@sentry/core';

/**
* Cloudflare frameworks that build on Durable Objects (`agents`, `partyserver`, ...) also manage
* their own internal KV entries alongside their internal SQLite tables, namespaced with a reserved
* prefix — e.g. `cf_agents_state`, `cf_agents_mcp_servers`, `__ps_name`. Reads/writes of these
* (message persistence, MCP connection bookkeeping, name hydration) are framework implementation
* details that otherwise flood traces with dozens of zero-signal `durable_object_storage_*` spans
* per request, so we match the reserved prefixes rather than an enumerated list. This mirrors the
* `cf_` convention used for internal SQL tables (see `targetsCloudflareInternalTable`).
*
* The prefixes are a reserved convention for framework-managed entries, so user keys should not use
* them. In case a user key does collide, the `durableObjectStorageSpanAllowlist` option lets them
* opt those keys back into instrumentation.
*/
export function targetsCloudflareInternalKey(key: string | undefined, allowlist?: Array<string | RegExp>): boolean {
if (!key) {
return false;
}

// Framework-managed KV namespaces:
// - `cf_` — agents / ai-chat internal state (mirrors the internal SQL table convention)
// - `__ps_` — partyserver internals (e.g. `__ps_name`)
// - `/` — MCP OAuth client state (`/<clientName>/<serverId>/{token,client_info,state,...}`),
// read on every MCP tool call. User keys on an Agent rarely use a leading slash; if one does,
// the allowlist opts it back in.
const isFrameworkKey = key.startsWith('cf_') || key.startsWith('__ps_') || key.startsWith('/');
if (!isFrameworkKey) {
return false;
}

// A key on the allowlist is treated as a user key and stays instrumented, even though it matches
// a reserved prefix.
return !allowlist?.length || !stringMatchesSomePattern(key, allowlist, true);
}

/**
* Extracts the KV keys a Durable Object storage call targets, so the caller can decide whether the
* operation only touches framework-internal entries. Returns `undefined` when the keys can't be
* determined from the arguments (e.g. `list()` without a prefix), in which case the call is treated
* as user work and stays instrumented.
*/
export function getStorageKeys(methodName: string, args: unknown[]): string[] | undefined {
const [first] = args;

if (methodName === 'get' || methodName === 'delete') {
// get(key) / get(keys[]) / delete(key) / delete(keys[])
if (typeof first === 'string') {
return [first];
}
if (Array.isArray(first)) {
return first.filter((k): k is string => typeof k === 'string');
}
return undefined;
}

if (methodName === 'put') {
// put(key, value) or put({ key: value, ... })
if (typeof first === 'string') {
return [first];
}
if (first && typeof first === 'object' && !Array.isArray(first)) {
return Object.keys(first);
}
return undefined;
}

if (methodName === 'list') {
// list({ prefix })
const prefix = first && typeof first === 'object' ? (first as { prefix?: unknown }).prefix : undefined;
return typeof prefix === 'string' ? [prefix] : undefined;
}

return undefined;
}
74 changes: 74 additions & 0 deletions packages/cloudflare/test/instrumentDurableObjectStorage.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -324,6 +324,80 @@ describe('instrumentDurableObjectStorage', () => {
);
});

describe('framework-internal KV keys', () => {
it('does not create a span for a cf_-prefixed get', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get('cf_agents_state');

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a __ps_-prefixed get', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get('__ps_name');

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a cf_-prefixed put with object entries', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.put({ cf_agents_a: 1, cf_agents_b: 2 });

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a cf_-prefixed delete with an array of keys', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.delete(['cf_agents_a', 'cf_agents_b']);

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a list with a cf_ prefix', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.list({ prefix: 'cf_agents_' });

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('still creates a span when a batch mixes framework and user keys', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get(['cf_agents_state', 'myKey']);

expect(startSpanSpy).toHaveBeenCalled();
});

it('still creates a span for a list without a prefix', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.list();

expect(startSpanSpy).toHaveBeenCalled();
});

it('still creates a span for a user key', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get('myKey');

expect(startSpanSpy).toHaveBeenCalled();
});
});

describe('non-instrumented methods', () => {
it('does not instrument deleteAll, sync, transaction', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,16 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
);
});

// The greet() call goes over the websocket, so its storage spans land in a webSocketMessage
// transaction. Filter for the one carrying our put span — control messages produce their own
// webSocketMessage transactions without storage spans.
const storageTransactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
return (
transactionEvent.transaction === 'webSocketMessage' &&
(transactionEvent.spans ?? []).some(span => span.description === 'durable_object_storage_put')
);
});

await page.goto(baseURL!);

await expect(page.getByText('Connected')).toBeVisible();
Expand All@@ -32,24 +42,7 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
culture: { timezone: expect.any(String) },
runtime: { name: 'cloudflare' },
},
spans: expect.arrayContaining([
expect.objectContaining({
data: {
'db.operation.name': 'get',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
]),
spans: [],
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
transaction: 'GET /agents/my-agent/user-123',
Expand All@@ -72,4 +65,65 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
packages: expect.any(Array),
},
});

// greet() touches 6 storage keys: 2 user ops + 3 framework-internal keys (cf_, __ps_, /) that
// must be filtered + 1 allowlisted cf_ key. Spans carry no key attribute, so filtering can only
// be verified by count — exactly these 3 storage spans (in execution order) should survive, and
// any framework-internal span leaking through shows up as an extra entry here.
const storageTransaction = await storageTransactionPromise;

const storageSpans = (storageTransaction.spans ?? []).filter(
span => span.origin === 'auto.db.cloudflare.durable_object',
);

expect(storageSpans).toEqual([
expect.objectContaining({
data: {
'db.operation.name': 'put',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_put',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
expect.objectContaining({
data: {
'db.operation.name': 'get',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
expect.objectContaining({
data: {
'db.operation.name': 'get',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
]);
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,18 @@ import { routeAgentRequest, Agent, callable } from 'agents';
class MyBaseAgent extends Agent {
@callable()
async greet(name: string): Promise<string> {
// User keys — instrumented, spans expected
await this.ctx.storage.put('test', 'any value');
await this.ctx.storage.get('test');

// Framework-internal keys (agents/partyserver/MCP OAuth conventions) — filtered, no spans expected
await this.ctx.storage.put('cf_e2e_internal', 'bookkeeping');
await this.ctx.storage.get('__ps_name');
await this.ctx.storage.get('/oauth/client/token');

// Allowlisted cf_ key — span expected
await this.ctx.storage.get('cf_user_key');

return `Hello, ${name}!`;
}
}
Expand All@@ -14,6 +26,7 @@ export const MyAgent = Sentry.instrumentDurableObjectWithSentry(
tunnel: `http://localhost:3031/`,
tracesSampleRate: 1,
enableRpcTracePropagation: true,
durableObjectStorageSpanAllowlist: ['cf_user_key'],
}),
MyBaseAgent,
);
Expand Down
25 changes: 25 additions & 0 deletions packages/cloudflare/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -240,6 +240,31 @@ interface BaseCloudflareOptions {
*/
durableObjectSqlSpanAllowlist?: Array<string | RegExp>;

/**
* KV keys that should stay instrumented even though they match a reserved prefix used by Durable
* Object frameworks (`agents`, `partyserver`, ...) for their internal storage entries.
*
* By default, KV reads/writes (`get`, `put`, `delete`, `list`) of `cf_`- or `__ps_`-prefixed keys
* are treated as framework noise and no `durable_object_storage_*` span is created for them,
* mirroring how `cf_`-prefixed SQL tables are handled (see {@link durableObjectSqlSpanAllowlist}).
* If one of your own keys happens to use such a prefix, add it here to opt it back into
* instrumentation. Strings must match exactly, while regular expressions give you prefix/pattern
* matching.
*
* @default []
* @example
* ```ts
* export default Sentry.withSentry(
* (env) => ({
* dsn: env.SENTRY_DSN,
* durableObjectStorageSpanAllowlist: ['cf_my_key', /^cf_reports_/],
* }),
* handler,
* );
* ```
*/
durableObjectStorageSpanAllowlist?: Array<string | RegExp>;

/**
* @deprecated Use `enableRpcTracePropagation` instead. This option will be removed in a future major version.
*
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
import type { DurableObjectStorage, SyncKvStorage, SqlStorage } from '@cloudflare/workers-types';
import { isThenable, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import { getClient, isThenable, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import type { CloudflareClientOptions } from '../client';
import { getStorageKeys, targetsCloudflareInternalKey } from '../utils/internalStorageKey';
import { storeSpanContext } from '../utils/traceLinks';
import { instrumentDurableObjectSyncKvStorage } from './instrumentDurableObjectSyncKvStorage';
import { instrumentSqlStorage } from './instrumentSqlStorage';
Expand DownExpand Up@@ -55,6 +57,15 @@ export function instrumentDurableObjectStorage(
}

return function (this: unknown, ...args: unknown[]) {
// KV entries managed by the DO framework itself (agents/partyserver state) are bookkeeping
// rather than user work — skip the span, mirroring how `cf_` SQL tables are treated.
const allowlist = (getClient()?.getOptions() as CloudflareClientOptions | undefined)
?.durableObjectStorageSpanAllowlist;
const keys = getStorageKeys(methodName, args);
if (keys && keys.length > 0 && keys.every(key => targetsCloudflareInternalKey(key, allowlist))) {
return (original as (...a: unknown[]) => unknown).apply(target, args);
}

return startSpan(
{
// Use underscore naming to match Cloudflare's native instrumentation (e.g., "durable_object_storage_get")
Expand Down
75 changes: 75 additions & 0 deletions packages/cloudflare/src/utils/internalStorageKey.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
import { stringMatchesSomePattern } from '@sentry/core';

/**
* Cloudflare frameworks that build on Durable Objects (`agents`, `partyserver`, ...) also manage
* their own internal KV entries alongside their internal SQLite tables, namespaced with a reserved
* prefix — e.g. `cf_agents_state`, `cf_agents_mcp_servers`, `__ps_name`. Reads/writes of these
* (message persistence, MCP connection bookkeeping, name hydration) are framework implementation
* details that otherwise flood traces with dozens of zero-signal `durable_object_storage_*` spans
* per request, so we match the reserved prefixes rather than an enumerated list. This mirrors the
* `cf_` convention used for internal SQL tables (see `targetsCloudflareInternalTable`).
*
* The prefixes are a reserved convention for framework-managed entries, so user keys should not use
* them. In case a user key does collide, the `durableObjectStorageSpanAllowlist` option lets them
* opt those keys back into instrumentation.
*/
export function targetsCloudflareInternalKey(key: string | undefined, allowlist?: Array<string | RegExp>): boolean {
if (!key) {
return false;
}

// Framework-managed KV namespaces:
// - `cf_` — agents / ai-chat internal state (mirrors the internal SQL table convention)
// - `__ps_` — partyserver internals (e.g. `__ps_name`)
// - `/` — MCP OAuth client state (`/<clientName>/<serverId>/{token,client_info,state,...}`),
// read on every MCP tool call. User keys on an Agent rarely use a leading slash; if one does,
// the allowlist opts it back in.
const isFrameworkKey = key.startsWith('cf_') || key.startsWith('__ps_') || key.startsWith('/');
if (!isFrameworkKey) {
return false;
}

// A key on the allowlist is treated as a user key and stays instrumented, even though it matches
// a reserved prefix.
return !allowlist?.length || !stringMatchesSomePattern(key, allowlist, true);
}

/**
* Extracts the KV keys a Durable Object storage call targets, so the caller can decide whether the
* operation only touches framework-internal entries. Returns `undefined` when the keys can't be
* determined from the arguments (e.g. `list()` without a prefix), in which case the call is treated
* as user work and stays instrumented.
*/
export function getStorageKeys(methodName: string, args: unknown[]): string[] | undefined {
const [first] = args;

if (methodName === 'get' || methodName === 'delete') {
// get(key) / get(keys[]) / delete(key) / delete(keys[])
if (typeof first === 'string') {
return [first];
}
if (Array.isArray(first)) {
return first.filter((k): k is string => typeof k === 'string');
}
return undefined;
}

if (methodName === 'put') {
// put(key, value) or put({ key: value, ... })
if (typeof first === 'string') {
return [first];
}
if (first && typeof first === 'object' && !Array.isArray(first)) {
return Object.keys(first);
}
return undefined;
}

if (methodName === 'list') {
// list({ prefix })
const prefix = first && typeof first === 'object' ? (first as { prefix?: unknown }).prefix : undefined;
return typeof prefix === 'string' ? [prefix] : undefined;
}

return undefined;
}
74 changes: 74 additions & 0 deletions packages/cloudflare/test/instrumentDurableObjectStorage.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -324,6 +324,80 @@ describe('instrumentDurableObjectStorage', () => {
);
});

describe('framework-internal KV keys', () => {
it('does not create a span for a cf_-prefixed get', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get('cf_agents_state');

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a __ps_-prefixed get', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get('__ps_name');

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a cf_-prefixed put with object entries', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.put({ cf_agents_a: 1, cf_agents_b: 2 });

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a cf_-prefixed delete with an array of keys', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.delete(['cf_agents_a', 'cf_agents_b']);

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a list with a cf_ prefix', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.list({ prefix: 'cf_agents_' });

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('still creates a span when a batch mixes framework and user keys', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get(['cf_agents_state', 'myKey']);

expect(startSpanSpy).toHaveBeenCalled();
});

it('still creates a span for a list without a prefix', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.list();

expect(startSpanSpy).toHaveBeenCalled();
});

it('still creates a span for a user key', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get('myKey');

expect(startSpanSpy).toHaveBeenCalled();
});
});

describe('non-instrumented methods', () => {
it('does not instrument deleteAll, sync, transaction', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,16 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
);
});

// The greet() call goes over the websocket, so its storage spans land in a webSocketMessage
// transaction. Filter for the one carrying our put span — control messages produce their own
// webSocketMessage transactions without storage spans.
const storageTransactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
return (
transactionEvent.transaction === 'webSocketMessage' &&
(transactionEvent.spans ?? []).some(span => span.description === 'durable_object_storage_put')
);
});

await page.goto(baseURL!);

await expect(page.getByText('Connected')).toBeVisible();
Expand All@@ -32,24 +42,7 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
culture: { timezone: expect.any(String) },
runtime: { name: 'cloudflare' },
},
spans: expect.arrayContaining([
expect.objectContaining({
data: {
'db.operation.name': 'get',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
]),
spans: [],
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
transaction: 'GET /agents/my-agent/user-123',
Expand All@@ -72,4 +65,65 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
packages: expect.any(Array),
},
});

// greet() touches 6 storage keys: 2 user ops + 3 framework-internal keys (cf_, __ps_, /) that
// must be filtered + 1 allowlisted cf_ key. Spans carry no key attribute, so filtering can only
// be verified by count — exactly these 3 storage spans (in execution order) should survive, and
// any framework-internal span leaking through shows up as an extra entry here.
const storageTransaction = await storageTransactionPromise;

const storageSpans = (storageTransaction.spans ?? []).filter(
span => span.origin === 'auto.db.cloudflare.durable_object',
);

expect(storageSpans).toEqual([
expect.objectContaining({
data: {
'db.operation.name': 'put',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_put',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
expect.objectContaining({
data: {
'db.operation.name': 'get',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
expect.objectContaining({
data: {
'db.operation.name': 'get',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
]);
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,18 @@ import { routeAgentRequest, Agent, callable } from 'agents';
class MyBaseAgent extends Agent {
@callable()
async greet(name: string): Promise<string> {
// User keys — instrumented, spans expected
await this.ctx.storage.put('test', 'any value');
await this.ctx.storage.get('test');

// Framework-internal keys (agents/partyserver/MCP OAuth conventions) — filtered, no spans expected
await this.ctx.storage.put('cf_e2e_internal', 'bookkeeping');
await this.ctx.storage.get('__ps_name');
await this.ctx.storage.get('/oauth/client/token');

// Allowlisted cf_ key — span expected
await this.ctx.storage.get('cf_user_key');

return `Hello, ${name}!`;
}
}
Expand All@@ -14,6 +26,7 @@ export const MyAgent = Sentry.instrumentDurableObjectWithSentry(
tunnel: `http://localhost:3031/`,
tracesSampleRate: 1,
enableRpcTracePropagation: true,
durableObjectStorageSpanAllowlist: ['cf_user_key'],
}),
MyBaseAgent,
);
Expand Down
25 changes: 25 additions & 0 deletions packages/cloudflare/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -240,6 +240,31 @@ interface BaseCloudflareOptions {
*/
durableObjectSqlSpanAllowlist?: Array<string | RegExp>;

/**
* KV keys that should stay instrumented even though they match a reserved prefix used by Durable
* Object frameworks (`agents`, `partyserver`, ...) for their internal storage entries.
*
* By default, KV reads/writes (`get`, `put`, `delete`, `list`) of `cf_`- or `__ps_`-prefixed keys
* are treated as framework noise and no `durable_object_storage_*` span is created for them,
* mirroring how `cf_`-prefixed SQL tables are handled (see {@link durableObjectSqlSpanAllowlist}).
* If one of your own keys happens to use such a prefix, add it here to opt it back into
* instrumentation. Strings must match exactly, while regular expressions give you prefix/pattern
* matching.
*
* @default []
* @example
* ```ts
* export default Sentry.withSentry(
* (env) => ({
* dsn: env.SENTRY_DSN,
* durableObjectStorageSpanAllowlist: ['cf_my_key', /^cf_reports_/],
* }),
* handler,
* );
* ```
*/
durableObjectStorageSpanAllowlist?: Array<string | RegExp>;

/**
* @deprecated Use `enableRpcTracePropagation` instead. This option will be removed in a future major version.
*
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
import type { DurableObjectStorage, SyncKvStorage, SqlStorage } from '@cloudflare/workers-types';
import { isThenable, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import { getClient, isThenable, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import type { CloudflareClientOptions } from '../client';
import { getStorageKeys, targetsCloudflareInternalKey } from '../utils/internalStorageKey';
import { storeSpanContext } from '../utils/traceLinks';
import { instrumentDurableObjectSyncKvStorage } from './instrumentDurableObjectSyncKvStorage';
import { instrumentSqlStorage } from './instrumentSqlStorage';
Expand DownExpand Up@@ -55,6 +57,15 @@ export function instrumentDurableObjectStorage(
}

return function (this: unknown, ...args: unknown[]) {
// KV entries managed by the DO framework itself (agents/partyserver state) are bookkeeping
// rather than user work — skip the span, mirroring how `cf_` SQL tables are treated.
const allowlist = (getClient()?.getOptions() as CloudflareClientOptions | undefined)
?.durableObjectStorageSpanAllowlist;
const keys = getStorageKeys(methodName, args);
if (keys && keys.length > 0 && keys.every(key => targetsCloudflareInternalKey(key, allowlist))) {
return (original as (...a: unknown[]) => unknown).apply(target, args);
}

return startSpan(
{
// Use underscore naming to match Cloudflare's native instrumentation (e.g., "durable_object_storage_get")
Expand Down
75 changes: 75 additions & 0 deletions packages/cloudflare/src/utils/internalStorageKey.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
import { stringMatchesSomePattern } from '@sentry/core';

/**
* Cloudflare frameworks that build on Durable Objects (`agents`, `partyserver`, ...) also manage
* their own internal KV entries alongside their internal SQLite tables, namespaced with a reserved
* prefix — e.g. `cf_agents_state`, `cf_agents_mcp_servers`, `__ps_name`. Reads/writes of these
* (message persistence, MCP connection bookkeeping, name hydration) are framework implementation
* details that otherwise flood traces with dozens of zero-signal `durable_object_storage_*` spans
* per request, so we match the reserved prefixes rather than an enumerated list. This mirrors the
* `cf_` convention used for internal SQL tables (see `targetsCloudflareInternalTable`).
*
* The prefixes are a reserved convention for framework-managed entries, so user keys should not use
* them. In case a user key does collide, the `durableObjectStorageSpanAllowlist` option lets them
* opt those keys back into instrumentation.
*/
export function targetsCloudflareInternalKey(key: string | undefined, allowlist?: Array<string | RegExp>): boolean {
if (!key) {
return false;
}

// Framework-managed KV namespaces:
// - `cf_` — agents / ai-chat internal state (mirrors the internal SQL table convention)
// - `__ps_` — partyserver internals (e.g. `__ps_name`)
// - `/` — MCP OAuth client state (`/<clientName>/<serverId>/{token,client_info,state,...}`),
// read on every MCP tool call. User keys on an Agent rarely use a leading slash; if one does,
// the allowlist opts it back in.
const isFrameworkKey = key.startsWith('cf_') || key.startsWith('__ps_') || key.startsWith('/');
if (!isFrameworkKey) {
return false;
}

// A key on the allowlist is treated as a user key and stays instrumented, even though it matches
// a reserved prefix.
return !allowlist?.length || !stringMatchesSomePattern(key, allowlist, true);
}

/**
* Extracts the KV keys a Durable Object storage call targets, so the caller can decide whether the
* operation only touches framework-internal entries. Returns `undefined` when the keys can't be
* determined from the arguments (e.g. `list()` without a prefix), in which case the call is treated
* as user work and stays instrumented.
*/
export function getStorageKeys(methodName: string, args: unknown[]): string[] | undefined {
const [first] = args;

if (methodName === 'get' || methodName === 'delete') {
// get(key) / get(keys[]) / delete(key) / delete(keys[])
if (typeof first === 'string') {
return [first];
}
if (Array.isArray(first)) {
return first.filter((k): k is string => typeof k === 'string');
}
return undefined;
}

if (methodName === 'put') {
// put(key, value) or put({ key: value, ... })
if (typeof first === 'string') {
return [first];
}
if (first && typeof first === 'object' && !Array.isArray(first)) {
return Object.keys(first);
}
return undefined;
}

if (methodName === 'list') {
// list({ prefix })
const prefix = first && typeof first === 'object' ? (first as { prefix?: unknown }).prefix : undefined;
return typeof prefix === 'string' ? [prefix] : undefined;
}

return undefined;
}
74 changes: 74 additions & 0 deletions packages/cloudflare/test/instrumentDurableObjectStorage.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -324,6 +324,80 @@ describe('instrumentDurableObjectStorage', () => {
);
});

describe('framework-internal KV keys', () => {
it('does not create a span for a cf_-prefixed get', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get('cf_agents_state');

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a __ps_-prefixed get', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get('__ps_name');

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a cf_-prefixed put with object entries', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.put({ cf_agents_a: 1, cf_agents_b: 2 });

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a cf_-prefixed delete with an array of keys', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.delete(['cf_agents_a', 'cf_agents_b']);

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a list with a cf_ prefix', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.list({ prefix: 'cf_agents_' });

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('still creates a span when a batch mixes framework and user keys', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get(['cf_agents_state', 'myKey']);

expect(startSpanSpy).toHaveBeenCalled();
});

it('still creates a span for a list without a prefix', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.list();

expect(startSpanSpy).toHaveBeenCalled();
});

it('still creates a span for a user key', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get('myKey');

expect(startSpanSpy).toHaveBeenCalled();
});
});

describe('non-instrumented methods', () => {
it('does not instrument deleteAll, sync, transaction', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,16 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
);
});

// The greet() call goes over the websocket, so its storage spans land in a webSocketMessage
// transaction. Filter for the one carrying our put span — control messages produce their own
// webSocketMessage transactions without storage spans.
const storageTransactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
return (
transactionEvent.transaction === 'webSocketMessage' &&
(transactionEvent.spans ?? []).some(span => span.description === 'durable_object_storage_put')
);
});

await page.goto(baseURL!);

await expect(page.getByText('Connected')).toBeVisible();
Expand All@@ -32,24 +42,7 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
culture: { timezone: expect.any(String) },
runtime: { name: 'cloudflare' },
},
spans: expect.arrayContaining([
expect.objectContaining({
data: {
'db.operation.name': 'get',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
]),
spans: [],
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
transaction: 'GET /agents/my-agent/user-123',
Expand All@@ -72,4 +65,65 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
packages: expect.any(Array),
},
});

// greet() touches 6 storage keys: 2 user ops + 3 framework-internal keys (cf_, __ps_, /) that
// must be filtered + 1 allowlisted cf_ key. Spans carry no key attribute, so filtering can only
// be verified by count — exactly these 3 storage spans (in execution order) should survive, and
// any framework-internal span leaking through shows up as an extra entry here.
const storageTransaction = await storageTransactionPromise;

const storageSpans = (storageTransaction.spans ?? []).filter(
span => span.origin === 'auto.db.cloudflare.durable_object',
);

expect(storageSpans).toEqual([
expect.objectContaining({
data: {
'db.operation.name': 'put',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_put',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
expect.objectContaining({
data: {
'db.operation.name': 'get',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
expect.objectContaining({
data: {
'db.operation.name': 'get',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
]);
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,18 @@ import { routeAgentRequest, Agent, callable } from 'agents';
class MyBaseAgent extends Agent {
@callable()
async greet(name: string): Promise<string> {
// User keys — instrumented, spans expected
await this.ctx.storage.put('test', 'any value');
await this.ctx.storage.get('test');

// Framework-internal keys (agents/partyserver/MCP OAuth conventions) — filtered, no spans expected
await this.ctx.storage.put('cf_e2e_internal', 'bookkeeping');
await this.ctx.storage.get('__ps_name');
await this.ctx.storage.get('/oauth/client/token');

// Allowlisted cf_ key — span expected
await this.ctx.storage.get('cf_user_key');

return `Hello, ${name}!`;
}
}
Expand All@@ -14,6 +26,7 @@ export const MyAgent = Sentry.instrumentDurableObjectWithSentry(
tunnel: `http://localhost:3031/`,
tracesSampleRate: 1,
enableRpcTracePropagation: true,
durableObjectStorageSpanAllowlist: ['cf_user_key'],
}),
MyBaseAgent,
);
Expand Down
25 changes: 25 additions & 0 deletions packages/cloudflare/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -240,6 +240,31 @@ interface BaseCloudflareOptions {
*/
durableObjectSqlSpanAllowlist?: Array<string | RegExp>;

/**
* KV keys that should stay instrumented even though they match a reserved prefix used by Durable
* Object frameworks (`agents`, `partyserver`, ...) for their internal storage entries.
*
* By default, KV reads/writes (`get`, `put`, `delete`, `list`) of `cf_`- or `__ps_`-prefixed keys
* are treated as framework noise and no `durable_object_storage_*` span is created for them,
* mirroring how `cf_`-prefixed SQL tables are handled (see {@link durableObjectSqlSpanAllowlist}).
* If one of your own keys happens to use such a prefix, add it here to opt it back into
* instrumentation. Strings must match exactly, while regular expressions give you prefix/pattern
* matching.
*
* @default []
* @example
* ```ts
* export default Sentry.withSentry(
* (env) => ({
* dsn: env.SENTRY_DSN,
* durableObjectStorageSpanAllowlist: ['cf_my_key', /^cf_reports_/],
* }),
* handler,
* );
* ```
*/
durableObjectStorageSpanAllowlist?: Array<string | RegExp>;

/**
* @deprecated Use `enableRpcTracePropagation` instead. This option will be removed in a future major version.
*
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
import type { DurableObjectStorage, SyncKvStorage, SqlStorage } from '@cloudflare/workers-types';
import { isThenable, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import { getClient, isThenable, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import type { CloudflareClientOptions } from '../client';
import { getStorageKeys, targetsCloudflareInternalKey } from '../utils/internalStorageKey';
import { storeSpanContext } from '../utils/traceLinks';
import { instrumentDurableObjectSyncKvStorage } from './instrumentDurableObjectSyncKvStorage';
import { instrumentSqlStorage } from './instrumentSqlStorage';
Expand DownExpand Up@@ -55,6 +57,15 @@ export function instrumentDurableObjectStorage(
}

return function (this: unknown, ...args: unknown[]) {
// KV entries managed by the DO framework itself (agents/partyserver state) are bookkeeping
// rather than user work — skip the span, mirroring how `cf_` SQL tables are treated.
const allowlist = (getClient()?.getOptions() as CloudflareClientOptions | undefined)
?.durableObjectStorageSpanAllowlist;
const keys = getStorageKeys(methodName, args);
if (keys && keys.length > 0 && keys.every(key => targetsCloudflareInternalKey(key, allowlist))) {
return (original as (...a: unknown[]) => unknown).apply(target, args);
}

return startSpan(
{
// Use underscore naming to match Cloudflare's native instrumentation (e.g., "durable_object_storage_get")
Expand Down
75 changes: 75 additions & 0 deletions packages/cloudflare/src/utils/internalStorageKey.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
import { stringMatchesSomePattern } from '@sentry/core';

/**
* Cloudflare frameworks that build on Durable Objects (`agents`, `partyserver`, ...) also manage
* their own internal KV entries alongside their internal SQLite tables, namespaced with a reserved
* prefix — e.g. `cf_agents_state`, `cf_agents_mcp_servers`, `__ps_name`. Reads/writes of these
* (message persistence, MCP connection bookkeeping, name hydration) are framework implementation
* details that otherwise flood traces with dozens of zero-signal `durable_object_storage_*` spans
* per request, so we match the reserved prefixes rather than an enumerated list. This mirrors the
* `cf_` convention used for internal SQL tables (see `targetsCloudflareInternalTable`).
*
* The prefixes are a reserved convention for framework-managed entries, so user keys should not use
* them. In case a user key does collide, the `durableObjectStorageSpanAllowlist` option lets them
* opt those keys back into instrumentation.
*/
export function targetsCloudflareInternalKey(key: string | undefined, allowlist?: Array<string | RegExp>): boolean {
if (!key) {
return false;
}

// Framework-managed KV namespaces:
// - `cf_` — agents / ai-chat internal state (mirrors the internal SQL table convention)
// - `__ps_` — partyserver internals (e.g. `__ps_name`)
// - `/` — MCP OAuth client state (`/<clientName>/<serverId>/{token,client_info,state,...}`),
// read on every MCP tool call. User keys on an Agent rarely use a leading slash; if one does,
// the allowlist opts it back in.
const isFrameworkKey = key.startsWith('cf_') || key.startsWith('__ps_') || key.startsWith('/');
if (!isFrameworkKey) {
return false;
}

// A key on the allowlist is treated as a user key and stays instrumented, even though it matches
// a reserved prefix.
return !allowlist?.length || !stringMatchesSomePattern(key, allowlist, true);
}

/**
* Extracts the KV keys a Durable Object storage call targets, so the caller can decide whether the
* operation only touches framework-internal entries. Returns `undefined` when the keys can't be
* determined from the arguments (e.g. `list()` without a prefix), in which case the call is treated
* as user work and stays instrumented.
*/
export function getStorageKeys(methodName: string, args: unknown[]): string[] | undefined {
const [first] = args;

if (methodName === 'get' || methodName === 'delete') {
// get(key) / get(keys[]) / delete(key) / delete(keys[])
if (typeof first === 'string') {
return [first];
}
if (Array.isArray(first)) {
return first.filter((k): k is string => typeof k === 'string');
}
return undefined;
}

if (methodName === 'put') {
// put(key, value) or put({ key: value, ... })
if (typeof first === 'string') {
return [first];
}
if (first && typeof first === 'object' && !Array.isArray(first)) {
return Object.keys(first);
}
return undefined;
}

if (methodName === 'list') {
// list({ prefix })
const prefix = first && typeof first === 'object' ? (first as { prefix?: unknown }).prefix : undefined;
return typeof prefix === 'string' ? [prefix] : undefined;
}

return undefined;
}
74 changes: 74 additions & 0 deletions packages/cloudflare/test/instrumentDurableObjectStorage.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -324,6 +324,80 @@ describe('instrumentDurableObjectStorage', () => {
);
});

describe('framework-internal KV keys', () => {
it('does not create a span for a cf_-prefixed get', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get('cf_agents_state');

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a __ps_-prefixed get', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get('__ps_name');

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a cf_-prefixed put with object entries', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.put({ cf_agents_a: 1, cf_agents_b: 2 });

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a cf_-prefixed delete with an array of keys', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.delete(['cf_agents_a', 'cf_agents_b']);

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a list with a cf_ prefix', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.list({ prefix: 'cf_agents_' });

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('still creates a span when a batch mixes framework and user keys', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get(['cf_agents_state', 'myKey']);

expect(startSpanSpy).toHaveBeenCalled();
});

it('still creates a span for a list without a prefix', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.list();

expect(startSpanSpy).toHaveBeenCalled();
});

it('still creates a span for a user key', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get('myKey');

expect(startSpanSpy).toHaveBeenCalled();
});
});

describe('non-instrumented methods', () => {
it('does not instrument deleteAll, sync, transaction', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,16 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
);
});

// The greet() call goes over the websocket, so its storage spans land in a webSocketMessage
// transaction. Filter for the one carrying our put span — control messages produce their own
// webSocketMessage transactions without storage spans.
const storageTransactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
return (
transactionEvent.transaction === 'webSocketMessage' &&
(transactionEvent.spans ?? []).some(span => span.description === 'durable_object_storage_put')
);
});

await page.goto(baseURL!);

await expect(page.getByText('Connected')).toBeVisible();
Expand All@@ -32,24 +42,7 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
culture: { timezone: expect.any(String) },
runtime: { name: 'cloudflare' },
},
spans: expect.arrayContaining([
expect.objectContaining({
data: {
'db.operation.name': 'get',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
]),
spans: [],
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
transaction: 'GET /agents/my-agent/user-123',
Expand All@@ -72,4 +65,65 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
packages: expect.any(Array),
},
});

// greet() touches 6 storage keys: 2 user ops + 3 framework-internal keys (cf_, __ps_, /) that
// must be filtered + 1 allowlisted cf_ key. Spans carry no key attribute, so filtering can only
// be verified by count — exactly these 3 storage spans (in execution order) should survive, and
// any framework-internal span leaking through shows up as an extra entry here.
const storageTransaction = await storageTransactionPromise;

const storageSpans = (storageTransaction.spans ?? []).filter(
span => span.origin === 'auto.db.cloudflare.durable_object',
);

expect(storageSpans).toEqual([
expect.objectContaining({
data: {
'db.operation.name': 'put',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_put',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
expect.objectContaining({
data: {
'db.operation.name': 'get',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
expect.objectContaining({
data: {
'db.operation.name': 'get',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
]);
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,18 @@ import { routeAgentRequest, Agent, callable } from 'agents';
class MyBaseAgent extends Agent {
@callable()
async greet(name: string): Promise<string> {
// User keys — instrumented, spans expected
await this.ctx.storage.put('test', 'any value');
await this.ctx.storage.get('test');

// Framework-internal keys (agents/partyserver/MCP OAuth conventions) — filtered, no spans expected
await this.ctx.storage.put('cf_e2e_internal', 'bookkeeping');
await this.ctx.storage.get('__ps_name');
await this.ctx.storage.get('/oauth/client/token');

// Allowlisted cf_ key — span expected
await this.ctx.storage.get('cf_user_key');

return `Hello, ${name}!`;
}
}
Expand All@@ -14,6 +26,7 @@ export const MyAgent = Sentry.instrumentDurableObjectWithSentry(
tunnel: `http://localhost:3031/`,
tracesSampleRate: 1,
enableRpcTracePropagation: true,
durableObjectStorageSpanAllowlist: ['cf_user_key'],
}),
MyBaseAgent,
);
Expand Down
25 changes: 25 additions & 0 deletions packages/cloudflare/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -240,6 +240,31 @@ interface BaseCloudflareOptions {
*/
durableObjectSqlSpanAllowlist?: Array<string | RegExp>;

/**
* KV keys that should stay instrumented even though they match a reserved prefix used by Durable
* Object frameworks (`agents`, `partyserver`, ...) for their internal storage entries.
*
* By default, KV reads/writes (`get`, `put`, `delete`, `list`) of `cf_`- or `__ps_`-prefixed keys
* are treated as framework noise and no `durable_object_storage_*` span is created for them,
* mirroring how `cf_`-prefixed SQL tables are handled (see {@link durableObjectSqlSpanAllowlist}).
* If one of your own keys happens to use such a prefix, add it here to opt it back into
* instrumentation. Strings must match exactly, while regular expressions give you prefix/pattern
* matching.
*
* @default []
* @example
* ```ts
* export default Sentry.withSentry(
* (env) => ({
* dsn: env.SENTRY_DSN,
* durableObjectStorageSpanAllowlist: ['cf_my_key', /^cf_reports_/],
* }),
* handler,
* );
* ```
*/
durableObjectStorageSpanAllowlist?: Array<string | RegExp>;

/**
* @deprecated Use `enableRpcTracePropagation` instead. This option will be removed in a future major version.
*
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
import type { DurableObjectStorage, SyncKvStorage, SqlStorage } from '@cloudflare/workers-types';
import { isThenable, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import { getClient, isThenable, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import type { CloudflareClientOptions } from '../client';
import { getStorageKeys, targetsCloudflareInternalKey } from '../utils/internalStorageKey';
import { storeSpanContext } from '../utils/traceLinks';
import { instrumentDurableObjectSyncKvStorage } from './instrumentDurableObjectSyncKvStorage';
import { instrumentSqlStorage } from './instrumentSqlStorage';
Expand DownExpand Up@@ -55,6 +57,15 @@ export function instrumentDurableObjectStorage(
}

return function (this: unknown, ...args: unknown[]) {
// KV entries managed by the DO framework itself (agents/partyserver state) are bookkeeping
// rather than user work — skip the span, mirroring how `cf_` SQL tables are treated.
const allowlist = (getClient()?.getOptions() as CloudflareClientOptions | undefined)
?.durableObjectStorageSpanAllowlist;
const keys = getStorageKeys(methodName, args);
if (keys && keys.length > 0 && keys.every(key => targetsCloudflareInternalKey(key, allowlist))) {
return (original as (...a: unknown[]) => unknown).apply(target, args);
}

return startSpan(
{
// Use underscore naming to match Cloudflare's native instrumentation (e.g., "durable_object_storage_get")
Expand Down
75 changes: 75 additions & 0 deletions packages/cloudflare/src/utils/internalStorageKey.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
import { stringMatchesSomePattern } from '@sentry/core';

/**
* Cloudflare frameworks that build on Durable Objects (`agents`, `partyserver`, ...) also manage
* their own internal KV entries alongside their internal SQLite tables, namespaced with a reserved
* prefix — e.g. `cf_agents_state`, `cf_agents_mcp_servers`, `__ps_name`. Reads/writes of these
* (message persistence, MCP connection bookkeeping, name hydration) are framework implementation
* details that otherwise flood traces with dozens of zero-signal `durable_object_storage_*` spans
* per request, so we match the reserved prefixes rather than an enumerated list. This mirrors the
* `cf_` convention used for internal SQL tables (see `targetsCloudflareInternalTable`).
*
* The prefixes are a reserved convention for framework-managed entries, so user keys should not use
* them. In case a user key does collide, the `durableObjectStorageSpanAllowlist` option lets them
* opt those keys back into instrumentation.
*/
export function targetsCloudflareInternalKey(key: string | undefined, allowlist?: Array<string | RegExp>): boolean {
if (!key) {
return false;
}

// Framework-managed KV namespaces:
// - `cf_` — agents / ai-chat internal state (mirrors the internal SQL table convention)
// - `__ps_` — partyserver internals (e.g. `__ps_name`)
// - `/` — MCP OAuth client state (`/<clientName>/<serverId>/{token,client_info,state,...}`),
// read on every MCP tool call. User keys on an Agent rarely use a leading slash; if one does,
// the allowlist opts it back in.
const isFrameworkKey = key.startsWith('cf_') || key.startsWith('__ps_') || key.startsWith('/');
if (!isFrameworkKey) {
return false;
}

// A key on the allowlist is treated as a user key and stays instrumented, even though it matches
// a reserved prefix.
return !allowlist?.length || !stringMatchesSomePattern(key, allowlist, true);
}

/**
* Extracts the KV keys a Durable Object storage call targets, so the caller can decide whether the
* operation only touches framework-internal entries. Returns `undefined` when the keys can't be
* determined from the arguments (e.g. `list()` without a prefix), in which case the call is treated
* as user work and stays instrumented.
*/
export function getStorageKeys(methodName: string, args: unknown[]): string[] | undefined {
const [first] = args;

if (methodName === 'get' || methodName === 'delete') {
// get(key) / get(keys[]) / delete(key) / delete(keys[])
if (typeof first === 'string') {
return [first];
}
if (Array.isArray(first)) {
return first.filter((k): k is string => typeof k === 'string');
}
return undefined;
}

if (methodName === 'put') {
// put(key, value) or put({ key: value, ... })
if (typeof first === 'string') {
return [first];
}
if (first && typeof first === 'object' && !Array.isArray(first)) {
return Object.keys(first);
}
return undefined;
}

if (methodName === 'list') {
// list({ prefix })
const prefix = first && typeof first === 'object' ? (first as { prefix?: unknown }).prefix : undefined;
return typeof prefix === 'string' ? [prefix] : undefined;
}

return undefined;
}
74 changes: 74 additions & 0 deletions packages/cloudflare/test/instrumentDurableObjectStorage.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -324,6 +324,80 @@ describe('instrumentDurableObjectStorage', () => {
);
});

describe('framework-internal KV keys', () => {
it('does not create a span for a cf_-prefixed get', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get('cf_agents_state');

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a __ps_-prefixed get', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get('__ps_name');

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a cf_-prefixed put with object entries', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.put({ cf_agents_a: 1, cf_agents_b: 2 });

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a cf_-prefixed delete with an array of keys', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.delete(['cf_agents_a', 'cf_agents_b']);

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a list with a cf_ prefix', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.list({ prefix: 'cf_agents_' });

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('still creates a span when a batch mixes framework and user keys', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get(['cf_agents_state', 'myKey']);

expect(startSpanSpy).toHaveBeenCalled();
});

it('still creates a span for a list without a prefix', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.list();

expect(startSpanSpy).toHaveBeenCalled();
});

it('still creates a span for a user key', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get('myKey');

expect(startSpanSpy).toHaveBeenCalled();
});
});

describe('non-instrumented methods', () => {
it('does not instrument deleteAll, sync, transaction', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,16 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
);
});

// The greet() call goes over the websocket, so its storage spans land in a webSocketMessage
// transaction. Filter for the one carrying our put span — control messages produce their own
// webSocketMessage transactions without storage spans.
const storageTransactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
return (
transactionEvent.transaction === 'webSocketMessage' &&
(transactionEvent.spans ?? []).some(span => span.description === 'durable_object_storage_put')
);
});

await page.goto(baseURL!);

await expect(page.getByText('Connected')).toBeVisible();
Expand All@@ -32,24 +42,7 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
culture: { timezone: expect.any(String) },
runtime: { name: 'cloudflare' },
},
spans: expect.arrayContaining([
expect.objectContaining({
data: {
'db.operation.name': 'get',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
]),
spans: [],
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
transaction: 'GET /agents/my-agent/user-123',
Expand All@@ -72,4 +65,65 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
packages: expect.any(Array),
},
});

// greet() touches 6 storage keys: 2 user ops + 3 framework-internal keys (cf_, __ps_, /) that
// must be filtered + 1 allowlisted cf_ key. Spans carry no key attribute, so filtering can only
// be verified by count — exactly these 3 storage spans (in execution order) should survive, and
// any framework-internal span leaking through shows up as an extra entry here.
const storageTransaction = await storageTransactionPromise;

const storageSpans = (storageTransaction.spans ?? []).filter(
span => span.origin === 'auto.db.cloudflare.durable_object',
);

expect(storageSpans).toEqual([
expect.objectContaining({
data: {
'db.operation.name': 'put',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_put',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
expect.objectContaining({
data: {
'db.operation.name': 'get',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
expect.objectContaining({
data: {
'db.operation.name': 'get',
'db.system.name': 'cloudflare.durable_object.storage',
'sentry.op': 'db',
'sentry.origin': 'auto.db.cloudflare.durable_object',
},
description: 'durable_object_storage_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
timestamp: expect.any(Number),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
}),
]);
});
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,18 @@ import { routeAgentRequest, Agent, callable } from 'agents';
class MyBaseAgent extends Agent {
@callable()
async greet(name: string): Promise<string> {
// User keys — instrumented, spans expected
await this.ctx.storage.put('test', 'any value');
await this.ctx.storage.get('test');

// Framework-internal keys (agents/partyserver/MCP OAuth conventions) — filtered, no spans expected
await this.ctx.storage.put('cf_e2e_internal', 'bookkeeping');
await this.ctx.storage.get('__ps_name');
await this.ctx.storage.get('/oauth/client/token');

// Allowlisted cf_ key — span expected
await this.ctx.storage.get('cf_user_key');

return `Hello, ${name}!`;
}
}
Expand All@@ -14,6 +26,7 @@ export const MyAgent = Sentry.instrumentDurableObjectWithSentry(
tunnel: `http://localhost:3031/`,
tracesSampleRate: 1,
enableRpcTracePropagation: true,
durableObjectStorageSpanAllowlist: ['cf_user_key'],
}),
MyBaseAgent,
);
Expand Down
25 changes: 25 additions & 0 deletions packages/cloudflare/src/client.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -240,6 +240,31 @@ interface BaseCloudflareOptions {
*/
durableObjectSqlSpanAllowlist?: Array<string | RegExp>;

/**
* KV keys that should stay instrumented even though they match a reserved prefix used by Durable
* Object frameworks (`agents`, `partyserver`, ...) for their internal storage entries.
*
* By default, KV reads/writes (`get`, `put`, `delete`, `list`) of `cf_`- or `__ps_`-prefixed keys
* are treated as framework noise and no `durable_object_storage_*` span is created for them,
* mirroring how `cf_`-prefixed SQL tables are handled (see {@link durableObjectSqlSpanAllowlist}).
* If one of your own keys happens to use such a prefix, add it here to opt it back into
* instrumentation. Strings must match exactly, while regular expressions give you prefix/pattern
* matching.
*
* @default []
* @example
* ```ts
* export default Sentry.withSentry(
* (env) => ({
* dsn: env.SENTRY_DSN,
* durableObjectStorageSpanAllowlist: ['cf_my_key', /^cf_reports_/],
* }),
* handler,
* );
* ```
*/
durableObjectStorageSpanAllowlist?: Array<string | RegExp>;

/**
* @deprecated Use `enableRpcTracePropagation` instead. This option will be removed in a future major version.
*
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
import type { DurableObjectStorage, SyncKvStorage, SqlStorage } from '@cloudflare/workers-types';
import { isThenable, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import { getClient, isThenable, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import type { CloudflareClientOptions } from '../client';
import { getStorageKeys, targetsCloudflareInternalKey } from '../utils/internalStorageKey';
import { storeSpanContext } from '../utils/traceLinks';
import { instrumentDurableObjectSyncKvStorage } from './instrumentDurableObjectSyncKvStorage';
import { instrumentSqlStorage } from './instrumentSqlStorage';
Expand DownExpand Up@@ -55,6 +57,15 @@ export function instrumentDurableObjectStorage(
}

return function (this: unknown, ...args: unknown[]) {
// KV entries managed by the DO framework itself (agents/partyserver state) are bookkeeping
// rather than user work — skip the span, mirroring how `cf_` SQL tables are treated.
const allowlist = (getClient()?.getOptions() as CloudflareClientOptions | undefined)
?.durableObjectStorageSpanAllowlist;
const keys = getStorageKeys(methodName, args);
if (keys && keys.length > 0 && keys.every(key => targetsCloudflareInternalKey(key, allowlist))) {
return (original as (...a: unknown[]) => unknown).apply(target, args);
}

return startSpan(
{
// Use underscore naming to match Cloudflare's native instrumentation (e.g., "durable_object_storage_get")
Expand Down
75 changes: 75 additions & 0 deletions packages/cloudflare/src/utils/internalStorageKey.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
import { stringMatchesSomePattern } from '@sentry/core';

/**
* Cloudflare frameworks that build on Durable Objects (`agents`, `partyserver`, ...) also manage
* their own internal KV entries alongside their internal SQLite tables, namespaced with a reserved
* prefix — e.g. `cf_agents_state`, `cf_agents_mcp_servers`, `__ps_name`. Reads/writes of these
* (message persistence, MCP connection bookkeeping, name hydration) are framework implementation
* details that otherwise flood traces with dozens of zero-signal `durable_object_storage_*` spans
* per request, so we match the reserved prefixes rather than an enumerated list. This mirrors the
* `cf_` convention used for internal SQL tables (see `targetsCloudflareInternalTable`).
*
* The prefixes are a reserved convention for framework-managed entries, so user keys should not use
* them. In case a user key does collide, the `durableObjectStorageSpanAllowlist` option lets them
* opt those keys back into instrumentation.
*/
export function targetsCloudflareInternalKey(key: string | undefined, allowlist?: Array<string | RegExp>): boolean {
if (!key) {
return false;
}

// Framework-managed KV namespaces:
// - `cf_` — agents / ai-chat internal state (mirrors the internal SQL table convention)
// - `__ps_` — partyserver internals (e.g. `__ps_name`)
// - `/` — MCP OAuth client state (`/<clientName>/<serverId>/{token,client_info,state,...}`),
// read on every MCP tool call. User keys on an Agent rarely use a leading slash; if one does,
// the allowlist opts it back in.
const isFrameworkKey = key.startsWith('cf_') || key.startsWith('__ps_') || key.startsWith('/');
if (!isFrameworkKey) {
return false;
}

// A key on the allowlist is treated as a user key and stays instrumented, even though it matches
// a reserved prefix.
return !allowlist?.length || !stringMatchesSomePattern(key, allowlist, true);
}

/**
* Extracts the KV keys a Durable Object storage call targets, so the caller can decide whether the
* operation only touches framework-internal entries. Returns `undefined` when the keys can't be
* determined from the arguments (e.g. `list()` without a prefix), in which case the call is treated
* as user work and stays instrumented.
*/
export function getStorageKeys(methodName: string, args: unknown[]): string[] | undefined {
const [first] = args;

if (methodName === 'get' || methodName === 'delete') {
// get(key) / get(keys[]) / delete(key) / delete(keys[])
if (typeof first === 'string') {
return [first];
}
if (Array.isArray(first)) {
return first.filter((k): k is string => typeof k === 'string');
}
return undefined;
}

if (methodName === 'put') {
// put(key, value) or put({ key: value, ... })
if (typeof first === 'string') {
return [first];
}
if (first && typeof first === 'object' && !Array.isArray(first)) {
return Object.keys(first);
}
return undefined;
}

if (methodName === 'list') {
// list({ prefix })
const prefix = first && typeof first === 'object' ? (first as { prefix?: unknown }).prefix : undefined;
return typeof prefix === 'string' ? [prefix] : undefined;
}

return undefined;
}
74 changes: 74 additions & 0 deletions packages/cloudflare/test/instrumentDurableObjectStorage.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -324,6 +324,80 @@ describe('instrumentDurableObjectStorage', () => {
);
});

describe('framework-internal KV keys', () => {
it('does not create a span for a cf_-prefixed get', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get('cf_agents_state');

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a __ps_-prefixed get', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get('__ps_name');

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a cf_-prefixed put with object entries', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.put({ cf_agents_a: 1, cf_agents_b: 2 });

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a cf_-prefixed delete with an array of keys', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.delete(['cf_agents_a', 'cf_agents_b']);

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not create a span for a list with a cf_ prefix', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.list({ prefix: 'cf_agents_' });

expect(startSpanSpy).not.toHaveBeenCalled();
});

it('still creates a span when a batch mixes framework and user keys', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get(['cf_agents_state', 'myKey']);

expect(startSpanSpy).toHaveBeenCalled();
});

it('still creates a span for a list without a prefix', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.list();

expect(startSpanSpy).toHaveBeenCalled();
});

it('still creates a span for a user key', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const instrumented = instrumentDurableObjectStorage(createMockStorage());

await instrumented.get('myKey');

expect(startSpanSpy).toHaveBeenCalled();
});
});

describe('non-instrumented methods', () => {
it('does not instrument deleteAll, sync, transaction', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
Expand Down
Loading
Loading