Skip to content

fix(langchain): Set agent name as gen_ai.agent.name for chat and tool spans #5877

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

Open
alexander-alderman-webb wants to merge 9 commits into
base: master
Choose a base branch
from
+54 −92
Open

fix(langchain): Set agent name as gen_ai.agent.name for chat and tool spans #5877

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d4c4cd4
fix(langchain): Set agent name as gen_ai.agent.name
alexander-alderman-webb Mar 25, 2026
181d5cb
merge master
alexander-alderman-webb Mar 31, 2026
8cf3f81
typing
alexander-alderman-webb Mar 31, 2026
56ec48f
fix span description
alexander-alderman-webb Mar 31, 2026
d8c06f8
defensive check
alexander-alderman-webb Mar 31, 2026
36ca817
no agent name in stream
alexander-alderman-webb Mar 31, 2026
0d43616
simplify
alexander-alderman-webb Mar 31, 2026
b9387b8
set run name
alexander-alderman-webb Apr 1, 2026
cf70d07
Merge branch 'master' into webb/langchain/agent-name
alexander-alderman-webb Apr 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
154 changes: 60 additions & 94 deletions sentry_sdk/integrations/langchain.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import contextvars
import itertools
import sys
import json
Expand Down Expand Up @@ -162,44 +161,6 @@
return content


# Contextvar to track agent names in a stack for re-entrant agent support
_agent_stack: "contextvars.ContextVar[Optional[List[Optional[str]]]]" = (
contextvars.ContextVar("langchain_agent_stack", default=None)
)


def _push_agent(agent_name: "Optional[str]") -> None:
Copy link
Copy Markdown
Member

@ericapisani ericapisani Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice to be getting rid of this code 🔥

"""Push an agent name onto the stack."""
stack = _agent_stack.get()
if stack is None:
stack = []
else:
# Copy the list to maintain contextvar isolation across async contexts
stack = stack.copy()
stack.append(agent_name)
_agent_stack.set(stack)


def _pop_agent() -> "Optional[str]":
"""Pop an agent name from the stack and return it."""
stack = _agent_stack.get()
if stack:
# Copy the list to maintain contextvar isolation across async contexts
stack = stack.copy()
agent_name = stack.pop()
_agent_stack.set(stack)
return agent_name
return None


def _get_current_agent() -> "Optional[str]":
"""Get the current agent name (top of stack) without removing it."""
stack = _agent_stack.get()
if stack:
return stack[-1]
return None


def _get_system_instructions(messages: "List[List[BaseMessage]]") -> "List[str]":
system_instructions = []

Expand Down Expand Up @@ -465,8 +426,8 @@
if ai_system:
span.set_data(SPANDATA.GEN_AI_SYSTEM, ai_system)

agent_name = _get_current_agent()
if agent_name:
agent_name = kwargs.get("metadata", {}).get("lc_agent_name")

Check warning on line 429 in sentry_sdk/integrations/langchain.py

View check run for this annotation

@sentry/warden / warden: find-bugs

AttributeError when metadata is explicitly None 

The expression `kwargs.get("metadata", {}).get("lc_agent_name")` will raise `AttributeError` if `metadata` is explicitly passed as `None`. The default value `{}` only applies when the key is absent, not when it's present with value `None`. While this is caught by `capture_internal_exceptions()`, it causes the entire callback body to exit early, skipping subsequent span data setup for `DATA_FIELDS`, tools, and request messages.
if agent_name is not None:
span.set_data(SPANDATA.GEN_AI_AGENT_NAME, agent_name)

for key, attribute in DATA_FIELDS.items():
Expand Down Expand Up @@ -665,8 +626,8 @@
if tool_description is not None:
span.set_data(SPANDATA.GEN_AI_TOOL_DESCRIPTION, tool_description)

agent_name = _get_current_agent()
if agent_name:
agent_name = kwargs.get("metadata", {}).get("lc_agent_name")
if agent_name is not None:
span.set_data(SPANDATA.GEN_AI_AGENT_NAME, agent_name)

if should_send_default_pii() and self.include_prompts:
Expand Down Expand Up @@ -793,9 +754,7 @@
span.set_data(SPANDATA.GEN_AI_USAGE_TOTAL_TOKENS, total_tokens)


