feat(v10/cloudflare): Add instrumentAgentWithSentry for Cloudflare Agents#22786

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
JPeer264 merged 1 commit into from
Jul 29, 2026
Merged

feat(v10/cloudflare): Add instrumentAgentWithSentry for Cloudflare Agents #22786

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 20 additions & 14 deletions dev-packages/e2e-tests/test-applications/cloudflare-agent/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,26 +14,32 @@
"test:dev": "TEST_ENV=development playwright test"
},
"dependencies": {
"@cloudflare/ai-chat": "^0.7.1",
"@sentry/cloudflare": "^10.53.1",
"agents": "^0.13.1",
"react": "^19.2.6",
"react-dom": "^19.2.6"
"@cloudflare/ai-chat": "^0.10.0",
"@sentry/cloudflare": "^10.68.0",
"@sentry/core": "^10.68.0",
"agents": "^0.20.0",
"ai": "^6.0.235",
"react": "^19.2.8",
"react-dom": "^19.2.8",
"workers-ai-provider": "^3.3.1"
},
"devDependencies": {
"@playwright/test": "~1.56.0",
"@cloudflare/vite-plugin": "^1.37.2",
"@cloudflare/workers-types": "^4.20260520.1",
"@cloudflare/vite-plugin": "^1.47.0",
"@cloudflare/workers-types": "^5.20260727.1",
"@sentry-internal/test-utils": "link:../../../test-utils",
"@types/node": "^24.12.4",
"@types/react": "^19.2.15",
"@types/node": "^26.1.2",
"@types/react": "^19.2.17",
"@types/react-dom": "^19.2.3",
"@vitejs/plugin-react": "^6.0.2",
"globals": "^17.6.0",
"@types/ws": "^8.18.1",
"@babel/core": "^8.0.1",
"@babel/plugin-proposal-decorators": "^8.0.2",
"@vitejs/plugin-react": "^6.0.4",
"globals": "^17.8.0",
"typescript": "~6.0.3",
"vite": "^8.0.14",
"wrangler": "^4.93.0",
"ws": "^8.20.1"
"vite": "^8.1.5",
"wrangler": "^4.114.0",
"ws": "^8.21.1"
},
"volta": {
"node": "24.15.0",
Expand Down
90 changes: 90 additions & 0 deletions dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/agent-socket.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
import WebSocket from 'ws';

type AgentReply = { type?: string; id?: string; done?: boolean };

/** Sends a single frame over a WS to the given agent instance and resolves once `isDone` matches a reply. */
function driveAgentSocket(
baseURL: string,
binding: string,
instance: string,
frame: unknown,
isDone: (reply: AgentReply) => boolean,
timeoutLabel: string,
): Promise<void> {
const wsUrl = `${baseURL.replace(/^http/, 'ws')}/agents/${binding}/${instance}`;

return new Promise<void>((resolveSocket, rejectSocket) => {
const socket = new WebSocket(wsUrl);
const timeout = setTimeout(() => {
socket.close();
rejectSocket(new Error(`Timed out waiting for ${timeoutLabel}`));
}, 15_000);

socket.on('open', () => {
socket.send(JSON.stringify(frame));
});

socket.on('message', data => {
try {
const parsed = JSON.parse(data.toString()) as AgentReply;
if (isDone(parsed)) {
clearTimeout(timeout);
socket.close();
resolveSocket();
}
} catch {
// Ignore non-JSON / unrelated frames.
}
});

socket.on('error', err => {
clearTimeout(timeout);
rejectSocket(err);
});
});
}

/** Opens a chat WebSocket to `/agents/<binding>/<instance>`, sends one `cf_agent_use_chat_request` frame. */
export function sendChatMessage(
baseURL: string,
options: { binding: string; instance: string; prompt: string },
): Promise<void> {
const id = `chat-${options.instance}`;
const frame = {
type: 'cf_agent_use_chat_request',
id,
init: {
method: 'POST',
body: JSON.stringify({
messages: [{ id: 'msg-1', role: 'user', parts: [{ type: 'text', text: options.prompt }] }],
}),
},
};

return driveAgentSocket(
baseURL,
options.binding,
options.instance,
frame,
reply => reply.type === 'cf_agent_use_chat_response' && reply.id === id && !!reply.done,
'chat response',
);
}

/** Opens a WebSocket to `/agents/<binding>/<instance>`, sends one RPC frame, resolves on the reply. */
export function callRpc(
baseURL: string,
options: { binding: string; instance: string; method: string; args: unknown[] },
): Promise<void> {
const id = `rpc-${options.method}`;
const frame = { type: 'rpc', id, method: options.method, args: options.args };

return driveAgentSocket(
baseURL,
options.binding,
options.instance,
frame,
reply => reply.type === 'rpc' && reply.id === id && !!reply.done,
`RPC reply to "${options.method}"`,
);
}
60 changes: 60 additions & 0 deletions dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/ai-streaming.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

// Drives Workers AI through the real Cloudflare Agents SDK + Vercel AI SDK + `workers-ai-provider`
// stack (the OpenAI-compatible SSE shape, `choices[].delta.content`) from an Agent's `onRequest`.
// Asserts the streaming response text is captured on the gen_ai span — the regression seen in
// production where only input + usage survived. The model output is read from
// `gen_ai.output.messages`, so the streaming instrumentation must emit it alongside the
// deprecated `gen_ai.response.text`.
function assertGenAiStreamingSpan(spans: Array<Record<string, any>> | undefined): void {
const genAiSpan = (spans ?? []).find(span => span.op === 'gen_ai.chat');

expect(genAiSpan).toBeDefined();
expect(genAiSpan.origin).toBe('auto.ai.cloudflare.workers_ai');
expect(genAiSpan.data).toEqual(
expect.objectContaining({
'sentry.origin': 'auto.ai.cloudflare.workers_ai',
'gen_ai.operation.name': 'chat',
'gen_ai.request.model': '@cf/meta/llama-3.1-8b-instruct',
'gen_ai.response.streaming': true,
'gen_ai.response.text': 'The capital of France is Paris.',
'gen_ai.output.messages': JSON.stringify([
{ role: 'assistant', parts: [{ type: 'text', content: 'The capital of France is Paris.' }] },
]),
'gen_ai.usage.input_tokens': 15,
'gen_ai.usage.output_tokens': 8,
'gen_ai.usage.total_tokens': 23,
}),
);
}

test('captures Workers AI streaming output when driven via an Agent', async ({ request, baseURL }) => {
const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
return (
transactionEvent.transaction === 'GET /agents/my-agent/test' &&
(transactionEvent.spans ?? []).some(span => span.op === 'gen_ai.chat')
);
});

const response = await request.get(`${baseURL}/agents/my-agent/test`);
expect(response.ok()).toBe(true);

const transaction = await transactionPromise;
assertGenAiStreamingSpan(transaction.spans);
});

test('captures Workers AI streaming output when driven via an AIChatAgent', async ({ request, baseURL }) => {
const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
return (
transactionEvent.transaction === 'GET /agents/my-chat-agent/test' &&
(transactionEvent.spans ?? []).some(span => span.op === 'gen_ai.chat')
);
});

const response = await request.get(`${baseURL}/agents/my-chat-agent/test`);
expect(response.ok()).toBe(true);

const transaction = await transactionPromise;
assertGenAiStreamingSpan(transaction.spans);
});
62 changes: 61 additions & 1 deletion dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/callable.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('@callable() methods work correctly with Sentry instrumentDurableObjectWithSentry', async ({ page, baseURL }) => {
test('@callable() methods work correctly with Sentry instrumentAgentWithSentry', async ({ page, baseURL }) => {
const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
return (
transactionEvent.transaction === 'GET /agents/my-agent/user-123' &&
Expand DownExpand Up@@ -127,3 +127,63 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
}),
]);
});

test('does not emit db.query spans for the agents runtime `cf_`-prefixed internal tables', async ({
page,
baseURL,
}) => {
const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
return (
transactionEvent.transaction === 'GET /agents/my-agent/user-123' &&
transactionEvent.contexts?.trace?.parent_span_id !== undefined
);
});

await page.goto(baseURL!);

await expect(page.getByText('Connected')).toBeVisible();
await page.getByRole('button', { name: 'Call Agent' }).click();
await expect(page.getByText('Hello, World!')).toBeVisible();

const transaction = await transactionPromise;

// The agents runtime constantly queries its own `cf_agents_*` / `cf_agent_*` bookkeeping tables.
// These are framework internals and are filtered out by default, so no such span should leak.
const internalTableSpans = (transaction.spans ?? []).filter(
span => span.op === 'db.query' && /\bcf_/.test((span.data?.['db.query.summary'] as string) ?? ''),
);

expect(internalTableSpans).toEqual([]);
});

test('creates an rpc span named after the @callable() method', async ({ page, baseURL }) => {
const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
return (
transactionEvent.transaction === 'webSocketMessage' &&
(transactionEvent.spans ?? []).some(span => span.op === 'rpc' && span.description === 'greet')
);
});

await page.goto(baseURL!);

await expect(page.getByText('Connected')).toBeVisible();
await page.getByRole('button', { name: 'Call Agent' }).click();
await expect(page.getByText('Hello, World!')).toBeVisible();

const transaction = await transactionPromise;

const rpcSpans = (transaction.spans ?? []).filter(span => span.op === 'rpc');
expect(rpcSpans).toHaveLength(1);

expect(rpcSpans[0]).toEqual(
expect.objectContaining({
op: 'rpc',
description: 'greet',
origin: 'auto.faas.cloudflare.agents',
data: expect.objectContaining({
'cloudflare.agent.class': 'MyBaseAgent',
'cloudflare.agent.name': 'user-123',
}),
}),
);
});
32 changes: 32 additions & 0 deletions dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/chat-conversation.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { sendChatMessage } from './agent-socket';

// In the Agents model one agent instance is one conversation, so the instance name is the
// conversation id the SDK correlates the turn's gen_ai spans with.
const CONVERSATION_ID = 'chat-conv-instance';

test('stamps the conversation id on gen_ai spans created inside a chat turn', async ({ baseURL }) => {
const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
return (
transactionEvent.transaction === 'webSocketMessage' &&
(transactionEvent.spans ?? []).some(span => span.op === 'gen_ai.chat')
);
});

await sendChatMessage(baseURL!, {
binding: 'my-chat-agent',
instance: CONVERSATION_ID,
prompt: 'What is the capital of France?',
});

const transaction = await transactionPromise;

const genAiSpan = (transaction.spans ?? []).find(span => span.op === 'gen_ai.chat');
expect(genAiSpan).toBeDefined();
expect(genAiSpan?.data).toEqual(
expect.objectContaining({
'gen_ai.conversation.id': CONVERSATION_ID,
}),
);
});
30 changes: 30 additions & 0 deletions dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/chat-rpc.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { callRpc } from './agent-socket';

const AGENT_INSTANCE = 'chat-rpc-instance';

test('creates an rpc span for a @callable() invocation on an AIChatAgent', async ({ baseURL }) => {
const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
return (
transactionEvent.transaction === 'webSocketMessage' &&
(transactionEvent.spans ?? []).some(span => span.op === 'rpc' && span.description === 'greet')
);
});

await callRpc(baseURL!, { binding: 'my-chat-agent', instance: AGENT_INSTANCE, method: 'greet', args: ['World'] });

const transaction = await transactionPromise;

const rpcSpan = (transaction.spans ?? []).find(span => span.op === 'rpc' && span.description === 'greet');
expect(rpcSpan).toEqual(
expect.objectContaining({
op: 'rpc',
description: 'greet',
origin: 'auto.faas.cloudflare.agents',
data: expect.objectContaining({
'cloudflare.agent.name': AGENT_INSTANCE,
}),
}),
);
});
3 changes: 2 additions & 1 deletion dev-packages/e2e-tests/test-applications/cloudflare-agent/worker-configuration.d.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,12 @@ interface __BaseEnv_Env {
CF_VERSION_METADATA: WorkerVersionMetadata;
E2E_TEST_DSN: string;
MyAgent: DurableObjectNamespace<import('./worker/index').MyAgent>;
MyChatAgent: DurableObjectNamespace<import('./worker/index').MyChatAgent>;
}
declare namespace Cloudflare {
interface GlobalProps {
mainModule: typeof import('./worker/index');
durableNamespaces: 'MyAgent';
durableNamespaces: 'MyAgent' | 'MyChatAgent';
}
interface Env extends __BaseEnv_Env {}
}
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(v10/cloudflare): Add instrumentAgentWithSentry for Cloudflare Agents#22786

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

