feat(cloudflare/vercel-edge): Add manual instrumentation for LangGraph

Author: RulaKhaled

dev-packages/cloudflare-integration-tests/package.json

@@ -13,6 +13,7 @@
     "test:watch": "yarn test --watch"
   },
   "dependencies": {
+    "@langchain/langgraph": "^1.0.1",
     "@sentry/cloudflare": "10.25.0"
   },
   "devDependencies": {

dev-packages/cloudflare-integration-tests/suites/tracing/langgraph/index.ts

@@ -0,0 +1,66 @@
+import { END, MessagesAnnotation, START, StateGraph } from '@langchain/langgraph';
+import * as Sentry from '@sentry/cloudflare';
+
+interface Env {
+  SENTRY_DSN: string;
+}
+
+export default Sentry.withSentry(
+  (env: Env) => ({
+    dsn: env.SENTRY_DSN,
+    tracesSampleRate: 1.0,
+    sendDefaultPii: true,
+  }),
+  {
+    async fetch(_request, _env, _ctx) {
+      // Define simple mock LLM function
+      const mockLlm = (): {
+        messages: {
+          role: string;
+          content: string;
+          response_metadata: {
+            model_name: string;
+            finish_reason: string;
+            tokenUsage: { promptTokens: number; completionTokens: number; totalTokens: number };
+          };
+          tool_calls: never[];
+        }[];
+      } => {
+        return {
+          messages: [
+            {
+              role: 'assistant',
+              content: 'Mock response from LangGraph agent',
+              response_metadata: {
+                model_name: 'mock-model',
+                finish_reason: 'stop',
+                tokenUsage: {
+                  promptTokens: 20,
+                  completionTokens: 10,
+                  totalTokens: 30,
+                },
+              },
+              tool_calls: [],
+            },
+          ],
+        };
+      };
+
+      // Create and instrument the graph
+      const graph = new StateGraph(MessagesAnnotation)
+        .addNode('agent', mockLlm)
+        .addEdge(START, 'agent')
+        .addEdge('agent', END);
+
+      Sentry.instrumentLangGraph(graph, { recordInputs: true, recordOutputs: true });
+
+      const compiled = graph.compile({ name: 'weather_assistant' });
+
+      await compiled.invoke({
+        messages: [{ role: 'user', content: 'What is the weather in SF?' }],
+      });
+
+      return new Response(JSON.stringify({ success: true }));
+    },
+  },
+);

dev-packages/cloudflare-integration-tests/suites/tracing/langgraph/test.ts

@@ -0,0 +1,59 @@
+import { expect, it } from 'vitest';
+import { createRunner } from '../../../runner';
+
+// These tests are not exhaustive because the instrumentation is
+// already tested in the node integration tests and we merely
+// want to test that the instrumentation does not break in our
+// cloudflare SDK.
+
+it('traces langgraph compile and invoke operations', async ({ signal }) => {
+  const runner = createRunner(__dirname)
+    .ignore('event')
+    .expect(envelope => {
+      const transactionEvent = envelope[1]?.[0]?.[1] as any;
+
+      expect(transactionEvent.transaction).toBe('GET /');
+
+      // Check create_agent span
+      const createAgentSpan = transactionEvent.spans.find((span: any) => span.op === 'gen_ai.create_agent');
+      expect(createAgentSpan).toMatchObject({
+        data: {
+          'gen_ai.operation.name': 'create_agent',
+          'sentry.op': 'gen_ai.create_agent',
+          'sentry.origin': 'auto.ai.langgraph',
+          'gen_ai.agent.name': 'weather_assistant',
+        },
+        description: 'create_agent weather_assistant',
+        op: 'gen_ai.create_agent',
+        origin: 'auto.ai.langgraph',
+      });
+
+      // Check invoke_agent span
+      const invokeAgentSpan = transactionEvent.spans.find((span: any) => span.op === 'gen_ai.invoke_agent');
+      expect(invokeAgentSpan).toMatchObject({
+        data: expect.objectContaining({
+          'gen_ai.operation.name': 'invoke_agent',
+          'sentry.op': 'gen_ai.invoke_agent',
+          'sentry.origin': 'auto.ai.langgraph',
+          'gen_ai.agent.name': 'weather_assistant',
+          'gen_ai.pipeline.name': 'weather_assistant',
+          'gen_ai.request.messages': '[{"role":"user","content":"What is the weather in SF?"}]',
+          'gen_ai.response.model': 'mock-model',
+          'gen_ai.usage.input_tokens': 20,
+          'gen_ai.usage.output_tokens': 10,
+          'gen_ai.usage.total_tokens': 30,
+        }),
+        description: 'invoke_agent weather_assistant',
+        op: 'gen_ai.invoke_agent',
+        origin: 'auto.ai.langgraph',
+      });
+
+      // Verify tools are captured
+      if (invokeAgentSpan.data['gen_ai.request.available_tools']) {
+        expect(invokeAgentSpan.data['gen_ai.request.available_tools']).toMatch(/get_weather/);
+      }
+    })
+    .start(signal);
+  await runner.makeRequest('get', '/');
+  await runner.completed();
+});

dev-packages/cloudflare-integration-tests/suites/tracing/langgraph/wrangler.jsonc

@@ -0,0 +1,7 @@
+{
+  "name": "worker-name",
+  "compatibility_date": "2025-06-17",
+  "main": "index.ts",
+  "compatibility_flags": ["nodejs_compat"]
+}
+

packages/cloudflare/src/index.ts

@@ -22,6 +22,7 @@ export type {
 export type { CloudflareOptions } from './client';
 
 export {
+  instrumentLangGraph,
   addEventProcessor,
   addBreadcrumb,
   addIntegration,

packages/core/src/index.ts

@@ -152,7 +152,7 @@ export type { GoogleGenAIResponse } from './tracing/google-genai/types';
 export { createLangChainCallbackHandler } from './tracing/langchain';
 export { LANGCHAIN_INTEGRATION_NAME } from './tracing/langchain/constants';
 export type { LangChainOptions, LangChainIntegration } from './tracing/langchain/types';
-export { instrumentStateGraphCompile } from './tracing/langgraph';
+export { instrumentStateGraphCompile, instrumentLangGraph } from './tracing/langgraph';
 export { LANGGRAPH_INTEGRATION_NAME } from './tracing/langgraph/constants';
 export type { LangGraphOptions, LangGraphIntegration, CompiledGraph } from './tracing/langgraph/types';
 export type { OpenAiClient, OpenAiOptions, InstrumentedMethod } from './tracing/openai/types';

packages/core/src/tracing/langgraph/index.ts

@@ -1,3 +1,4 @@
+import { getClient } from '../../currentScopes';
 import { captureException } from '../../exports';
 import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '../../semanticAttributes';
 import { SPAN_STATUS_ERROR } from '../../tracing';
@@ -17,6 +18,51 @@ import { LANGGRAPH_ORIGIN } from './constants';
 import type { CompiledGraph, LangGraphOptions } from './types';
 import { extractToolsFromCompiledGraph, setResponseAttributes } from './utils';
 
+/**
+ * Directly instruments a StateGraph instance to add tracing spans
+ *
+ * This function can be used to manually instrument LangGraph StateGraph instances
+ * in environments where automatic instrumentation is not available or desired.
+ *
+ * @param stateGraph - The StateGraph instance to instrument
+ * @param options - Optional configuration for recording inputs/outputs
+ *
+ * @example
+ * ```typescript
+ * import { instrumentLangGraph } from '@sentry/cloudflare';
+ * import { StateGraph } from '@langchain/langgraph';
+ *
+ * const graph = new StateGraph(MessagesAnnotation)
+ *   .addNode('agent', mockLlm)
+ *   .addEdge(START, 'agent')
+ *   .addEdge('agent', END);
+ *
+ * instrumentLangGraph(graph, { recordInputs: true, recordOutputs: true });
+ * const compiled = graph.compile({ name: 'my_agent' });
+ * ```
+ */
+export function instrumentLangGraph(
+  stateGraph: { compile?: (...args: unknown[]) => CompiledGraph },
+  options: LangGraphOptions = {},
+): void {
+  const client = getClient();
+  const clientOptions = client?.getOptions();
+  const defaultPii = Boolean(clientOptions?.sendDefaultPii);
+
+  const recordInputs = options.recordInputs ?? defaultPii;
+  const recordOutputs = options.recordOutputs ?? defaultPii;
+
+  const instrumentationOptions: LangGraphOptions = {
+    recordInputs,
+    recordOutputs,
+  };
+
+  if (stateGraph.compile && typeof stateGraph.compile === 'function') {
+    const originalCompile = stateGraph.compile;
+    stateGraph.compile = instrumentStateGraphCompile(originalCompile, instrumentationOptions);
+  }
+}
+
 /**
  * Instruments StateGraph's compile method to create spans for agent creation and invocation
  *

packages/vercel-edge/src/index.ts

@@ -71,6 +71,7 @@ export {
   // eslint-disable-next-line deprecation/deprecation
   inboundFiltersIntegration,
   instrumentOpenAiClient,
+  instrumentLangGraph,
   instrumentGoogleGenAIClient,
   instrumentAnthropicAiClient,
   eventFiltersIntegration,

yarn.lock

@@ -4931,6 +4931,13 @@
     zod "^3.25.32"
     zod-to-json-schema "^3.22.3"
 
+"@langchain/langgraph-checkpoint@^1.0.0":
+  version "1.0.0"
+  resolved "https://registry.npmjs.org/@langchain/langgraph-checkpoint/-/langgraph-checkpoint-1.0.0.tgz#ece2ede439d0d0b0b532c4be7817fd5029afe4f8"
+  integrity sha512-xrclBGvNCXDmi0Nz28t3vjpxSH6UYx6w5XAXSiiB1WEdc2xD2iY/a913I3x3a31XpInUW/GGfXXfePfaghV54A==
+  dependencies:
+    uuid "^10.0.0"
+
 "@langchain/langgraph-checkpoint@~0.0.17":
   version "0.0.18"
   resolved "https://registry.npmjs.org/@langchain/langgraph-checkpoint/-/langgraph-checkpoint-0.0.18.tgz#2f7a9cdeda948ccc8d312ba9463810709d71d0b8"
@@ -4948,6 +4955,15 @@
     p-retry "4"
     uuid "^9.0.0"
 
+"@langchain/langgraph-sdk@~1.0.0":
+  version "1.0.0"
+  resolved "https://registry.npmjs.org/@langchain/langgraph-sdk/-/langgraph-sdk-1.0.0.tgz#16faca6cc426432dee9316428d0aecd94e5b7989"
+  integrity sha512-g25ti2W7Dl5wUPlNK+0uIGbeNFqf98imhHlbdVVKTTkDYLhi/pI1KTgsSSkzkeLuBIfvt2b0q6anQwCs7XBlbw==
+  dependencies:
+    p-queue "^6.6.2"
+    p-retry "4"
+    uuid "^9.0.0"
+
 "@langchain/langgraph@^0.2.32":
   version "0.2.74"
   resolved "https://registry.npmjs.org/@langchain/langgraph/-/langgraph-0.2.74.tgz#37367a1e8bafda3548037a91449a69a84f285def"
@@ -4958,6 +4974,15 @@
     uuid "^10.0.0"
     zod "^3.23.8"
 
+"@langchain/langgraph@^1.0.1":
+  version "1.0.1"
+  resolved "https://registry.npmjs.org/@langchain/langgraph/-/langgraph-1.0.1.tgz#d0be714653e8a27665f86ea795c5c34189455406"
+  integrity sha512-7y8OTDLrHrpJ55Y5x7c7zU2BbqNllXwxM106Xrd+NaQB5CpEb4hbUfIwe4XmhhscKPwvhXAq3tjeUxw9MCiurQ==
+  dependencies:
+    "@langchain/langgraph-checkpoint" "^1.0.0"
+    "@langchain/langgraph-sdk" "~1.0.0"
+    uuid "^10.0.0"
+
 "@leichtgewicht/ip-codec@^2.0.1":
   version "2.0.4"
   resolved "https://registry.yarnpkg.com/@leichtgewicht/ip-codec/-/ip-codec-2.0.4.tgz#b2ac626d6cb9c8718ab459166d4bb405b8ffa78b"
@@ -28530,7 +28555,7 @@ string-template@~0.2.1:
 
 [email protected], "string-width@^1.0.2 || 2 || 3 || 4", string-width@^4.1.0, string-width@^4.2.0, string-width@^4.2.3:
   version "4.2.3"
-  resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010"
+  resolved "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010"
   integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==
   dependencies:
     emoji-regex "^8.0.0"
@@ -28640,7 +28665,7 @@ stringify-object@^3.2.1:
 
 [email protected], strip-ansi@^6.0.0, strip-ansi@^6.0.1:
   version "6.0.1"
-  resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9"
+  resolved "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9"
   integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==
   dependencies:
     ansi-regex "^5.0.1"
@@ -31635,7 +31660,7 @@ [email protected]:
 
 [email protected], wrap-ansi@^7.0.0:
   version "7.0.0"
-  resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43"
+  resolved "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43"
   integrity sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==
   dependencies:
     ansi-styles "^4.0.0"