def _get_request_data(
obj: "Any", args: "Any", kwargs: "Any"
) -> "tuple[Optional[str], Optional[List[Any]]]":
def _get_available_tools(obj: "Any") -> "tuple[Optional[str], Optional[List[Any]]]":

Check warning on line 757 in sentry_sdk/integrations/langchain.py

View check run for this annotation

@sentry/warden / warden: find-bugs

Incorrect return type annotation in _get_available_tools 

The function `_get_available_tools` has an incorrect return type annotation. It declares `-> "tuple[Optional[str], Optional[List[Any]]]"` (tuple of agent name and tools), but the function only returns `tools` (a single value). This was likely leftover from when the original `_get_request_data` function returned both values. Type checkers will report false errors when callers correctly use this function's return value as a non-tuple.
"""
Get the agent name and available tools for the agent.
"""
Expand All @@ -810,6 +769,13 @@
)
tools = tools if tools and len(tools) > 0 else None

return tools


def _get_run_name(obj: "Any", args: "Any"):
agent = getattr(obj, "agent", None)
runnable = getattr(agent, "runnable", None)
runnable_config = getattr(runnable, "config", {})
try:
agent_name = None
if len(args) > 1:
Expand All @@ -819,7 +785,7 @@
except Exception:
pass

return (agent_name, tools)
return agent_name


def _simplify_langchain_tools(tools: "Any") -> "Optional[List[Any]]":
Expand Down Expand Up @@ -987,58 +953,53 @@
if integration is None:
return f(self, *args, **kwargs)

agent_name, tools = _get_request_data(self, args, kwargs)
start_span_function = get_start_span_function()

run_name = _get_run_name(self, args)
with start_span_function(
op=OP.GEN_AI_INVOKE_AGENT,
name=f"invoke_agent {agent_name}" if agent_name else "invoke_agent",
name=run_name,

Check warning on line 960 in sentry_sdk/integrations/langchain.py

View check run for this annotation

@sentry/warden / warden: code-review

Span name can be None in new_invoke when run_name is not set 

In `new_invoke`, the span name is set directly to `run_name` (line 960), which can be `None` if no run_name is configured. The old code had a fallback: `f"invoke_agent {agent_name}" if agent_name else "invoke_agent"`. The `new_stream` function correctly handles this with a default `span_name = "invoke_agent"`, but `new_invoke` does not. This inconsistency could result in spans with `None` names, causing unexpected behavior or errors in Sentry's span processing.

Check warning on line 960 in sentry_sdk/integrations/langchain.py

View check run for this annotation

@sentry/warden / warden: find-bugs

[QGV-H7L] AttributeError when metadata is explicitly None (additional location) 

The expression `kwargs.get("metadata", {}).get("lc_agent_name")` will raise `AttributeError` if `metadata` is explicitly passed as `None`. The default value `{}` only applies when the key is absent, not when it's present with value `None`. While this is caught by `capture_internal_exceptions()`, it causes the entire callback body to exit early, skipping subsequent span data setup for `DATA_FIELDS`, tools, and request messages.
origin=LangchainIntegration.origin,
) as span:
_push_agent(agent_name)
try:
if agent_name:
span.set_data(SPANDATA.GEN_AI_AGENT_NAME, agent_name)
if run_name:
span.set_data(SPANDATA.GEN_AI_AGENT_NAME, run_name)

span.set_data(SPANDATA.GEN_AI_OPERATION_NAME, "invoke_agent")
span.set_data(SPANDATA.GEN_AI_RESPONSE_STREAMING, False)
span.set_data(SPANDATA.GEN_AI_OPERATION_NAME, "invoke_agent")
span.set_data(SPANDATA.GEN_AI_RESPONSE_STREAMING, False)

_set_tools_on_span(span, tools)
tools = _get_available_tools(self)
_set_tools_on_span(span, tools)

# Run the agent
result = f(self, *args, **kwargs)
# Run the agent
result = f(self, *args, **kwargs)