JPeer264
merged 1 commit into

from

Jul 29, 2026
 Merged


feat(v10/cloudflare): Add instrumentAgentWithSentry for Cloudflare Agents
#22786
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


34 changes: 20 additions & 14 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,26 +14,32 @@
 "test:dev": "TEST_ENV=development playwright test"
 },
 "dependencies": {
 "@cloudflare/ai-chat": "^0.7.1",
 "@sentry/cloudflare": "^10.53.1",
 "agents": "^0.13.1",
 "react": "^19.2.6",
 "react-dom": "^19.2.6"
 "@cloudflare/ai-chat": "^0.10.0",
 "@sentry/cloudflare": "^10.68.0",
 "@sentry/core": "^10.68.0",
 "agents": "^0.20.0",
 "ai": "^6.0.235",
 "react": "^19.2.8",
 "react-dom": "^19.2.8",
 "workers-ai-provider": "^3.3.1"
 },
 "devDependencies": {
 "@playwright/test": "~1.56.0",
 "@cloudflare/vite-plugin": "^1.37.2",
 "@cloudflare/workers-types": "^4.20260520.1",
 "@cloudflare/vite-plugin": "^1.47.0",
 "@cloudflare/workers-types": "^5.20260727.1",
 "@sentry-internal/test-utils": "link:../../../test-utils",
 "@types/node": "^24.12.4",
 "@types/react": "^19.2.15",
 "@types/node": "^26.1.2",
 "@types/react": "^19.2.17",
 "@types/react-dom": "^19.2.3",
 "@vitejs/plugin-react": "^6.0.2",
 "globals": "^17.6.0",
 "@types/ws": "^8.18.1",
 "@babel/core": "^8.0.1",
 "@babel/plugin-proposal-decorators": "^8.0.2",
 "@vitejs/plugin-react": "^6.0.4",
 "globals": "^17.8.0",
 "typescript": "~6.0.3",
 "vite": "^8.0.14",
 "wrangler": "^4.93.0",
 "ws": "^8.20.1"
 "vite": "^8.1.5",
 "wrangler": "^4.114.0",
 "ws": "^8.21.1"
 },
 "volta": {
 "node": "24.15.0",
Expand Down

90 changes: 90 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/agent-socket.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
import WebSocket from 'ws';

type AgentReply = { type?: string; id?: string; done?: boolean };

/** Sends a single frame over a WS to the given agent instance and resolves once `isDone` matches a reply. */
function driveAgentSocket(
 baseURL: string,
 binding: string,
 instance: string,
 frame: unknown,
 isDone: (reply: AgentReply) => boolean,
 timeoutLabel: string,
): Promise<void> {
 const wsUrl = `${baseURL.replace(/^http/, 'ws')}/agents/${binding}/${instance}`;

 return new Promise<void>((resolveSocket, rejectSocket) => {
 const socket = new WebSocket(wsUrl);
 const timeout = setTimeout(() => {
 socket.close();
 rejectSocket(new Error(`Timed out waiting for ${timeoutLabel}`));
 }, 15_000);

 socket.on('open', () => {
 socket.send(JSON.stringify(frame));
 });

 socket.on('message', data => {
 try {
 const parsed = JSON.parse(data.toString()) as AgentReply;
 if (isDone(parsed)) {
 clearTimeout(timeout);
 socket.close();
 resolveSocket();
 }
 } catch {
 // Ignore non-JSON / unrelated frames.
 }
 });

 socket.on('error', err => {
 clearTimeout(timeout);
 rejectSocket(err);
 });
 });
}

/** Opens a chat WebSocket to `/agents/<binding>/<instance>`, sends one `cf_agent_use_chat_request` frame. */
export function sendChatMessage(
 baseURL: string,
 options: { binding: string; instance: string; prompt: string },
): Promise<void> {
 const id = `chat-${options.instance}`;
 const frame = {
 type: 'cf_agent_use_chat_request',
 id,
 init: {
 method: 'POST',
 body: JSON.stringify({
 messages: [{ id: 'msg-1', role: 'user', parts: [{ type: 'text', text: options.prompt }] }],
 }),
 },
 };

 return driveAgentSocket(
 baseURL,
 options.binding,
 options.instance,
 frame,
 reply => reply.type === 'cf_agent_use_chat_response' && reply.id === id && !!reply.done,
 'chat response',
 );
}

/** Opens a WebSocket to `/agents/<binding>/<instance>`, sends one RPC frame, resolves on the reply. */
export function callRpc(
 baseURL: string,
 options: { binding: string; instance: string; method: string; args: unknown[] },
): Promise<void> {
 const id = `rpc-${options.method}`;
 const frame = { type: 'rpc', id, method: options.method, args: options.args };

 return driveAgentSocket(
 baseURL,
 options.binding,
 options.instance,
 frame,
 reply => reply.type === 'rpc' && reply.id === id && !!reply.done,
 `RPC reply to "${options.method}"`,
 );
}

60 changes: 60 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/ai-streaming.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

// Drives Workers AI through the real Cloudflare Agents SDK + Vercel AI SDK + `workers-ai-provider`
// stack (the OpenAI-compatible SSE shape, `choices[].delta.content`) from an Agent's `onRequest`.
// Asserts the streaming response text is captured on the gen_ai span — the regression seen in
// production where only input + usage survived. The model output is read from
// `gen_ai.output.messages`, so the streaming instrumentation must emit it alongside the
// deprecated `gen_ai.response.text`.
function assertGenAiStreamingSpan(spans: Array<Record<string, any>> | undefined): void {
 const genAiSpan = (spans ?? []).find(span => span.op === 'gen_ai.chat');

 expect(genAiSpan).toBeDefined();
 expect(genAiSpan.origin).toBe('auto.ai.cloudflare.workers_ai');
 expect(genAiSpan.data).toEqual(
 expect.objectContaining({
 'sentry.origin': 'auto.ai.cloudflare.workers_ai',
 'gen_ai.operation.name': 'chat',
 'gen_ai.request.model': '@cf/meta/llama-3.1-8b-instruct',
 'gen_ai.response.streaming': true,
 'gen_ai.response.text': 'The capital of France is Paris.',
 'gen_ai.output.messages': JSON.stringify([
 { role: 'assistant', parts: [{ type: 'text', content: 'The capital of France is Paris.' }] },
 ]),
 'gen_ai.usage.input_tokens': 15,
 'gen_ai.usage.output_tokens': 8,
 'gen_ai.usage.total_tokens': 23,
 }),
 );
}

test('captures Workers AI streaming output when driven via an Agent', async ({ request, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-agent/test' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'gen_ai.chat')
 );
 });

 const response = await request.get(`${baseURL}/agents/my-agent/test`);
 expect(response.ok()).toBe(true);

 const transaction = await transactionPromise;
 assertGenAiStreamingSpan(transaction.spans);
});

test('captures Workers AI streaming output when driven via an AIChatAgent', async ({ request, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-chat-agent/test' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'gen_ai.chat')
 );
 });

 const response = await request.get(`${baseURL}/agents/my-chat-agent/test`);
 expect(response.ok()).toBe(true);

 const transaction = await transactionPromise;
 assertGenAiStreamingSpan(transaction.spans);
});

62 changes: 61 additions & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/callable.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('@callable() methods work correctly with Sentry instrumentDurableObjectWithSentry', async ({ page, baseURL }) => {
test('@callable() methods work correctly with Sentry instrumentAgentWithSentry', async ({ page, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-agent/user-123' &&
Expand DownExpand Up@@ -127,3 +127,63 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
 }),
 ]);
});

test('does not emit db.query spans for the agents runtime `cf_`-prefixed internal tables', async ({
 page,
 baseURL,
}) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-agent/user-123' &&
 transactionEvent.contexts?.trace?.parent_span_id !== undefined
 );
 });

 await page.goto(baseURL!);

 await expect(page.getByText('Connected')).toBeVisible();
 await page.getByRole('button', { name: 'Call Agent' }).click();
 await expect(page.getByText('Hello, World!')).toBeVisible();

 const transaction = await transactionPromise;

 // The agents runtime constantly queries its own `cf_agents_*` / `cf_agent_*` bookkeeping tables.
 // These are framework internals and are filtered out by default, so no such span should leak.
 const internalTableSpans = (transaction.spans ?? []).filter(
 span => span.op === 'db.query' && /\bcf_/.test((span.data?.['db.query.summary'] as string) ?? ''),
 );

 expect(internalTableSpans).toEqual([]);
});

test('creates an rpc span named after the @callable() method', async ({ page, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'webSocketMessage' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'rpc' && span.description === 'greet')
 );
 });

 await page.goto(baseURL!);

 await expect(page.getByText('Connected')).toBeVisible();
 await page.getByRole('button', { name: 'Call Agent' }).click();
 await expect(page.getByText('Hello, World!')).toBeVisible();

 const transaction = await transactionPromise;

 const rpcSpans = (transaction.spans ?? []).filter(span => span.op === 'rpc');
 expect(rpcSpans).toHaveLength(1);

 expect(rpcSpans[0]).toEqual(
 expect.objectContaining({
 op: 'rpc',
 description: 'greet',
 origin: 'auto.faas.cloudflare.agents',
 data: expect.objectContaining({
 'cloudflare.agent.class': 'MyBaseAgent',
 'cloudflare.agent.name': 'user-123',
 }),
 }),
 );
});

32 changes: 32 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/chat-conversation.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { sendChatMessage } from './agent-socket';

// In the Agents model one agent instance is one conversation, so the instance name is the
// conversation id the SDK correlates the turn's gen_ai spans with.
const CONVERSATION_ID = 'chat-conv-instance';

test('stamps the conversation id on gen_ai spans created inside a chat turn', async ({ baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'webSocketMessage' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'gen_ai.chat')
 );
 });

 await sendChatMessage(baseURL!, {
 binding: 'my-chat-agent',
 instance: CONVERSATION_ID,
 prompt: 'What is the capital of France?',
 });

 const transaction = await transactionPromise;

 const genAiSpan = (transaction.spans ?? []).find(span => span.op === 'gen_ai.chat');
 expect(genAiSpan).toBeDefined();
 expect(genAiSpan?.data).toEqual(
 expect.objectContaining({
 'gen_ai.conversation.id': CONVERSATION_ID,
 }),
 );
});

30 changes: 30 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/chat-rpc.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { callRpc } from './agent-socket';

const AGENT_INSTANCE = 'chat-rpc-instance';

test('creates an rpc span for a @callable() invocation on an AIChatAgent', async ({ baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'webSocketMessage' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'rpc' && span.description === 'greet')
 );
 });

 await callRpc(baseURL!, { binding: 'my-chat-agent', instance: AGENT_INSTANCE, method: 'greet', args: ['World'] });

 const transaction = await transactionPromise;

 const rpcSpan = (transaction.spans ?? []).find(span => span.op === 'rpc' && span.description === 'greet');
 expect(rpcSpan).toEqual(
 expect.objectContaining({
 op: 'rpc',
 description: 'greet',
 origin: 'auto.faas.cloudflare.agents',
 data: expect.objectContaining({
 'cloudflare.agent.name': AGENT_INSTANCE,
 }),
 }),
 );
});

3 changes: 2 additions & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-agent/worker-configuration.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,12 @@ interface __BaseEnv_Env {
 CF_VERSION_METADATA: WorkerVersionMetadata;
 E2E_TEST_DSN: string;
 MyAgent: DurableObjectNamespace<import('./worker/index').MyAgent>;
 MyChatAgent: DurableObjectNamespace<import('./worker/index').MyChatAgent>;
}
declare namespace Cloudflare {
 interface GlobalProps {
 mainModule: typeof import('./worker/index');
 durableNamespaces: 'MyAgent';
 durableNamespaces: 'MyAgent' | 'MyChatAgent';
 }
 interface Env extends __BaseEnv_Env {}
}
Expand Down
Loading
Loading

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

