-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
feat(core): Instrument LangGraph Agent #18114
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.
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
Open
RulaKhaled
wants to merge
1
commit into
develop
Choose a base branch
from
instrument-langgrapgh-in-node
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+958
−1
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 changes: 10 additions & 0 deletions
10
dev-packages/node-integration-tests/suites/tracing/langgraph/instrument-with-pii.mjs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| import * as Sentry from '@sentry/node'; | ||
| import { loggingTransport } from '@sentry-internal/node-integration-tests'; | ||
|
|
||
| Sentry.init({ | ||
| dsn: 'https://[email protected]/1337', | ||
| release: '1.0', | ||
| tracesSampleRate: 1.0, | ||
| sendDefaultPii: true, | ||
| transport: loggingTransport, | ||
| }); |
10 changes: 10 additions & 0 deletions
10
dev-packages/node-integration-tests/suites/tracing/langgraph/instrument.mjs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| import * as Sentry from '@sentry/node'; | ||
| import { loggingTransport } from '@sentry-internal/node-integration-tests'; | ||
|
|
||
| Sentry.init({ | ||
| dsn: 'https://[email protected]/1337', | ||
| release: '1.0', | ||
| tracesSampleRate: 1.0, | ||
| sendDefaultPii: false, | ||
| transport: loggingTransport, | ||
| }); |
92 changes: 92 additions & 0 deletions
92
dev-packages/node-integration-tests/suites/tracing/langgraph/scenario-tools.mjs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| import { tool } from '@langchain/core/tools'; | ||
| import { END, MessagesAnnotation, START, StateGraph } from '@langchain/langgraph'; | ||
| import { ToolNode } from '@langchain/langgraph/prebuilt'; | ||
| import * as Sentry from '@sentry/node'; | ||
| import { z } from 'zod'; | ||
|
|
||
| async function run() { | ||
| await Sentry.startSpan({ op: 'function', name: 'langgraph-tools-test' }, async () => { | ||
| // Define tools | ||
| const getWeatherTool = tool( | ||
| async ({ city }) => { | ||
| return JSON.stringify({ city, temperature: 72, condition: 'sunny' }); | ||
| }, | ||
| { | ||
| name: 'get_weather', | ||
| description: 'Get the current weather for a given city', | ||
| schema: z.object({ | ||
| city: z.string().describe('The city to get weather for'), | ||
| }), | ||
| }, | ||
| ); | ||
|
|
||
| const getTimeTool = tool( | ||
| async () => { | ||
| return new Date().toISOString(); | ||
| }, | ||
| { | ||
| name: 'get_time', | ||
| description: 'Get the current time', | ||
| schema: z.object({}), | ||
| }, | ||
| ); | ||
|
|
||
| const tools = [getWeatherTool, getTimeTool]; | ||
| const toolNode = new ToolNode(tools); | ||
|
|
||
| // Define mock LLM function that returns without tool calls | ||
| const mockLlm = () => { | ||
| return { | ||
| messages: [ | ||
| { | ||
| role: 'assistant', | ||
| content: 'Response without calling tools', | ||
| response_metadata: { | ||
| model_name: 'gpt-4-0613', | ||
| finish_reason: 'stop', | ||
| tokenUsage: { | ||
| promptTokens: 25, | ||
| completionTokens: 15, | ||
| totalTokens: 40, | ||
| }, | ||
| }, | ||
| tool_calls: [], | ||
| }, | ||
| ], | ||
| }; | ||
| }; | ||
|
|
||
| // Routing function - check if there are tool calls | ||
| const shouldContinue = state => { | ||
| const messages = state.messages; | ||
| const lastMessage = messages[messages.length - 1]; | ||
|
|
||
| // If the last message has tool_calls, route to tools, otherwise end | ||
| if (lastMessage.tool_calls && lastMessage.tool_calls.length > 0) { | ||
| return 'tools'; | ||
| } | ||
| return END; | ||
| }; | ||
|
|
||
| // Create graph with conditional edge to tools | ||
| const graph = new StateGraph(MessagesAnnotation) | ||
| .addNode('agent', mockLlm) | ||
| .addNode('tools', toolNode) | ||
| .addEdge(START, 'agent') | ||
| .addConditionalEdges('agent', shouldContinue, { | ||
| tools: 'tools', | ||
| [END]: END, | ||
| }) | ||
| .addEdge('tools', 'agent') | ||
| .compile({ name: 'tool_agent' }); | ||
|
|
||
| // Simple invocation - won't call tools since mockLlm returns empty tool_calls | ||
| await graph.invoke({ | ||
| messages: [{ role: 'user', content: 'What is the weather?' }], | ||
| }); | ||
| }); | ||
|
|
||
| await Sentry.flush(2000); | ||
| } | ||
|
|
||
| run(); | ||
52 changes: 52 additions & 0 deletions
52
dev-packages/node-integration-tests/suites/tracing/langgraph/scenario.mjs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| import { END, MessagesAnnotation, START, StateGraph } from '@langchain/langgraph'; | ||
| import * as Sentry from '@sentry/node'; | ||
|
|
||
| async function run() { | ||
| await Sentry.startSpan({ op: 'function', name: 'langgraph-test' }, async () => { | ||
| // Define a simple mock LLM function | ||
| const mockLlm = () => { | ||
| return { | ||
| messages: [ | ||
| { | ||
| role: 'assistant', | ||
| content: 'Mock LLM response', | ||
| response_metadata: { | ||
| model_name: 'mock-model', | ||
| finish_reason: 'stop', | ||
| tokenUsage: { | ||
| promptTokens: 20, | ||
| completionTokens: 10, | ||
| totalTokens: 30, | ||
| }, | ||
| }, | ||
| }, | ||
| ], | ||
| }; | ||
| }; | ||
|
|
||
| // Create and compile the graph | ||
| const graph = new StateGraph(MessagesAnnotation) | ||
| .addNode('agent', mockLlm) | ||
| .addEdge(START, 'agent') | ||
| .addEdge('agent', END) | ||
| .compile({ name: 'weather_assistant' }); | ||
|
|
||
| // Test: basic invocation | ||
| await graph.invoke({ | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. l: Does this always follow this list-of-dicts format or can we also input a plain string? If so, might be worth covering this in a test as well |
||
| messages: [{ role: 'user', content: 'What is the weather today?' }], | ||
| }); | ||
|
|
||
| // Test: invocation with multiple messages | ||
| await graph.invoke({ | ||
| messages: [ | ||
| { role: 'user', content: 'Hello' }, | ||
| { role: 'assistant', content: 'Hi there!' }, | ||
| { role: 'user', content: 'Tell me about the weather' }, | ||
| ], | ||
| }); | ||
| }); | ||
|
|
||
| await Sentry.flush(2000); | ||
| } | ||
|
|
||
| run(); | ||
171 changes: 171 additions & 0 deletions
171
dev-packages/node-integration-tests/suites/tracing/langgraph/test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,171 @@ | ||
| import { afterAll, describe, expect } from 'vitest'; | ||
| import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner'; | ||
|
|
||
| describe('LangGraph integration', () => { | ||
| afterAll(() => { | ||
| cleanupChildProcesses(); | ||
| }); | ||
|
|
||
| const EXPECTED_TRANSACTION_DEFAULT_PII_FALSE = { | ||
| transaction: 'langgraph-test', | ||
| spans: expect.arrayContaining([ | ||
| // create_agent span | ||
| expect.objectContaining({ | ||
| 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', | ||
| status: 'ok', | ||
| }), | ||
| // First invoke_agent span | ||
| expect.objectContaining({ | ||
| 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', | ||
| }), | ||
| description: 'invoke_agent weather_assistant', | ||
| op: 'gen_ai.invoke_agent', | ||
| origin: 'auto.ai.langgraph', | ||
| status: 'ok', | ||
| }), | ||
| // Second invoke_agent span | ||
| expect.objectContaining({ | ||
| 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', | ||
| }), | ||
| description: 'invoke_agent weather_assistant', | ||
| op: 'gen_ai.invoke_agent', | ||
| origin: 'auto.ai.langgraph', | ||
| status: 'ok', | ||
| }), | ||
| ]), | ||
| }; | ||
|
|
||
| const EXPECTED_TRANSACTION_DEFAULT_PII_TRUE = { | ||
| transaction: 'langgraph-test', | ||
| spans: expect.arrayContaining([ | ||
| // create_agent span (PII enabled doesn't affect this span) | ||
| expect.objectContaining({ | ||
| 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', | ||
| status: 'ok', | ||
| }), | ||
| // First invoke_agent span with PII | ||
| expect.objectContaining({ | ||
| 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': expect.stringContaining('What is the weather today?'), | ||
| }), | ||
| description: 'invoke_agent weather_assistant', | ||
| op: 'gen_ai.invoke_agent', | ||
| origin: 'auto.ai.langgraph', | ||
| status: 'ok', | ||
| }), | ||
| // Second invoke_agent span with PII and multiple messages | ||
| expect.objectContaining({ | ||
| 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': expect.stringContaining('Tell me about the weather'), | ||
| }), | ||
| description: 'invoke_agent weather_assistant', | ||
| op: 'gen_ai.invoke_agent', | ||
| origin: 'auto.ai.langgraph', | ||
| status: 'ok', | ||
| }), | ||
| ]), | ||
| }; | ||
|
|
||
| const EXPECTED_TRANSACTION_WITH_TOOLS = { | ||
| transaction: 'langgraph-tools-test', | ||
| spans: expect.arrayContaining([ | ||
| // create_agent span | ||
| expect.objectContaining({ | ||
| data: { | ||
| 'gen_ai.operation.name': 'create_agent', | ||
| 'sentry.op': 'gen_ai.create_agent', | ||
| 'sentry.origin': 'auto.ai.langgraph', | ||
| 'gen_ai.agent.name': 'tool_agent', | ||
| }, | ||
| description: 'create_agent tool_agent', | ||
| op: 'gen_ai.create_agent', | ||
| origin: 'auto.ai.langgraph', | ||
| status: 'ok', | ||
| }), | ||
| // invoke_agent span with tools | ||
| expect.objectContaining({ | ||
| data: expect.objectContaining({ | ||
| 'gen_ai.operation.name': 'invoke_agent', | ||
| 'sentry.op': 'gen_ai.invoke_agent', | ||
| 'sentry.origin': 'auto.ai.langgraph', | ||
| 'gen_ai.agent.name': 'tool_agent', | ||
| 'gen_ai.pipeline.name': 'tool_agent', | ||
| 'gen_ai.request.available_tools': expect.stringContaining('get_weather'), | ||
| 'gen_ai.request.messages': expect.stringContaining('What is the weather?'), | ||
| 'gen_ai.response.model': 'gpt-4-0613', | ||
| 'gen_ai.response.finish_reasons': ['stop'], | ||
| 'gen_ai.response.text': expect.stringContaining('Response without calling tools'), | ||
| 'gen_ai.usage.input_tokens': 25, | ||
| 'gen_ai.usage.output_tokens': 15, | ||
| 'gen_ai.usage.total_tokens': 40, | ||
| }), | ||
| description: 'invoke_agent tool_agent', | ||
| op: 'gen_ai.invoke_agent', | ||
| origin: 'auto.ai.langgraph', | ||
| status: 'ok', | ||
| }), | ||
| ]), | ||
| }; | ||
|
|
||
| createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createRunner, test) => { | ||
| test('should instrument LangGraph with default PII settings', async () => { | ||
| await createRunner() | ||
| .ignore('event') | ||
| .expect({ transaction: EXPECTED_TRANSACTION_DEFAULT_PII_FALSE }) | ||
| .start() | ||
| .completed(); | ||
| }); | ||
| }); | ||
|
|
||
| createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument-with-pii.mjs', (createRunner, test) => { | ||
| test('should instrument LangGraph with sendDefaultPii: true', async () => { | ||
| await createRunner() | ||
| .ignore('event') | ||
| .expect({ transaction: EXPECTED_TRANSACTION_DEFAULT_PII_TRUE }) | ||
| .start() | ||
| .completed(); | ||
| }); | ||
| }); | ||
|
|
||
| createEsmAndCjsTests(__dirname, 'scenario-tools.mjs', 'instrument-with-pii.mjs', (createRunner, test) => { | ||
| test('should capture tools from LangGraph agent', { timeout: 30000 }, async () => { | ||
| await createRunner().ignore('event').expect({ transaction: EXPECTED_TRANSACTION_WITH_TOOLS }).start().completed(); | ||
| }); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| export const LANGGRAPH_INTEGRATION_NAME = 'LangGraph'; | ||
| export const LANGGRAPH_ORIGIN = 'auto.ai.langgraph'; |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
m: I think it would be good to also add the scenario where tools are being called and then check that the tools are correctly recorded in gen_ai.response.tool_calls