input = result.get("input")
if (
input is not None
and should_send_default_pii()
and integration.include_prompts
):
normalized_messages = normalize_message_roles([input])
scope = sentry_sdk.get_current_scope()
messages_data = truncate_and_annotate_messages(
normalized_messages, span, scope
input = result.get("input")
if (
input is not None
and should_send_default_pii()
and integration.include_prompts
):
normalized_messages = normalize_message_roles([input])
scope = sentry_sdk.get_current_scope()
messages_data = truncate_and_annotate_messages(
normalized_messages, span, scope
)
if messages_data is not None:
set_data_normalized(
span,
SPANDATA.GEN_AI_REQUEST_MESSAGES,
messages_data,
unpack=False,
)
if messages_data is not None:
set_data_normalized(
span,
SPANDATA.GEN_AI_REQUEST_MESSAGES,
messages_data,
unpack=False,
)

output = result.get("output")
if (
output is not None
and should_send_default_pii()
and integration.include_prompts
):
set_data_normalized(span, SPANDATA.GEN_AI_RESPONSE_TEXT, output)
output = result.get("output")
if (
output is not None
and should_send_default_pii()
and integration.include_prompts
):
set_data_normalized(span, SPANDATA.GEN_AI_RESPONSE_TEXT, output)

return result
finally:
# Ensure agent is popped even if an exception occurs
_pop_agent()
return result

return new_invoke

Expand All @@ -1050,24 +1011,31 @@
if integration is None:
return f(self, *args, **kwargs)

agent_name, tools = _get_request_data(self, args, kwargs)
start_span_function = get_start_span_function()

agent_name = kwargs.get("metadata", {}).get("lc_agent_name")
run_name = _get_run_name(self, args)

span_name = "invoke_agent"
if agent_name is not None:
span_name = f"invoke_agent {agent_name}"
elif run_name:
span_name = f"invoke_agent {run_name}"

span = start_span_function(
op=OP.GEN_AI_INVOKE_AGENT,
name=f"invoke_agent {agent_name}" if agent_name else "invoke_agent",
name=span_name,
origin=LangchainIntegration.origin,
)
span.__enter__()

_push_agent(agent_name)

if agent_name:
if agent_name is not None:
span.set_data(SPANDATA.GEN_AI_AGENT_NAME, agent_name)

span.set_data(SPANDATA.GEN_AI_OPERATION_NAME, "invoke_agent")
span.set_data(SPANDATA.GEN_AI_RESPONSE_STREAMING, True)

tools = _get_available_tools(self)
_set_tools_on_span(span, tools)

input = args[0].get("input") if len(args) >= 1 else None
Expand Down Expand Up @@ -1117,7 +1085,6 @@
raise
finally:
# Ensure cleanup happens even if iterator is abandoned or fails
_pop_agent()
span.__exit__(*exc_info)

async def new_iterator_async() -> "AsyncIterator[Any]":
Expand All @@ -1143,7 +1110,6 @@
raise
finally:
# Ensure cleanup happens even if iterator is abandoned or fails
_pop_agent()
span.__exit__(*exc_info)

if str(type(result)) == "<class 'async_generator'>":
Expand Down
6 changes: 6 additions & 0 deletions tests/integrations/langchain/test_langchain.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,8 @@ def test_langchain_create_agent(
assert chat_spans[0]["origin"] == "auto.ai.langchain"

assert chat_spans[0]["data"]["gen_ai.system"] == "openai-chat"
assert chat_spans[0]["data"]["gen_ai.agent.name"] == "word_length_agent"

assert chat_spans[0]["data"]["gen_ai.usage.input_tokens"] == 10
assert chat_spans[0]["data"]["gen_ai.usage.output_tokens"] == 20
assert chat_spans[0]["data"]["gen_ai.usage.total_tokens"] == 30
Expand Down Expand Up @@ -415,6 +417,10 @@ def test_tool_execution_span(
assert chat_spans[1]["origin"] == "auto.ai.langchain"
assert tool_exec_span["origin"] == "auto.ai.langchain"

assert chat_spans[0]["data"]["gen_ai.agent.name"] == "word_length_agent"
assert chat_spans[1]["data"]["gen_ai.agent.name"] == "word_length_agent"
assert tool_exec_span["data"]["gen_ai.agent.name"] == "word_length_agent"

assert chat_spans[0]["data"]["gen_ai.usage.input_tokens"] == 142
assert chat_spans[0]["data"]["gen_ai.usage.output_tokens"] == 50
assert chat_spans[0]["data"]["gen_ai.usage.total_tokens"] == 192
Expand Down
Loading