Skip to content
feat(v10/cloudflare): Add instrumentAgentWithSentry for Cloudflare Agents#22786

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

JPeer264
merged 1 commit into

from

Jul 29, 2026
 Merged


feat(v10/cloudflare): Add instrumentAgentWithSentry for Cloudflare Agents
#22786
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


34 changes: 20 additions & 14 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,26 +14,32 @@
 "test:dev": "TEST_ENV=development playwright test"
 },
 "dependencies": {
 "@cloudflare/ai-chat": "^0.7.1",
 "@sentry/cloudflare": "^10.53.1",
 "agents": "^0.13.1",
 "react": "^19.2.6",
 "react-dom": "^19.2.6"
 "@cloudflare/ai-chat": "^0.10.0",
 "@sentry/cloudflare": "^10.68.0",
 "@sentry/core": "^10.68.0",
 "agents": "^0.20.0",
 "ai": "^6.0.235",
 "react": "^19.2.8",
 "react-dom": "^19.2.8",
 "workers-ai-provider": "^3.3.1"
 },
 "devDependencies": {
 "@playwright/test": "~1.56.0",
 "@cloudflare/vite-plugin": "^1.37.2",
 "@cloudflare/workers-types": "^4.20260520.1",
 "@cloudflare/vite-plugin": "^1.47.0",
 "@cloudflare/workers-types": "^5.20260727.1",
 "@sentry-internal/test-utils": "link:../../../test-utils",
 "@types/node": "^24.12.4",
 "@types/react": "^19.2.15",
 "@types/node": "^26.1.2",
 "@types/react": "^19.2.17",
 "@types/react-dom": "^19.2.3",
 "@vitejs/plugin-react": "^6.0.2",
 "globals": "^17.6.0",
 "@types/ws": "^8.18.1",
 "@babel/core": "^8.0.1",
 "@babel/plugin-proposal-decorators": "^8.0.2",
 "@vitejs/plugin-react": "^6.0.4",
 "globals": "^17.8.0",
 "typescript": "~6.0.3",
 "vite": "^8.0.14",
 "wrangler": "^4.93.0",
 "ws": "^8.20.1"
 "vite": "^8.1.5",
 "wrangler": "^4.114.0",
 "ws": "^8.21.1"
 },
 "volta": {
 "node": "24.15.0",
Expand Down

90 changes: 90 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/agent-socket.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
import WebSocket from 'ws';

type AgentReply = { type?: string; id?: string; done?: boolean };

/** Sends a single frame over a WS to the given agent instance and resolves once `isDone` matches a reply. */
function driveAgentSocket(
 baseURL: string,
 binding: string,
 instance: string,
 frame: unknown,
 isDone: (reply: AgentReply) => boolean,
 timeoutLabel: string,
): Promise<void> {
 const wsUrl = `${baseURL.replace(/^http/, 'ws')}/agents/${binding}/${instance}`;

 return new Promise<void>((resolveSocket, rejectSocket) => {
 const socket = new WebSocket(wsUrl);
 const timeout = setTimeout(() => {
 socket.close();
 rejectSocket(new Error(`Timed out waiting for ${timeoutLabel}`));
 }, 15_000);

 socket.on('open', () => {
 socket.send(JSON.stringify(frame));
 });

 socket.on('message', data => {
 try {
 const parsed = JSON.parse(data.toString()) as AgentReply;
 if (isDone(parsed)) {
 clearTimeout(timeout);
 socket.close();
 resolveSocket();
 }
 } catch {
 // Ignore non-JSON / unrelated frames.
 }
 });

 socket.on('error', err => {
 clearTimeout(timeout);
 rejectSocket(err);
 });
 });
}

/** Opens a chat WebSocket to `/agents/<binding>/<instance>`, sends one `cf_agent_use_chat_request` frame. */
export function sendChatMessage(
 baseURL: string,
 options: { binding: string; instance: string; prompt: string },
): Promise<void> {
 const id = `chat-${options.instance}`;
 const frame = {
 type: 'cf_agent_use_chat_request',
 id,
 init: {
 method: 'POST',
 body: JSON.stringify({
 messages: [{ id: 'msg-1', role: 'user', parts: [{ type: 'text', text: options.prompt }] }],
 }),
 },
 };

 return driveAgentSocket(
 baseURL,
 options.binding,
 options.instance,
 frame,
 reply => reply.type === 'cf_agent_use_chat_response' && reply.id === id && !!reply.done,
 'chat response',
 );
}

/** Opens a WebSocket to `/agents/<binding>/<instance>`, sends one RPC frame, resolves on the reply. */
export function callRpc(
 baseURL: string,
 options: { binding: string; instance: string; method: string; args: unknown[] },
): Promise<void> {
 const id = `rpc-${options.method}`;
 const frame = { type: 'rpc', id, method: options.method, args: options.args };

 return driveAgentSocket(
 baseURL,
 options.binding,
 options.instance,
 frame,
 reply => reply.type === 'rpc' && reply.id === id && !!reply.done,
 `RPC reply to "${options.method}"`,
 );
}

60 changes: 60 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/ai-streaming.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

// Drives Workers AI through the real Cloudflare Agents SDK + Vercel AI SDK + `workers-ai-provider`
// stack (the OpenAI-compatible SSE shape, `choices[].delta.content`) from an Agent's `onRequest`.
// Asserts the streaming response text is captured on the gen_ai span — the regression seen in
// production where only input + usage survived. The model output is read from
// `gen_ai.output.messages`, so the streaming instrumentation must emit it alongside the
// deprecated `gen_ai.response.text`.
function assertGenAiStreamingSpan(spans: Array<Record<string, any>> | undefined): void {
 const genAiSpan = (spans ?? []).find(span => span.op === 'gen_ai.chat');

 expect(genAiSpan).toBeDefined();
 expect(genAiSpan.origin).toBe('auto.ai.cloudflare.workers_ai');
 expect(genAiSpan.data).toEqual(
 expect.objectContaining({
 'sentry.origin': 'auto.ai.cloudflare.workers_ai',
 'gen_ai.operation.name': 'chat',
 'gen_ai.request.model': '@cf/meta/llama-3.1-8b-instruct',
 'gen_ai.response.streaming': true,
 'gen_ai.response.text': 'The capital of France is Paris.',
 'gen_ai.output.messages': JSON.stringify([
 { role: 'assistant', parts: [{ type: 'text', content: 'The capital of France is Paris.' }] },
 ]),
 'gen_ai.usage.input_tokens': 15,
 'gen_ai.usage.output_tokens': 8,
 'gen_ai.usage.total_tokens': 23,
 }),
 );
}

test('captures Workers AI streaming output when driven via an Agent', async ({ request, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-agent/test' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'gen_ai.chat')
 );
 });

 const response = await request.get(`${baseURL}/agents/my-agent/test`);
 expect(response.ok()).toBe(true);

 const transaction = await transactionPromise;
 assertGenAiStreamingSpan(transaction.spans);
});

test('captures Workers AI streaming output when driven via an AIChatAgent', async ({ request, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-chat-agent/test' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'gen_ai.chat')
 );
 });

 const response = await request.get(`${baseURL}/agents/my-chat-agent/test`);
 expect(response.ok()).toBe(true);

 const transaction = await transactionPromise;
 assertGenAiStreamingSpan(transaction.spans);
});

62 changes: 61 additions & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/callable.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('@callable() methods work correctly with Sentry instrumentDurableObjectWithSentry', async ({ page, baseURL }) => {
test('@callable() methods work correctly with Sentry instrumentAgentWithSentry', async ({ page, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-agent/user-123' &&
Expand DownExpand Up@@ -127,3 +127,63 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
 }),
 ]);
});

test('does not emit db.query spans for the agents runtime `cf_`-prefixed internal tables', async ({
 page,
 baseURL,
}) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-agent/user-123' &&
 transactionEvent.contexts?.trace?.parent_span_id !== undefined
 );
 });

 await page.goto(baseURL!);

 await expect(page.getByText('Connected')).toBeVisible();
 await page.getByRole('button', { name: 'Call Agent' }).click();
 await expect(page.getByText('Hello, World!')).toBeVisible();

 const transaction = await transactionPromise;

 // The agents runtime constantly queries its own `cf_agents_*` / `cf_agent_*` bookkeeping tables.
 // These are framework internals and are filtered out by default, so no such span should leak.
 const internalTableSpans = (transaction.spans ?? []).filter(
 span => span.op === 'db.query' && /\bcf_/.test((span.data?.['db.query.summary'] as string) ?? ''),
 );

 expect(internalTableSpans).toEqual([]);
});

test('creates an rpc span named after the @callable() method', async ({ page, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'webSocketMessage' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'rpc' && span.description === 'greet')
 );
 });

 await page.goto(baseURL!);

 await expect(page.getByText('Connected')).toBeVisible();
 await page.getByRole('button', { name: 'Call Agent' }).click();
 await expect(page.getByText('Hello, World!')).toBeVisible();

 const transaction = await transactionPromise;

 const rpcSpans = (transaction.spans ?? []).filter(span => span.op === 'rpc');
 expect(rpcSpans).toHaveLength(1);

 expect(rpcSpans[0]).toEqual(
 expect.objectContaining({
 op: 'rpc',
 description: 'greet',
 origin: 'auto.faas.cloudflare.agents',
 data: expect.objectContaining({
 'cloudflare.agent.class': 'MyBaseAgent',
 'cloudflare.agent.name': 'user-123',
 }),
 }),
 );
});

32 changes: 32 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/chat-conversation.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { sendChatMessage } from './agent-socket';

// In the Agents model one agent instance is one conversation, so the instance name is the
// conversation id the SDK correlates the turn's gen_ai spans with.
const CONVERSATION_ID = 'chat-conv-instance';

test('stamps the conversation id on gen_ai spans created inside a chat turn', async ({ baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'webSocketMessage' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'gen_ai.chat')
 );
 });

 await sendChatMessage(baseURL!, {
 binding: 'my-chat-agent',
 instance: CONVERSATION_ID,
 prompt: 'What is the capital of France?',
 });

 const transaction = await transactionPromise;

 const genAiSpan = (transaction.spans ?? []).find(span => span.op === 'gen_ai.chat');
 expect(genAiSpan).toBeDefined();
 expect(genAiSpan?.data).toEqual(
 expect.objectContaining({
 'gen_ai.conversation.id': CONVERSATION_ID,
 }),
 );
});

30 changes: 30 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/chat-rpc.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { callRpc } from './agent-socket';

const AGENT_INSTANCE = 'chat-rpc-instance';

test('creates an rpc span for a @callable() invocation on an AIChatAgent', async ({ baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'webSocketMessage' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'rpc' && span.description === 'greet')
 );
 });

 await callRpc(baseURL!, { binding: 'my-chat-agent', instance: AGENT_INSTANCE, method: 'greet', args: ['World'] });

 const transaction = await transactionPromise;

 const rpcSpan = (transaction.spans ?? []).find(span => span.op === 'rpc' && span.description === 'greet');
 expect(rpcSpan).toEqual(
 expect.objectContaining({
 op: 'rpc',
 description: 'greet',
 origin: 'auto.faas.cloudflare.agents',
 data: expect.objectContaining({
 'cloudflare.agent.name': AGENT_INSTANCE,
 }),
 }),
 );
});

3 changes: 2 additions & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-agent/worker-configuration.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,12 @@ interface __BaseEnv_Env {
 CF_VERSION_METADATA: WorkerVersionMetadata;
 E2E_TEST_DSN: string;
 MyAgent: DurableObjectNamespace<import('./worker/index').MyAgent>;
 MyChatAgent: DurableObjectNamespace<import('./worker/index').MyChatAgent>;
}
declare namespace Cloudflare {
 interface GlobalProps {
 mainModule: typeof import('./worker/index');
 durableNamespaces: 'MyAgent';
 durableNamespaces: 'MyAgent' | 'MyChatAgent';
 }
 interface Env extends __BaseEnv_Env {}
}
Expand Down
Loading
Loading

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

