Skip to content

chore: update spanKind and attributes for tokens #296

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
merged 2 commits into from
Jun 27, 2025
+22 −11
Merged

chore: update spanKind and attributes for tokens #296

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6fecdce
chore: update spanKind
poshinchen Jun 26, 2025
88a64a2
chore: added additional token semantic conventions
poshinchen Jun 27, 2025
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
22 changes: 13 additions & 9 deletions src/strands/telemetry/tracer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,6 @@ class Tracer:
When the OTEL_EXPORTER_OTLP_ENDPOINT environment variable is set, traces
are sent to the OTLP endpoint.
When the STRANDS_OTEL_ENABLE_CONSOLE_EXPORT environment variable is set,
traces are printed to the console.
"""

def __init__(
Expand All @@ -103,13 +100,15 @@ def _start_span(
span_name: str,
parent_span: Optional[Span] = None,
attributes: Optional[Dict[str, AttributeValue]] = None,
span_kind: trace_api.SpanKind = trace_api.SpanKind.INTERNAL,
) -> Optional[Span]:
"""Generic helper method to start a span with common attributes.
Args:
span_name: Name of the span to create
parent_span: Optional parent span to link this span to
attributes: Dictionary of attributes to set on the span
span_kind: enum of OptenTelemetry SpanKind
Returns:
The created span, or None if tracing is not enabled
Expand All @@ -118,7 +117,7 @@ def _start_span(
return None

context = trace_api.set_span_in_context(parent_span) if parent_span else None
span = self.tracer.start_span(name=span_name, context=context)
span = self.tracer.start_span(name=span_name, context=context, kind=span_kind)

# Set start time as a common attribute
span.set_attribute("gen_ai.event.start_time", datetime.now(timezone.utc).isoformat())
Expand Down Expand Up @@ -219,7 +218,7 @@ def start_model_invoke_span(
"""
attributes: Dict[str, AttributeValue] = {
"gen_ai.system": "strands-agents",
"agent.name": agent_name,
"gen_ai.operation.name": "chat",
"gen_ai.agent.name": agent_name,
"gen_ai.prompt": serialize(messages),
}
Expand All @@ -230,7 +229,7 @@ def start_model_invoke_span(
# Add additional kwargs as attributes
attributes.update({k: v for k, v in kwargs.items() if isinstance(v, (str, int, float, bool))})

return self._start_span("Model invoke", parent_span, attributes)
return self._start_span("Model invoke", parent_span, attributes, span_kind=trace_api.SpanKind.CLIENT)

def end_model_invoke_span(
self, span: Span, message: Message, usage: Usage, error: Optional[Exception] = None
Expand All @@ -246,7 +245,9 @@ def end_model_invoke_span(
attributes: Dict[str, AttributeValue] = {
"gen_ai.completion": serialize(message["content"]),
"gen_ai.usage.prompt_tokens": usage["inputTokens"],
"gen_ai.usage.input_tokens": usage["inputTokens"],
"gen_ai.usage.completion_tokens": usage["outputTokens"],
"gen_ai.usage.output_tokens": usage["outputTokens"],
"gen_ai.usage.total_tokens": usage["totalTokens"],
}

Expand All @@ -265,6 +266,7 @@ def start_tool_call_span(self, tool: ToolUse, parent_span: Optional[Span] = None
"""
attributes: Dict[str, AttributeValue] = {
"gen_ai.prompt": serialize(tool),
"gen_ai.system": "strands-agents",
"tool.name": tool["name"],
"tool.id": tool["toolUseId"],
"tool.parameters": serialize(tool["input"]),
Expand All @@ -274,7 +276,7 @@ def start_tool_call_span(self, tool: ToolUse, parent_span: Optional[Span] = None
attributes.update(kwargs)

span_name = f"Tool: {tool['name']}"
return self._start_span(span_name, parent_span, attributes)
return self._start_span(span_name, parent_span, attributes, span_kind=trace_api.SpanKind.INTERNAL)

def end_tool_call_span(
self, span: Span, tool_result: Optional[ToolResult], error: Optional[Exception] = None
Expand Down Expand Up @@ -335,7 +337,7 @@ def start_event_loop_cycle_span(
attributes.update({k: v for k, v in kwargs.items() if isinstance(v, (str, int, float, bool))})

span_name = f"Cycle {event_loop_cycle_id}"
return self._start_span(span_name, parent_span, attributes)
return self._start_span(span_name, parent_span, attributes, span_kind=trace_api.SpanKind.INTERNAL)

def end_event_loop_cycle_span(
self,
Expand Down Expand Up @@ -405,7 +407,7 @@ def start_agent_span(
# Add additional kwargs as attributes
attributes.update({k: v for k, v in kwargs.items() if isinstance(v, (str, int, float, bool))})

return self._start_span(agent_name, attributes=attributes)
return self._start_span(agent_name, attributes=attributes, span_kind=trace_api.SpanKind.CLIENT)

def end_agent_span(
self,
Expand Down Expand Up @@ -436,6 +438,8 @@ def end_agent_span(
{
"gen_ai.usage.prompt_tokens": accumulated_usage["inputTokens"],
"gen_ai.usage.completion_tokens": accumulated_usage["outputTokens"],
"gen_ai.usage.input_tokens": accumulated_usage["inputTokens"],
"gen_ai.usage.output_tokens": accumulated_usage["outputTokens"],
"gen_ai.usage.total_tokens": accumulated_usage["totalTokens"],
}
)
Expand Down
11 changes: 9 additions & 2 deletions tests/strands/telemetry/test_tracer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

import pytest
from opentelemetry.trace import (
SpanKind,
StatusCode, # type: ignore
)

Expand Down Expand Up @@ -75,7 +76,7 @@ def test_start_span(mock_tracer):

span = tracer._start_span("test_span", attributes={"key": "value"})

mock_tracer.start_span.assert_called_once_with(name="test_span", context=None)
mock_tracer.start_span.assert_called_once_with(name="test_span", context=None, kind=SpanKind.INTERNAL)
mock_span.set_attribute.assert_any_call("key", "value")
assert span is not None

Expand Down Expand Up @@ -151,8 +152,10 @@ def test_start_model_invoke_span(mock_tracer):

mock_tracer.start_span.assert_called_once()
assert mock_tracer.start_span.call_args[1]["name"] == "Model invoke"
assert mock_tracer.start_span.call_args[1]["kind"] == SpanKind.CLIENT
mock_span.set_attribute.assert_any_call("gen_ai.system", "strands-agents")
mock_span.set_attribute.assert_any_call("agent.name", "TestAgent")
mock_span.set_attribute.assert_any_call("gen_ai.operation.name", "chat")
mock_span.set_attribute.assert_any_call("gen_ai.agent.name", "TestAgent")
mock_span.set_attribute.assert_any_call("gen_ai.request.model", model_id)
assert span is not None

Expand All @@ -167,7 +170,9 @@ def test_end_model_invoke_span(mock_span):

mock_span.set_attribute.assert_any_call("gen_ai.completion", json.dumps(message["content"]))
mock_span.set_attribute.assert_any_call("gen_ai.usage.prompt_tokens", 10)
mock_span.set_attribute.assert_any_call("gen_ai.usage.input_tokens", 10)
mock_span.set_attribute.assert_any_call("gen_ai.usage.completion_tokens", 20)
mock_span.set_attribute.assert_any_call("gen_ai.usage.output_tokens", 20)
mock_span.set_attribute.assert_any_call("gen_ai.usage.total_tokens", 30)
mock_span.set_status.assert_called_once_with(StatusCode.OK)
mock_span.end.assert_called_once()
Expand Down Expand Up @@ -294,7 +299,9 @@ def test_end_agent_span(mock_span):

mock_span.set_attribute.assert_any_call("gen_ai.completion", "Agent response")
mock_span.set_attribute.assert_any_call("gen_ai.usage.prompt_tokens", 50)
mock_span.set_attribute.assert_any_call("gen_ai.usage.input_tokens", 50)
mock_span.set_attribute.assert_any_call("gen_ai.usage.completion_tokens", 100)
mock_span.set_attribute.assert_any_call("gen_ai.usage.output_tokens", 100)
mock_span.set_attribute.assert_any_call("gen_ai.usage.total_tokens", 150)
mock_span.set_status.assert_called_once_with(StatusCode.OK)
mock_span.end.assert_called_once()
Expand Down