Skip to content
feat(v10/cloudflare): Add instrumentAgentWithSentry for Cloudflare Agents#22786

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

JPeer264
merged 1 commit into

from

Jul 29, 2026
 Merged


feat(v10/cloudflare): Add instrumentAgentWithSentry for Cloudflare Agents
#22786
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


34 changes: 20 additions & 14 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,26 +14,32 @@
 "test:dev": "TEST_ENV=development playwright test"
 },
 "dependencies": {
 "@cloudflare/ai-chat": "^0.7.1",
 "@sentry/cloudflare": "^10.53.1",
 "agents": "^0.13.1",
 "react": "^19.2.6",
 "react-dom": "^19.2.6"
 "@cloudflare/ai-chat": "^0.10.0",
 "@sentry/cloudflare": "^10.68.0",
 "@sentry/core": "^10.68.0",
 "agents": "^0.20.0",
 "ai": "^6.0.235",
 "react": "^19.2.8",
 "react-dom": "^19.2.8",
 "workers-ai-provider": "^3.3.1"
 },
 "devDependencies": {
 "@playwright/test": "~1.56.0",
 "@cloudflare/vite-plugin": "^1.37.2",
 "@cloudflare/workers-types": "^4.20260520.1",
 "@cloudflare/vite-plugin": "^1.47.0",
 "@cloudflare/workers-types": "^5.20260727.1",
 "@sentry-internal/test-utils": "link:../../../test-utils",
 "@types/node": "^24.12.4",
 "@types/react": "^19.2.15",
 "@types/node": "^26.1.2",
 "@types/react": "^19.2.17",
 "@types/react-dom": "^19.2.3",
 "@vitejs/plugin-react": "^6.0.2",
 "globals": "^17.6.0",
 "@types/ws": "^8.18.1",
 "@babel/core": "^8.0.1",
 "@babel/plugin-proposal-decorators": "^8.0.2",
 "@vitejs/plugin-react": "^6.0.4",
 "globals": "^17.8.0",
 "typescript": "~6.0.3",
 "vite": "^8.0.14",
 "wrangler": "^4.93.0",
 "ws": "^8.20.1"
 "vite": "^8.1.5",
 "wrangler": "^4.114.0",
 "ws": "^8.21.1"
 },
 "volta": {
 "node": "24.15.0",
Expand Down

90 changes: 90 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/agent-socket.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
import WebSocket from 'ws';

type AgentReply = { type?: string; id?: string; done?: boolean };

/** Sends a single frame over a WS to the given agent instance and resolves once `isDone` matches a reply. */
function driveAgentSocket(
 baseURL: string,
 binding: string,
 instance: string,
 frame: unknown,
 isDone: (reply: AgentReply) => boolean,
 timeoutLabel: string,
): Promise<void> {
 const wsUrl = `${baseURL.replace(/^http/, 'ws')}/agents/${binding}/${instance}`;

 return new Promise<void>((resolveSocket, rejectSocket) => {
 const socket = new WebSocket(wsUrl);
 const timeout = setTimeout(() => {
 socket.close();
 rejectSocket(new Error(`Timed out waiting for ${timeoutLabel}`));
 }, 15_000);

 socket.on('open', () => {
 socket.send(JSON.stringify(frame));
 });

 socket.on('message', data => {
 try {
 const parsed = JSON.parse(data.toString()) as AgentReply;
 if (isDone(parsed)) {
 clearTimeout(timeout);
 socket.close();
 resolveSocket();
 }
 } catch {
 // Ignore non-JSON / unrelated frames.
 }
 });

 socket.on('error', err => {
 clearTimeout(timeout);
 rejectSocket(err);
 });
 });
}

/** Opens a chat WebSocket to `/agents/<binding>/<instance>`, sends one `cf_agent_use_chat_request` frame. */
export function sendChatMessage(
 baseURL: string,
 options: { binding: string; instance: string; prompt: string },
): Promise<void> {
 const id = `chat-${options.instance}`;
 const frame = {
 type: 'cf_agent_use_chat_request',
 id,
 init: {
 method: 'POST',
 body: JSON.stringify({
 messages: [{ id: 'msg-1', role: 'user', parts: [{ type: 'text', text: options.prompt }] }],
 }),
 },
 };

 return driveAgentSocket(
 baseURL,
 options.binding,
 options.instance,
 frame,
 reply => reply.type === 'cf_agent_use_chat_response' && reply.id === id && !!reply.done,
 'chat response',
 );
}

/** Opens a WebSocket to `/agents/<binding>/<instance>`, sends one RPC frame, resolves on the reply. */
export function callRpc(
 baseURL: string,
 options: { binding: string; instance: string; method: string; args: unknown[] },
): Promise<void> {
 const id = `rpc-${options.method}`;
 const frame = { type: 'rpc', id, method: options.method, args: options.args };

 return driveAgentSocket(
 baseURL,
 options.binding,
 options.instance,
 frame,
 reply => reply.type === 'rpc' && reply.id === id && !!reply.done,
 `RPC reply to "${options.method}"`,
 );
}

60 changes: 60 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/ai-streaming.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

// Drives Workers AI through the real Cloudflare Agents SDK + Vercel AI SDK + `workers-ai-provider`
// stack (the OpenAI-compatible SSE shape, `choices[].delta.content`) from an Agent's `onRequest`.
// Asserts the streaming response text is captured on the gen_ai span — the regression seen in
// production where only input + usage survived. The model output is read from
// `gen_ai.output.messages`, so the streaming instrumentation must emit it alongside the
// deprecated `gen_ai.response.text`.
function assertGenAiStreamingSpan(spans: Array<Record<string, any>> | undefined): void {
 const genAiSpan = (spans ?? []).find(span => span.op === 'gen_ai.chat');

 expect(genAiSpan).toBeDefined();
 expect(genAiSpan.origin).toBe('auto.ai.cloudflare.workers_ai');
 expect(genAiSpan.data).toEqual(
 expect.objectContaining({
 'sentry.origin': 'auto.ai.cloudflare.workers_ai',
 'gen_ai.operation.name': 'chat',
 'gen_ai.request.model': '@cf/meta/llama-3.1-8b-instruct',
 'gen_ai.response.streaming': true,
 'gen_ai.response.text': 'The capital of France is Paris.',
 'gen_ai.output.messages': JSON.stringify([
 { role: 'assistant', parts: [{ type: 'text', content: 'The capital of France is Paris.' }] },
 ]),
 'gen_ai.usage.input_tokens': 15,
 'gen_ai.usage.output_tokens': 8,
 'gen_ai.usage.total_tokens': 23,
 }),
 );
}

test('captures Workers AI streaming output when driven via an Agent', async ({ request, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-agent/test' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'gen_ai.chat')
 );
 });

 const response = await request.get(`${baseURL}/agents/my-agent/test`);
 expect(response.ok()).toBe(true);

 const transaction = await transactionPromise;
 assertGenAiStreamingSpan(transaction.spans);
});

test('captures Workers AI streaming output when driven via an AIChatAgent', async ({ request, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-chat-agent/test' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'gen_ai.chat')
 );
 });

 const response = await request.get(`${baseURL}/agents/my-chat-agent/test`);
 expect(response.ok()).toBe(true);

 const transaction = await transactionPromise;
 assertGenAiStreamingSpan(transaction.spans);
});

62 changes: 61 additions & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/callable.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('@callable() methods work correctly with Sentry instrumentDurableObjectWithSentry', async ({ page, baseURL }) => {
test('@callable() methods work correctly with Sentry instrumentAgentWithSentry', async ({ page, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-agent/user-123' &&
Expand DownExpand Up@@ -127,3 +127,63 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
 }),
 ]);
});

test('does not emit db.query spans for the agents runtime `cf_`-prefixed internal tables', async ({
 page,
 baseURL,
}) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-agent/user-123' &&
 transactionEvent.contexts?.trace?.parent_span_id !== undefined
 );
 });

 await page.goto(baseURL!);

 await expect(page.getByText('Connected')).toBeVisible();
 await page.getByRole('button', { name: 'Call Agent' }).click();
 await expect(page.getByText('Hello, World!')).toBeVisible();

 const transaction = await transactionPromise;

 // The agents runtime constantly queries its own `cf_agents_*` / `cf_agent_*` bookkeeping tables.
 // These are framework internals and are filtered out by default, so no such span should leak.
 const internalTableSpans = (transaction.spans ?? []).filter(
 span => span.op === 'db.query' && /\bcf_/.test((span.data?.['db.query.summary'] as string) ?? ''),
 );

 expect(internalTableSpans).toEqual([]);
});

test('creates an rpc span named after the @callable() method', async ({ page, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'webSocketMessage' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'rpc' && span.description === 'greet')
 );
 });

 await page.goto(baseURL!);

 await expect(page.getByText('Connected')).toBeVisible();
 await page.getByRole('button', { name: 'Call Agent' }).click();
 await expect(page.getByText('Hello, World!')).toBeVisible();

 const transaction = await transactionPromise;

 const rpcSpans = (transaction.spans ?? []).filter(span => span.op === 'rpc');
 expect(rpcSpans).toHaveLength(1);

 expect(rpcSpans[0]).toEqual(
 expect.objectContaining({
 op: 'rpc',
 description: 'greet',
 origin: 'auto.faas.cloudflare.agents',
 data: expect.objectContaining({
 'cloudflare.agent.class': 'MyBaseAgent',
 'cloudflare.agent.name': 'user-123',
 }),
 }),
 );
});

32 changes: 32 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/chat-conversation.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { sendChatMessage } from './agent-socket';

// In the Agents model one agent instance is one conversation, so the instance name is the
// conversation id the SDK correlates the turn's gen_ai spans with.
const CONVERSATION_ID = 'chat-conv-instance';

test('stamps the conversation id on gen_ai spans created inside a chat turn', async ({ baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'webSocketMessage' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'gen_ai.chat')
 );
 });

 await sendChatMessage(baseURL!, {
 binding: 'my-chat-agent',
 instance: CONVERSATION_ID,
 prompt: 'What is the capital of France?',
 });

 const transaction = await transactionPromise;

 const genAiSpan = (transaction.spans ?? []).find(span => span.op === 'gen_ai.chat');
 expect(genAiSpan).toBeDefined();
 expect(genAiSpan?.data).toEqual(
 expect.objectContaining({
 'gen_ai.conversation.id': CONVERSATION_ID,
 }),
 );
});

30 changes: 30 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/chat-rpc.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { callRpc } from './agent-socket';

const AGENT_INSTANCE = 'chat-rpc-instance';

test('creates an rpc span for a @callable() invocation on an AIChatAgent', async ({ baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'webSocketMessage' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'rpc' && span.description === 'greet')
 );
 });

 await callRpc(baseURL!, { binding: 'my-chat-agent', instance: AGENT_INSTANCE, method: 'greet', args: ['World'] });

 const transaction = await transactionPromise;

 const rpcSpan = (transaction.spans ?? []).find(span => span.op === 'rpc' && span.description === 'greet');
 expect(rpcSpan).toEqual(
 expect.objectContaining({
 op: 'rpc',
 description: 'greet',
 origin: 'auto.faas.cloudflare.agents',
 data: expect.objectContaining({
 'cloudflare.agent.name': AGENT_INSTANCE,
 }),
 }),
 );
});

3 changes: 2 additions & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-agent/worker-configuration.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,12 @@ interface __BaseEnv_Env {
 CF_VERSION_METADATA: WorkerVersionMetadata;
 E2E_TEST_DSN: string;
 MyAgent: DurableObjectNamespace<import('./worker/index').MyAgent>;
 MyChatAgent: DurableObjectNamespace<import('./worker/index').MyChatAgent>;
}
declare namespace Cloudflare {
 interface GlobalProps {
 mainModule: typeof import('./worker/index');
 durableNamespaces: 'MyAgent';
 durableNamespaces: 'MyAgent' | 'MyChatAgent';
 }
 interface Env extends __BaseEnv_Env {}
}
Expand Down
Loading
Loading

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

Skip to content
feat(v10/cloudflare): Add instrumentAgentWithSentry for Cloudflare Agents#22786

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

JPeer264
merged 1 commit into

from

Jul 29, 2026
 Merged


feat(v10/cloudflare): Add instrumentAgentWithSentry for Cloudflare Agents
#22786
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


34 changes: 20 additions & 14 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,26 +14,32 @@
 "test:dev": "TEST_ENV=development playwright test"
 },
 "dependencies": {
 "@cloudflare/ai-chat": "^0.7.1",
 "@sentry/cloudflare": "^10.53.1",
 "agents": "^0.13.1",
 "react": "^19.2.6",
 "react-dom": "^19.2.6"
 "@cloudflare/ai-chat": "^0.10.0",
 "@sentry/cloudflare": "^10.68.0",
 "@sentry/core": "^10.68.0",
 "agents": "^0.20.0",
 "ai": "^6.0.235",
 "react": "^19.2.8",
 "react-dom": "^19.2.8",
 "workers-ai-provider": "^3.3.1"
 },
 "devDependencies": {
 "@playwright/test": "~1.56.0",
 "@cloudflare/vite-plugin": "^1.37.2",
 "@cloudflare/workers-types": "^4.20260520.1",
 "@cloudflare/vite-plugin": "^1.47.0",
 "@cloudflare/workers-types": "^5.20260727.1",
 "@sentry-internal/test-utils": "link:../../../test-utils",
 "@types/node": "^24.12.4",
 "@types/react": "^19.2.15",
 "@types/node": "^26.1.2",
 "@types/react": "^19.2.17",
 "@types/react-dom": "^19.2.3",
 "@vitejs/plugin-react": "^6.0.2",
 "globals": "^17.6.0",
 "@types/ws": "^8.18.1",
 "@babel/core": "^8.0.1",
 "@babel/plugin-proposal-decorators": "^8.0.2",
 "@vitejs/plugin-react": "^6.0.4",
 "globals": "^17.8.0",
 "typescript": "~6.0.3",
 "vite": "^8.0.14",
 "wrangler": "^4.93.0",
 "ws": "^8.20.1"
 "vite": "^8.1.5",
 "wrangler": "^4.114.0",
 "ws": "^8.21.1"
 },
 "volta": {
 "node": "24.15.0",
Expand Down

90 changes: 90 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/agent-socket.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
import WebSocket from 'ws';

type AgentReply = { type?: string; id?: string; done?: boolean };

/** Sends a single frame over a WS to the given agent instance and resolves once `isDone` matches a reply. */
function driveAgentSocket(
 baseURL: string,
 binding: string,
 instance: string,
 frame: unknown,
 isDone: (reply: AgentReply) => boolean,
 timeoutLabel: string,
): Promise<void> {
 const wsUrl = `${baseURL.replace(/^http/, 'ws')}/agents/${binding}/${instance}`;

 return new Promise<void>((resolveSocket, rejectSocket) => {
 const socket = new WebSocket(wsUrl);
 const timeout = setTimeout(() => {
 socket.close();
 rejectSocket(new Error(`Timed out waiting for ${timeoutLabel}`));
 }, 15_000);

 socket.on('open', () => {
 socket.send(JSON.stringify(frame));
 });

 socket.on('message', data => {
 try {
 const parsed = JSON.parse(data.toString()) as AgentReply;
 if (isDone(parsed)) {
 clearTimeout(timeout);
 socket.close();
 resolveSocket();
 }
 } catch {
 // Ignore non-JSON / unrelated frames.
 }
 });

 socket.on('error', err => {
 clearTimeout(timeout);
 rejectSocket(err);
 });
 });
}

/** Opens a chat WebSocket to `/agents/<binding>/<instance>`, sends one `cf_agent_use_chat_request` frame. */
export function sendChatMessage(
 baseURL: string,
 options: { binding: string; instance: string; prompt: string },
): Promise<void> {
 const id = `chat-${options.instance}`;
 const frame = {
 type: 'cf_agent_use_chat_request',
 id,
 init: {
 method: 'POST',
 body: JSON.stringify({
 messages: [{ id: 'msg-1', role: 'user', parts: [{ type: 'text', text: options.prompt }] }],
 }),
 },
 };

 return driveAgentSocket(
 baseURL,
 options.binding,
 options.instance,
 frame,
 reply => reply.type === 'cf_agent_use_chat_response' && reply.id === id && !!reply.done,
 'chat response',
 );
}

/** Opens a WebSocket to `/agents/<binding>/<instance>`, sends one RPC frame, resolves on the reply. */
export function callRpc(
 baseURL: string,
 options: { binding: string; instance: string; method: string; args: unknown[] },
): Promise<void> {
 const id = `rpc-${options.method}`;
 const frame = { type: 'rpc', id, method: options.method, args: options.args };

 return driveAgentSocket(
 baseURL,
 options.binding,
 options.instance,
 frame,
 reply => reply.type === 'rpc' && reply.id === id && !!reply.done,
 `RPC reply to "${options.method}"`,
 );
}

60 changes: 60 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/ai-streaming.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

// Drives Workers AI through the real Cloudflare Agents SDK + Vercel AI SDK + `workers-ai-provider`
// stack (the OpenAI-compatible SSE shape, `choices[].delta.content`) from an Agent's `onRequest`.
// Asserts the streaming response text is captured on the gen_ai span — the regression seen in
// production where only input + usage survived. The model output is read from
// `gen_ai.output.messages`, so the streaming instrumentation must emit it alongside the
// deprecated `gen_ai.response.text`.
function assertGenAiStreamingSpan(spans: Array<Record<string, any>> | undefined): void {
 const genAiSpan = (spans ?? []).find(span => span.op === 'gen_ai.chat');

 expect(genAiSpan).toBeDefined();
 expect(genAiSpan.origin).toBe('auto.ai.cloudflare.workers_ai');
 expect(genAiSpan.data).toEqual(
 expect.objectContaining({
 'sentry.origin': 'auto.ai.cloudflare.workers_ai',
 'gen_ai.operation.name': 'chat',
 'gen_ai.request.model': '@cf/meta/llama-3.1-8b-instruct',
 'gen_ai.response.streaming': true,
 'gen_ai.response.text': 'The capital of France is Paris.',
 'gen_ai.output.messages': JSON.stringify([
 { role: 'assistant', parts: [{ type: 'text', content: 'The capital of France is Paris.' }] },
 ]),
 'gen_ai.usage.input_tokens': 15,
 'gen_ai.usage.output_tokens': 8,
 'gen_ai.usage.total_tokens': 23,
 }),
 );
}

test('captures Workers AI streaming output when driven via an Agent', async ({ request, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-agent/test' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'gen_ai.chat')
 );
 });

 const response = await request.get(`${baseURL}/agents/my-agent/test`);
 expect(response.ok()).toBe(true);

 const transaction = await transactionPromise;
 assertGenAiStreamingSpan(transaction.spans);
});

test('captures Workers AI streaming output when driven via an AIChatAgent', async ({ request, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-chat-agent/test' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'gen_ai.chat')
 );
 });

 const response = await request.get(`${baseURL}/agents/my-chat-agent/test`);
 expect(response.ok()).toBe(true);

 const transaction = await transactionPromise;
 assertGenAiStreamingSpan(transaction.spans);
});

62 changes: 61 additions & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/callable.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('@callable() methods work correctly with Sentry instrumentDurableObjectWithSentry', async ({ page, baseURL }) => {
test('@callable() methods work correctly with Sentry instrumentAgentWithSentry', async ({ page, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-agent/user-123' &&
Expand DownExpand Up@@ -127,3 +127,63 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
 }),
 ]);
});

test('does not emit db.query spans for the agents runtime `cf_`-prefixed internal tables', async ({
 page,
 baseURL,
}) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-agent/user-123' &&
 transactionEvent.contexts?.trace?.parent_span_id !== undefined
 );
 });

 await page.goto(baseURL!);

 await expect(page.getByText('Connected')).toBeVisible();
 await page.getByRole('button', { name: 'Call Agent' }).click();
 await expect(page.getByText('Hello, World!')).toBeVisible();

 const transaction = await transactionPromise;

 // The agents runtime constantly queries its own `cf_agents_*` / `cf_agent_*` bookkeeping tables.
 // These are framework internals and are filtered out by default, so no such span should leak.
 const internalTableSpans = (transaction.spans ?? []).filter(
 span => span.op === 'db.query' && /\bcf_/.test((span.data?.['db.query.summary'] as string) ?? ''),
 );

 expect(internalTableSpans).toEqual([]);
});

test('creates an rpc span named after the @callable() method', async ({ page, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'webSocketMessage' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'rpc' && span.description === 'greet')
 );
 });

 await page.goto(baseURL!);

 await expect(page.getByText('Connected')).toBeVisible();
 await page.getByRole('button', { name: 'Call Agent' }).click();
 await expect(page.getByText('Hello, World!')).toBeVisible();

 const transaction = await transactionPromise;

 const rpcSpans = (transaction.spans ?? []).filter(span => span.op === 'rpc');
 expect(rpcSpans).toHaveLength(1);

 expect(rpcSpans[0]).toEqual(
 expect.objectContaining({
 op: 'rpc',
 description: 'greet',
 origin: 'auto.faas.cloudflare.agents',
 data: expect.objectContaining({
 'cloudflare.agent.class': 'MyBaseAgent',
 'cloudflare.agent.name': 'user-123',
 }),
 }),
 );
});

32 changes: 32 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/chat-conversation.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { sendChatMessage } from './agent-socket';

// In the Agents model one agent instance is one conversation, so the instance name is the
// conversation id the SDK correlates the turn's gen_ai spans with.
const CONVERSATION_ID = 'chat-conv-instance';

test('stamps the conversation id on gen_ai spans created inside a chat turn', async ({ baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'webSocketMessage' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'gen_ai.chat')
 );
 });

 await sendChatMessage(baseURL!, {
 binding: 'my-chat-agent',
 instance: CONVERSATION_ID,
 prompt: 'What is the capital of France?',
 });

 const transaction = await transactionPromise;

 const genAiSpan = (transaction.spans ?? []).find(span => span.op === 'gen_ai.chat');
 expect(genAiSpan).toBeDefined();
 expect(genAiSpan?.data).toEqual(
 expect.objectContaining({
 'gen_ai.conversation.id': CONVERSATION_ID,
 }),
 );
});

30 changes: 30 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/chat-rpc.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { callRpc } from './agent-socket';

const AGENT_INSTANCE = 'chat-rpc-instance';

test('creates an rpc span for a @callable() invocation on an AIChatAgent', async ({ baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'webSocketMessage' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'rpc' && span.description === 'greet')
 );
 });

 await callRpc(baseURL!, { binding: 'my-chat-agent', instance: AGENT_INSTANCE, method: 'greet', args: ['World'] });

 const transaction = await transactionPromise;

 const rpcSpan = (transaction.spans ?? []).find(span => span.op === 'rpc' && span.description === 'greet');
 expect(rpcSpan).toEqual(
 expect.objectContaining({
 op: 'rpc',
 description: 'greet',
 origin: 'auto.faas.cloudflare.agents',
 data: expect.objectContaining({
 'cloudflare.agent.name': AGENT_INSTANCE,
 }),
 }),
 );
});

3 changes: 2 additions & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-agent/worker-configuration.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,12 @@ interface __BaseEnv_Env {
 CF_VERSION_METADATA: WorkerVersionMetadata;
 E2E_TEST_DSN: string;
 MyAgent: DurableObjectNamespace<import('./worker/index').MyAgent>;
 MyChatAgent: DurableObjectNamespace<import('./worker/index').MyChatAgent>;
}
declare namespace Cloudflare {
 interface GlobalProps {
 mainModule: typeof import('./worker/index');
 durableNamespaces: 'MyAgent';
 durableNamespaces: 'MyAgent' | 'MyChatAgent';
 }
 interface Env extends __BaseEnv_Env {}
}
Expand Down
Loading
Loading

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

Skip to content
feat(v10/cloudflare): Add instrumentAgentWithSentry for Cloudflare Agents#22786

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

JPeer264
merged 1 commit into

from

Jul 29, 2026
 Merged


feat(v10/cloudflare): Add instrumentAgentWithSentry for Cloudflare Agents
#22786
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


34 changes: 20 additions & 14 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,26 +14,32 @@
 "test:dev": "TEST_ENV=development playwright test"
 },
 "dependencies": {
 "@cloudflare/ai-chat": "^0.7.1",
 "@sentry/cloudflare": "^10.53.1",
 "agents": "^0.13.1",
 "react": "^19.2.6",
 "react-dom": "^19.2.6"
 "@cloudflare/ai-chat": "^0.10.0",
 "@sentry/cloudflare": "^10.68.0",
 "@sentry/core": "^10.68.0",
 "agents": "^0.20.0",
 "ai": "^6.0.235",
 "react": "^19.2.8",
 "react-dom": "^19.2.8",
 "workers-ai-provider": "^3.3.1"
 },
 "devDependencies": {
 "@playwright/test": "~1.56.0",
 "@cloudflare/vite-plugin": "^1.37.2",
 "@cloudflare/workers-types": "^4.20260520.1",
 "@cloudflare/vite-plugin": "^1.47.0",
 "@cloudflare/workers-types": "^5.20260727.1",
 "@sentry-internal/test-utils": "link:../../../test-utils",
 "@types/node": "^24.12.4",
 "@types/react": "^19.2.15",
 "@types/node": "^26.1.2",
 "@types/react": "^19.2.17",
 "@types/react-dom": "^19.2.3",
 "@vitejs/plugin-react": "^6.0.2",
 "globals": "^17.6.0",
 "@types/ws": "^8.18.1",
 "@babel/core": "^8.0.1",
 "@babel/plugin-proposal-decorators": "^8.0.2",
 "@vitejs/plugin-react": "^6.0.4",
 "globals": "^17.8.0",
 "typescript": "~6.0.3",
 "vite": "^8.0.14",
 "wrangler": "^4.93.0",
 "ws": "^8.20.1"
 "vite": "^8.1.5",
 "wrangler": "^4.114.0",
 "ws": "^8.21.1"
 },
 "volta": {
 "node": "24.15.0",
Expand Down

90 changes: 90 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/agent-socket.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
import WebSocket from 'ws';

type AgentReply = { type?: string; id?: string; done?: boolean };

/** Sends a single frame over a WS to the given agent instance and resolves once `isDone` matches a reply. */
function driveAgentSocket(
 baseURL: string,
 binding: string,
 instance: string,
 frame: unknown,
 isDone: (reply: AgentReply) => boolean,
 timeoutLabel: string,
): Promise<void> {
 const wsUrl = `${baseURL.replace(/^http/, 'ws')}/agents/${binding}/${instance}`;

 return new Promise<void>((resolveSocket, rejectSocket) => {
 const socket = new WebSocket(wsUrl);
 const timeout = setTimeout(() => {
 socket.close();
 rejectSocket(new Error(`Timed out waiting for ${timeoutLabel}`));
 }, 15_000);

 socket.on('open', () => {
 socket.send(JSON.stringify(frame));
 });

 socket.on('message', data => {
 try {
 const parsed = JSON.parse(data.toString()) as AgentReply;
 if (isDone(parsed)) {
 clearTimeout(timeout);
 socket.close();
 resolveSocket();
 }
 } catch {
 // Ignore non-JSON / unrelated frames.
 }
 });

 socket.on('error', err => {
 clearTimeout(timeout);
 rejectSocket(err);
 });
 });
}

/** Opens a chat WebSocket to `/agents/<binding>/<instance>`, sends one `cf_agent_use_chat_request` frame. */
export function sendChatMessage(
 baseURL: string,
 options: { binding: string; instance: string; prompt: string },
): Promise<void> {
 const id = `chat-${options.instance}`;
 const frame = {
 type: 'cf_agent_use_chat_request',
 id,
 init: {
 method: 'POST',
 body: JSON.stringify({
 messages: [{ id: 'msg-1', role: 'user', parts: [{ type: 'text', text: options.prompt }] }],
 }),
 },
 };

 return driveAgentSocket(
 baseURL,
 options.binding,
 options.instance,
 frame,
 reply => reply.type === 'cf_agent_use_chat_response' && reply.id === id && !!reply.done,
 'chat response',
 );
}

/** Opens a WebSocket to `/agents/<binding>/<instance>`, sends one RPC frame, resolves on the reply. */
export function callRpc(
 baseURL: string,
 options: { binding: string; instance: string; method: string; args: unknown[] },
): Promise<void> {
 const id = `rpc-${options.method}`;
 const frame = { type: 'rpc', id, method: options.method, args: options.args };

 return driveAgentSocket(
 baseURL,
 options.binding,
 options.instance,
 frame,
 reply => reply.type === 'rpc' && reply.id === id && !!reply.done,
 `RPC reply to "${options.method}"`,
 );
}

60 changes: 60 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/ai-streaming.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

// Drives Workers AI through the real Cloudflare Agents SDK + Vercel AI SDK + `workers-ai-provider`
// stack (the OpenAI-compatible SSE shape, `choices[].delta.content`) from an Agent's `onRequest`.
// Asserts the streaming response text is captured on the gen_ai span — the regression seen in
// production where only input + usage survived. The model output is read from
// `gen_ai.output.messages`, so the streaming instrumentation must emit it alongside the
// deprecated `gen_ai.response.text`.
function assertGenAiStreamingSpan(spans: Array<Record<string, any>> | undefined): void {
 const genAiSpan = (spans ?? []).find(span => span.op === 'gen_ai.chat');

 expect(genAiSpan).toBeDefined();
 expect(genAiSpan.origin).toBe('auto.ai.cloudflare.workers_ai');
 expect(genAiSpan.data).toEqual(
 expect.objectContaining({
 'sentry.origin': 'auto.ai.cloudflare.workers_ai',
 'gen_ai.operation.name': 'chat',
 'gen_ai.request.model': '@cf/meta/llama-3.1-8b-instruct',
 'gen_ai.response.streaming': true,
 'gen_ai.response.text': 'The capital of France is Paris.',
 'gen_ai.output.messages': JSON.stringify([
 { role: 'assistant', parts: [{ type: 'text', content: 'The capital of France is Paris.' }] },
 ]),
 'gen_ai.usage.input_tokens': 15,
 'gen_ai.usage.output_tokens': 8,
 'gen_ai.usage.total_tokens': 23,
 }),
 );
}

test('captures Workers AI streaming output when driven via an Agent', async ({ request, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-agent/test' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'gen_ai.chat')
 );
 });

 const response = await request.get(`${baseURL}/agents/my-agent/test`);
 expect(response.ok()).toBe(true);

 const transaction = await transactionPromise;
 assertGenAiStreamingSpan(transaction.spans);
});

test('captures Workers AI streaming output when driven via an AIChatAgent', async ({ request, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-chat-agent/test' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'gen_ai.chat')
 );
 });

 const response = await request.get(`${baseURL}/agents/my-chat-agent/test`);
 expect(response.ok()).toBe(true);

 const transaction = await transactionPromise;
 assertGenAiStreamingSpan(transaction.spans);
});

62 changes: 61 additions & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/callable.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('@callable() methods work correctly with Sentry instrumentDurableObjectWithSentry', async ({ page, baseURL }) => {
test('@callable() methods work correctly with Sentry instrumentAgentWithSentry', async ({ page, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-agent/user-123' &&
Expand DownExpand Up@@ -127,3 +127,63 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
 }),
 ]);
});

test('does not emit db.query spans for the agents runtime `cf_`-prefixed internal tables', async ({
 page,
 baseURL,
}) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-agent/user-123' &&
 transactionEvent.contexts?.trace?.parent_span_id !== undefined
 );
 });

 await page.goto(baseURL!);

 await expect(page.getByText('Connected')).toBeVisible();
 await page.getByRole('button', { name: 'Call Agent' }).click();
 await expect(page.getByText('Hello, World!')).toBeVisible();

 const transaction = await transactionPromise;

 // The agents runtime constantly queries its own `cf_agents_*` / `cf_agent_*` bookkeeping tables.
 // These are framework internals and are filtered out by default, so no such span should leak.
 const internalTableSpans = (transaction.spans ?? []).filter(
 span => span.op === 'db.query' && /\bcf_/.test((span.data?.['db.query.summary'] as string) ?? ''),
 );

 expect(internalTableSpans).toEqual([]);
});

test('creates an rpc span named after the @callable() method', async ({ page, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'webSocketMessage' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'rpc' && span.description === 'greet')
 );
 });

 await page.goto(baseURL!);

 await expect(page.getByText('Connected')).toBeVisible();
 await page.getByRole('button', { name: 'Call Agent' }).click();
 await expect(page.getByText('Hello, World!')).toBeVisible();

 const transaction = await transactionPromise;

 const rpcSpans = (transaction.spans ?? []).filter(span => span.op === 'rpc');
 expect(rpcSpans).toHaveLength(1);

 expect(rpcSpans[0]).toEqual(
 expect.objectContaining({
 op: 'rpc',
 description: 'greet',
 origin: 'auto.faas.cloudflare.agents',
 data: expect.objectContaining({
 'cloudflare.agent.class': 'MyBaseAgent',
 'cloudflare.agent.name': 'user-123',
 }),
 }),
 );
});

32 changes: 32 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/chat-conversation.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { sendChatMessage } from './agent-socket';

// In the Agents model one agent instance is one conversation, so the instance name is the
// conversation id the SDK correlates the turn's gen_ai spans with.
const CONVERSATION_ID = 'chat-conv-instance';

test('stamps the conversation id on gen_ai spans created inside a chat turn', async ({ baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'webSocketMessage' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'gen_ai.chat')
 );
 });

 await sendChatMessage(baseURL!, {
 binding: 'my-chat-agent',
 instance: CONVERSATION_ID,
 prompt: 'What is the capital of France?',
 });

 const transaction = await transactionPromise;

 const genAiSpan = (transaction.spans ?? []).find(span => span.op === 'gen_ai.chat');
 expect(genAiSpan).toBeDefined();
 expect(genAiSpan?.data).toEqual(
 expect.objectContaining({
 'gen_ai.conversation.id': CONVERSATION_ID,
 }),
 );
});

30 changes: 30 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/chat-rpc.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { callRpc } from './agent-socket';

const AGENT_INSTANCE = 'chat-rpc-instance';

test('creates an rpc span for a @callable() invocation on an AIChatAgent', async ({ baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'webSocketMessage' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'rpc' && span.description === 'greet')
 );
 });

 await callRpc(baseURL!, { binding: 'my-chat-agent', instance: AGENT_INSTANCE, method: 'greet', args: ['World'] });

 const transaction = await transactionPromise;

 const rpcSpan = (transaction.spans ?? []).find(span => span.op === 'rpc' && span.description === 'greet');
 expect(rpcSpan).toEqual(
 expect.objectContaining({
 op: 'rpc',
 description: 'greet',
 origin: 'auto.faas.cloudflare.agents',
 data: expect.objectContaining({
 'cloudflare.agent.name': AGENT_INSTANCE,
 }),
 }),
 );
});

3 changes: 2 additions & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-agent/worker-configuration.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,12 @@ interface __BaseEnv_Env {
 CF_VERSION_METADATA: WorkerVersionMetadata;
 E2E_TEST_DSN: string;
 MyAgent: DurableObjectNamespace<import('./worker/index').MyAgent>;
 MyChatAgent: DurableObjectNamespace<import('./worker/index').MyChatAgent>;
}
declare namespace Cloudflare {
 interface GlobalProps {
 mainModule: typeof import('./worker/index');
 durableNamespaces: 'MyAgent';
 durableNamespaces: 'MyAgent' | 'MyChatAgent';
 }
 interface Env extends __BaseEnv_Env {}
}
Expand Down
Loading
Loading

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

Skip to content
feat(v10/cloudflare): Add instrumentAgentWithSentry for Cloudflare Agents#22786

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

JPeer264
merged 1 commit into

from

Jul 29, 2026
 Merged


feat(v10/cloudflare): Add instrumentAgentWithSentry for Cloudflare Agents
#22786
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


34 changes: 20 additions & 14 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,26 +14,32 @@
 "test:dev": "TEST_ENV=development playwright test"
 },
 "dependencies": {
 "@cloudflare/ai-chat": "^0.7.1",
 "@sentry/cloudflare": "^10.53.1",
 "agents": "^0.13.1",
 "react": "^19.2.6",
 "react-dom": "^19.2.6"
 "@cloudflare/ai-chat": "^0.10.0",
 "@sentry/cloudflare": "^10.68.0",
 "@sentry/core": "^10.68.0",
 "agents": "^0.20.0",
 "ai": "^6.0.235",
 "react": "^19.2.8",
 "react-dom": "^19.2.8",
 "workers-ai-provider": "^3.3.1"
 },
 "devDependencies": {
 "@playwright/test": "~1.56.0",
 "@cloudflare/vite-plugin": "^1.37.2",
 "@cloudflare/workers-types": "^4.20260520.1",
 "@cloudflare/vite-plugin": "^1.47.0",
 "@cloudflare/workers-types": "^5.20260727.1",
 "@sentry-internal/test-utils": "link:../../../test-utils",
 "@types/node": "^24.12.4",
 "@types/react": "^19.2.15",
 "@types/node": "^26.1.2",
 "@types/react": "^19.2.17",
 "@types/react-dom": "^19.2.3",
 "@vitejs/plugin-react": "^6.0.2",
 "globals": "^17.6.0",
 "@types/ws": "^8.18.1",
 "@babel/core": "^8.0.1",
 "@babel/plugin-proposal-decorators": "^8.0.2",
 "@vitejs/plugin-react": "^6.0.4",
 "globals": "^17.8.0",
 "typescript": "~6.0.3",
 "vite": "^8.0.14",
 "wrangler": "^4.93.0",
 "ws": "^8.20.1"
 "vite": "^8.1.5",
 "wrangler": "^4.114.0",
 "ws": "^8.21.1"
 },
 "volta": {
 "node": "24.15.0",
Expand Down

90 changes: 90 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/agent-socket.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
import WebSocket from 'ws';

type AgentReply = { type?: string; id?: string; done?: boolean };

/** Sends a single frame over a WS to the given agent instance and resolves once `isDone` matches a reply. */
function driveAgentSocket(
 baseURL: string,
 binding: string,
 instance: string,
 frame: unknown,
 isDone: (reply: AgentReply) => boolean,
 timeoutLabel: string,
): Promise<void> {
 const wsUrl = `${baseURL.replace(/^http/, 'ws')}/agents/${binding}/${instance}`;

 return new Promise<void>((resolveSocket, rejectSocket) => {
 const socket = new WebSocket(wsUrl);
 const timeout = setTimeout(() => {
 socket.close();
 rejectSocket(new Error(`Timed out waiting for ${timeoutLabel}`));
 }, 15_000);

 socket.on('open', () => {
 socket.send(JSON.stringify(frame));
 });

 socket.on('message', data => {
 try {
 const parsed = JSON.parse(data.toString()) as AgentReply;
 if (isDone(parsed)) {
 clearTimeout(timeout);
 socket.close();
 resolveSocket();
 }
 } catch {
 // Ignore non-JSON / unrelated frames.
 }
 });

 socket.on('error', err => {
 clearTimeout(timeout);
 rejectSocket(err);
 });
 });
}

/** Opens a chat WebSocket to `/agents/<binding>/<instance>`, sends one `cf_agent_use_chat_request` frame. */
export function sendChatMessage(
 baseURL: string,
 options: { binding: string; instance: string; prompt: string },
): Promise<void> {
 const id = `chat-${options.instance}`;
 const frame = {
 type: 'cf_agent_use_chat_request',
 id,
 init: {
 method: 'POST',
 body: JSON.stringify({
 messages: [{ id: 'msg-1', role: 'user', parts: [{ type: 'text', text: options.prompt }] }],
 }),
 },
 };

 return driveAgentSocket(
 baseURL,
 options.binding,
 options.instance,
 frame,
 reply => reply.type === 'cf_agent_use_chat_response' && reply.id === id && !!reply.done,
 'chat response',
 );
}

/** Opens a WebSocket to `/agents/<binding>/<instance>`, sends one RPC frame, resolves on the reply. */
export function callRpc(
 baseURL: string,
 options: { binding: string; instance: string; method: string; args: unknown[] },
): Promise<void> {
 const id = `rpc-${options.method}`;
 const frame = { type: 'rpc', id, method: options.method, args: options.args };

 return driveAgentSocket(
 baseURL,
 options.binding,
 options.instance,
 frame,
 reply => reply.type === 'rpc' && reply.id === id && !!reply.done,
 `RPC reply to "${options.method}"`,
 );
}

60 changes: 60 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/ai-streaming.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

// Drives Workers AI through the real Cloudflare Agents SDK + Vercel AI SDK + `workers-ai-provider`
// stack (the OpenAI-compatible SSE shape, `choices[].delta.content`) from an Agent's `onRequest`.
// Asserts the streaming response text is captured on the gen_ai span — the regression seen in
// production where only input + usage survived. The model output is read from
// `gen_ai.output.messages`, so the streaming instrumentation must emit it alongside the
// deprecated `gen_ai.response.text`.
function assertGenAiStreamingSpan(spans: Array<Record<string, any>> | undefined): void {
 const genAiSpan = (spans ?? []).find(span => span.op === 'gen_ai.chat');

 expect(genAiSpan).toBeDefined();
 expect(genAiSpan.origin).toBe('auto.ai.cloudflare.workers_ai');
 expect(genAiSpan.data).toEqual(
 expect.objectContaining({
 'sentry.origin': 'auto.ai.cloudflare.workers_ai',
 'gen_ai.operation.name': 'chat',
 'gen_ai.request.model': '@cf/meta/llama-3.1-8b-instruct',
 'gen_ai.response.streaming': true,
 'gen_ai.response.text': 'The capital of France is Paris.',
 'gen_ai.output.messages': JSON.stringify([
 { role: 'assistant', parts: [{ type: 'text', content: 'The capital of France is Paris.' }] },
 ]),
 'gen_ai.usage.input_tokens': 15,
 'gen_ai.usage.output_tokens': 8,
 'gen_ai.usage.total_tokens': 23,
 }),
 );
}

test('captures Workers AI streaming output when driven via an Agent', async ({ request, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-agent/test' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'gen_ai.chat')
 );
 });

 const response = await request.get(`${baseURL}/agents/my-agent/test`);
 expect(response.ok()).toBe(true);

 const transaction = await transactionPromise;
 assertGenAiStreamingSpan(transaction.spans);
});

test('captures Workers AI streaming output when driven via an AIChatAgent', async ({ request, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-chat-agent/test' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'gen_ai.chat')
 );
 });

 const response = await request.get(`${baseURL}/agents/my-chat-agent/test`);
 expect(response.ok()).toBe(true);

 const transaction = await transactionPromise;
 assertGenAiStreamingSpan(transaction.spans);
});

62 changes: 61 additions & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/callable.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('@callable() methods work correctly with Sentry instrumentDurableObjectWithSentry', async ({ page, baseURL }) => {
test('@callable() methods work correctly with Sentry instrumentAgentWithSentry', async ({ page, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-agent/user-123' &&
Expand DownExpand Up@@ -127,3 +127,63 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
 }),
 ]);
});

test('does not emit db.query spans for the agents runtime `cf_`-prefixed internal tables', async ({
 page,
 baseURL,
}) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-agent/user-123' &&
 transactionEvent.contexts?.trace?.parent_span_id !== undefined
 );
 });

 await page.goto(baseURL!);

 await expect(page.getByText('Connected')).toBeVisible();
 await page.getByRole('button', { name: 'Call Agent' }).click();
 await expect(page.getByText('Hello, World!')).toBeVisible();

 const transaction = await transactionPromise;

 // The agents runtime constantly queries its own `cf_agents_*` / `cf_agent_*` bookkeeping tables.
 // These are framework internals and are filtered out by default, so no such span should leak.
 const internalTableSpans = (transaction.spans ?? []).filter(
 span => span.op === 'db.query' && /\bcf_/.test((span.data?.['db.query.summary'] as string) ?? ''),
 );

 expect(internalTableSpans).toEqual([]);
});

test('creates an rpc span named after the @callable() method', async ({ page, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'webSocketMessage' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'rpc' && span.description === 'greet')
 );
 });

 await page.goto(baseURL!);

 await expect(page.getByText('Connected')).toBeVisible();
 await page.getByRole('button', { name: 'Call Agent' }).click();
 await expect(page.getByText('Hello, World!')).toBeVisible();

 const transaction = await transactionPromise;

 const rpcSpans = (transaction.spans ?? []).filter(span => span.op === 'rpc');
 expect(rpcSpans).toHaveLength(1);

 expect(rpcSpans[0]).toEqual(
 expect.objectContaining({
 op: 'rpc',
 description: 'greet',
 origin: 'auto.faas.cloudflare.agents',
 data: expect.objectContaining({
 'cloudflare.agent.class': 'MyBaseAgent',
 'cloudflare.agent.name': 'user-123',
 }),
 }),
 );
});

32 changes: 32 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/chat-conversation.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { sendChatMessage } from './agent-socket';

// In the Agents model one agent instance is one conversation, so the instance name is the
// conversation id the SDK correlates the turn's gen_ai spans with.
const CONVERSATION_ID = 'chat-conv-instance';

test('stamps the conversation id on gen_ai spans created inside a chat turn', async ({ baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'webSocketMessage' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'gen_ai.chat')
 );
 });

 await sendChatMessage(baseURL!, {
 binding: 'my-chat-agent',
 instance: CONVERSATION_ID,
 prompt: 'What is the capital of France?',
 });

 const transaction = await transactionPromise;

 const genAiSpan = (transaction.spans ?? []).find(span => span.op === 'gen_ai.chat');
 expect(genAiSpan).toBeDefined();
 expect(genAiSpan?.data).toEqual(
 expect.objectContaining({
 'gen_ai.conversation.id': CONVERSATION_ID,
 }),
 );
});

30 changes: 30 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/chat-rpc.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { callRpc } from './agent-socket';

const AGENT_INSTANCE = 'chat-rpc-instance';

test('creates an rpc span for a @callable() invocation on an AIChatAgent', async ({ baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'webSocketMessage' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'rpc' && span.description === 'greet')
 );
 });

 await callRpc(baseURL!, { binding: 'my-chat-agent', instance: AGENT_INSTANCE, method: 'greet', args: ['World'] });

 const transaction = await transactionPromise;

 const rpcSpan = (transaction.spans ?? []).find(span => span.op === 'rpc' && span.description === 'greet');
 expect(rpcSpan).toEqual(
 expect.objectContaining({
 op: 'rpc',
 description: 'greet',
 origin: 'auto.faas.cloudflare.agents',
 data: expect.objectContaining({
 'cloudflare.agent.name': AGENT_INSTANCE,
 }),
 }),
 );
});

3 changes: 2 additions & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-agent/worker-configuration.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,12 @@ interface __BaseEnv_Env {
 CF_VERSION_METADATA: WorkerVersionMetadata;
 E2E_TEST_DSN: string;
 MyAgent: DurableObjectNamespace<import('./worker/index').MyAgent>;
 MyChatAgent: DurableObjectNamespace<import('./worker/index').MyChatAgent>;
}
declare namespace Cloudflare {
 interface GlobalProps {
 mainModule: typeof import('./worker/index');
 durableNamespaces: 'MyAgent';
 durableNamespaces: 'MyAgent' | 'MyChatAgent';
 }
 interface Env extends __BaseEnv_Env {}
}
Expand Down
Loading
Loading

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

Skip to content
feat(v10/cloudflare): Add instrumentAgentWithSentry for Cloudflare Agents#22786

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

JPeer264
merged 1 commit into

from

Jul 29, 2026
 Merged


feat(v10/cloudflare): Add instrumentAgentWithSentry for Cloudflare Agents
#22786
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


34 changes: 20 additions & 14 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,26 +14,32 @@
 "test:dev": "TEST_ENV=development playwright test"
 },
 "dependencies": {
 "@cloudflare/ai-chat": "^0.7.1",
 "@sentry/cloudflare": "^10.53.1",
 "agents": "^0.13.1",
 "react": "^19.2.6",
 "react-dom": "^19.2.6"
 "@cloudflare/ai-chat": "^0.10.0",
 "@sentry/cloudflare": "^10.68.0",
 "@sentry/core": "^10.68.0",
 "agents": "^0.20.0",
 "ai": "^6.0.235",
 "react": "^19.2.8",
 "react-dom": "^19.2.8",
 "workers-ai-provider": "^3.3.1"
 },
 "devDependencies": {
 "@playwright/test": "~1.56.0",
 "@cloudflare/vite-plugin": "^1.37.2",
 "@cloudflare/workers-types": "^4.20260520.1",
 "@cloudflare/vite-plugin": "^1.47.0",
 "@cloudflare/workers-types": "^5.20260727.1",
 "@sentry-internal/test-utils": "link:../../../test-utils",
 "@types/node": "^24.12.4",
 "@types/react": "^19.2.15",
 "@types/node": "^26.1.2",
 "@types/react": "^19.2.17",
 "@types/react-dom": "^19.2.3",
 "@vitejs/plugin-react": "^6.0.2",
 "globals": "^17.6.0",
 "@types/ws": "^8.18.1",
 "@babel/core": "^8.0.1",
 "@babel/plugin-proposal-decorators": "^8.0.2",
 "@vitejs/plugin-react": "^6.0.4",
 "globals": "^17.8.0",
 "typescript": "~6.0.3",
 "vite": "^8.0.14",
 "wrangler": "^4.93.0",
 "ws": "^8.20.1"
 "vite": "^8.1.5",
 "wrangler": "^4.114.0",
 "ws": "^8.21.1"
 },
 "volta": {
 "node": "24.15.0",
Expand Down

90 changes: 90 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/agent-socket.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
import WebSocket from 'ws';

type AgentReply = { type?: string; id?: string; done?: boolean };

/** Sends a single frame over a WS to the given agent instance and resolves once `isDone` matches a reply. */
function driveAgentSocket(
 baseURL: string,
 binding: string,
 instance: string,
 frame: unknown,
 isDone: (reply: AgentReply) => boolean,
 timeoutLabel: string,
): Promise<void> {
 const wsUrl = `${baseURL.replace(/^http/, 'ws')}/agents/${binding}/${instance}`;

 return new Promise<void>((resolveSocket, rejectSocket) => {
 const socket = new WebSocket(wsUrl);
 const timeout = setTimeout(() => {
 socket.close();
 rejectSocket(new Error(`Timed out waiting for ${timeoutLabel}`));
 }, 15_000);

 socket.on('open', () => {
 socket.send(JSON.stringify(frame));
 });

 socket.on('message', data => {
 try {
 const parsed = JSON.parse(data.toString()) as AgentReply;
 if (isDone(parsed)) {
 clearTimeout(timeout);
 socket.close();
 resolveSocket();
 }
 } catch {
 // Ignore non-JSON / unrelated frames.
 }
 });

 socket.on('error', err => {
 clearTimeout(timeout);
 rejectSocket(err);
 });
 });
}

/** Opens a chat WebSocket to `/agents/<binding>/<instance>`, sends one `cf_agent_use_chat_request` frame. */
export function sendChatMessage(
 baseURL: string,
 options: { binding: string; instance: string; prompt: string },
): Promise<void> {
 const id = `chat-${options.instance}`;
 const frame = {
 type: 'cf_agent_use_chat_request',
 id,
 init: {
 method: 'POST',
 body: JSON.stringify({
 messages: [{ id: 'msg-1', role: 'user', parts: [{ type: 'text', text: options.prompt }] }],
 }),
 },
 };

 return driveAgentSocket(
 baseURL,
 options.binding,
 options.instance,
 frame,
 reply => reply.type === 'cf_agent_use_chat_response' && reply.id === id && !!reply.done,
 'chat response',
 );
}

/** Opens a WebSocket to `/agents/<binding>/<instance>`, sends one RPC frame, resolves on the reply. */
export function callRpc(
 baseURL: string,
 options: { binding: string; instance: string; method: string; args: unknown[] },
): Promise<void> {
 const id = `rpc-${options.method}`;
 const frame = { type: 'rpc', id, method: options.method, args: options.args };

 return driveAgentSocket(
 baseURL,
 options.binding,
 options.instance,
 frame,
 reply => reply.type === 'rpc' && reply.id === id && !!reply.done,
 `RPC reply to "${options.method}"`,
 );
}

60 changes: 60 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/ai-streaming.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

// Drives Workers AI through the real Cloudflare Agents SDK + Vercel AI SDK + `workers-ai-provider`
// stack (the OpenAI-compatible SSE shape, `choices[].delta.content`) from an Agent's `onRequest`.
// Asserts the streaming response text is captured on the gen_ai span — the regression seen in
// production where only input + usage survived. The model output is read from
// `gen_ai.output.messages`, so the streaming instrumentation must emit it alongside the
// deprecated `gen_ai.response.text`.
function assertGenAiStreamingSpan(spans: Array<Record<string, any>> | undefined): void {
 const genAiSpan = (spans ?? []).find(span => span.op === 'gen_ai.chat');

 expect(genAiSpan).toBeDefined();
 expect(genAiSpan.origin).toBe('auto.ai.cloudflare.workers_ai');
 expect(genAiSpan.data).toEqual(
 expect.objectContaining({
 'sentry.origin': 'auto.ai.cloudflare.workers_ai',
 'gen_ai.operation.name': 'chat',
 'gen_ai.request.model': '@cf/meta/llama-3.1-8b-instruct',
 'gen_ai.response.streaming': true,
 'gen_ai.response.text': 'The capital of France is Paris.',
 'gen_ai.output.messages': JSON.stringify([
 { role: 'assistant', parts: [{ type: 'text', content: 'The capital of France is Paris.' }] },
 ]),
 'gen_ai.usage.input_tokens': 15,
 'gen_ai.usage.output_tokens': 8,
 'gen_ai.usage.total_tokens': 23,
 }),
 );
}

test('captures Workers AI streaming output when driven via an Agent', async ({ request, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-agent/test' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'gen_ai.chat')
 );
 });

 const response = await request.get(`${baseURL}/agents/my-agent/test`);
 expect(response.ok()).toBe(true);

 const transaction = await transactionPromise;
 assertGenAiStreamingSpan(transaction.spans);
});

test('captures Workers AI streaming output when driven via an AIChatAgent', async ({ request, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-chat-agent/test' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'gen_ai.chat')
 );
 });

 const response = await request.get(`${baseURL}/agents/my-chat-agent/test`);
 expect(response.ok()).toBe(true);

 const transaction = await transactionPromise;
 assertGenAiStreamingSpan(transaction.spans);
});

62 changes: 61 additions & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/callable.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('@callable() methods work correctly with Sentry instrumentDurableObjectWithSentry', async ({ page, baseURL }) => {
test('@callable() methods work correctly with Sentry instrumentAgentWithSentry', async ({ page, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-agent/user-123' &&
Expand DownExpand Up@@ -127,3 +127,63 @@ test('@callable() methods work correctly with Sentry instrumentDurableObjectWith
 }),
 ]);
});

test('does not emit db.query spans for the agents runtime `cf_`-prefixed internal tables', async ({
 page,
 baseURL,
}) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'GET /agents/my-agent/user-123' &&
 transactionEvent.contexts?.trace?.parent_span_id !== undefined
 );
 });

 await page.goto(baseURL!);

 await expect(page.getByText('Connected')).toBeVisible();
 await page.getByRole('button', { name: 'Call Agent' }).click();
 await expect(page.getByText('Hello, World!')).toBeVisible();

 const transaction = await transactionPromise;

 // The agents runtime constantly queries its own `cf_agents_*` / `cf_agent_*` bookkeeping tables.
 // These are framework internals and are filtered out by default, so no such span should leak.
 const internalTableSpans = (transaction.spans ?? []).filter(
 span => span.op === 'db.query' && /\bcf_/.test((span.data?.['db.query.summary'] as string) ?? ''),
 );

 expect(internalTableSpans).toEqual([]);
});

test('creates an rpc span named after the @callable() method', async ({ page, baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'webSocketMessage' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'rpc' && span.description === 'greet')
 );
 });

 await page.goto(baseURL!);

 await expect(page.getByText('Connected')).toBeVisible();
 await page.getByRole('button', { name: 'Call Agent' }).click();
 await expect(page.getByText('Hello, World!')).toBeVisible();

 const transaction = await transactionPromise;

 const rpcSpans = (transaction.spans ?? []).filter(span => span.op === 'rpc');
 expect(rpcSpans).toHaveLength(1);

 expect(rpcSpans[0]).toEqual(
 expect.objectContaining({
 op: 'rpc',
 description: 'greet',
 origin: 'auto.faas.cloudflare.agents',
 data: expect.objectContaining({
 'cloudflare.agent.class': 'MyBaseAgent',
 'cloudflare.agent.name': 'user-123',
 }),
 }),
 );
});

32 changes: 32 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/chat-conversation.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { sendChatMessage } from './agent-socket';

// In the Agents model one agent instance is one conversation, so the instance name is the
// conversation id the SDK correlates the turn's gen_ai spans with.
const CONVERSATION_ID = 'chat-conv-instance';

test('stamps the conversation id on gen_ai spans created inside a chat turn', async ({ baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'webSocketMessage' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'gen_ai.chat')
 );
 });

 await sendChatMessage(baseURL!, {
 binding: 'my-chat-agent',
 instance: CONVERSATION_ID,
 prompt: 'What is the capital of France?',
 });

 const transaction = await transactionPromise;

 const genAiSpan = (transaction.spans ?? []).find(span => span.op === 'gen_ai.chat');
 expect(genAiSpan).toBeDefined();
 expect(genAiSpan?.data).toEqual(
 expect.objectContaining({
 'gen_ai.conversation.id': CONVERSATION_ID,
 }),
 );
});

30 changes: 30 additions & 0 deletions
dev-packages/e2e-tests/test-applications/cloudflare-agent/tests/chat-rpc.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { callRpc } from './agent-socket';

const AGENT_INSTANCE = 'chat-rpc-instance';

test('creates an rpc span for a @callable() invocation on an AIChatAgent', async ({ baseURL }) => {
 const transactionPromise = waitForTransaction('cloudflare-agent', transactionEvent => {
 return (
 transactionEvent.transaction === 'webSocketMessage' &&
 (transactionEvent.spans ?? []).some(span => span.op === 'rpc' && span.description === 'greet')
 );
 });

 await callRpc(baseURL!, { binding: 'my-chat-agent', instance: AGENT_INSTANCE, method: 'greet', args: ['World'] });

 const transaction = await transactionPromise;

 const rpcSpan = (transaction.spans ?? []).find(span => span.op === 'rpc' && span.description === 'greet');
 expect(rpcSpan).toEqual(
 expect.objectContaining({
 op: 'rpc',
 description: 'greet',
 origin: 'auto.faas.cloudflare.agents',
 data: expect.objectContaining({
 'cloudflare.agent.name': AGENT_INSTANCE,
 }),
 }),
 );
});

3 changes: 2 additions & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-agent/worker-configuration.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,12 @@ interface __BaseEnv_Env {
 CF_VERSION_METADATA: WorkerVersionMetadata;
 E2E_TEST_DSN: string;
 MyAgent: DurableObjectNamespace<import('./worker/index').MyAgent>;
 MyChatAgent: DurableObjectNamespace<import('./worker/index').MyChatAgent>;
}
declare namespace Cloudflare {
 interface GlobalProps {
 mainModule: typeof import('./worker/index');
 durableNamespaces: 'MyAgent';
 durableNamespaces: 'MyAgent' | 'MyChatAgent';
 }
 interface Env extends __BaseEnv_Env {}
}
Expand Down
Loading
Loading