fix(telemetry): replace TypeErrors with <replaced> string placeholder (#13)

Author: awsarron

src/strands/telemetry/tracer.py

@@ -27,6 +27,26 @@
 logger = logging.getLogger(__name__)
 
 
+class JSONEncoder(json.JSONEncoder):
+    """Custom JSON encoder that handles non-serializable types."""
+
+    def default(self, obj: Any) -> Any:
+        """Handle non-serializable types.
+
+        Args:
+            obj: The object to serialize
+
+        Returns:
+            A JSON serializable version of the object
+        """
+        value = ""
+        try:
+            value = super().default(obj)
+        except TypeError:
+            value = "<replaced>"
+        return value
+
+
 class Tracer:
     """Handles OpenTelemetry tracing.
 
@@ -267,7 +287,7 @@ def start_model_invoke_span(
             "gen_ai.system": "strands-agents",
             "agent.name": agent_name,
             "gen_ai.agent.name": agent_name,
-            "gen_ai.prompt": json.dumps(messages),
+            "gen_ai.prompt": json.dumps(messages, cls=JSONEncoder),
         }
 
         if model_id:
@@ -290,7 +310,7 @@ def end_model_invoke_span(
             error: Optional exception if the model call failed.
         """
         attributes: Dict[str, AttributeValue] = {
-            "gen_ai.completion": json.dumps(message["content"]),
+            "gen_ai.completion": json.dumps(message["content"], cls=JSONEncoder),
             "gen_ai.usage.prompt_tokens": usage["inputTokens"],
             "gen_ai.usage.completion_tokens": usage["outputTokens"],
             "gen_ai.usage.total_tokens": usage["totalTokens"],
@@ -314,7 +334,7 @@ def start_tool_call_span(
         attributes: Dict[str, AttributeValue] = {
             "tool.name": tool["name"],
             "tool.id": tool["toolUseId"],
-            "tool.parameters": json.dumps(tool["input"]),
+            "tool.parameters": json.dumps(tool["input"], cls=JSONEncoder),
         }
 
         # Add additional kwargs as attributes
@@ -340,8 +360,8 @@ def end_tool_call_span(
 
             attributes.update(
                 {
-                    "tool.result": json.dumps(tool_result.get("content")),
-                    "gen_ai.completion": json.dumps(tool_result.get("content")),
+                    "tool.result": json.dumps(tool_result.get("content"), cls=JSONEncoder),
+                    "gen_ai.completion": json.dumps(tool_result.get("content"), cls=JSONEncoder),
                     "tool.status": status_str,
                 }
             )
@@ -370,7 +390,7 @@ def start_event_loop_cycle_span(
         parent_span = parent_span if parent_span else event_loop_kwargs.get("event_loop_parent_span")
 
         attributes: Dict[str, AttributeValue] = {
-            "gen_ai.prompt": json.dumps(messages),
+            "gen_ai.prompt": json.dumps(messages, cls=JSONEncoder),
             "event_loop.cycle_id": event_loop_cycle_id,
         }
 
@@ -399,11 +419,11 @@ def end_event_loop_cycle_span(
             error: Optional exception if the cycle failed.
         """
         attributes: Dict[str, AttributeValue] = {
-            "gen_ai.completion": json.dumps(message["content"]),
+            "gen_ai.completion": json.dumps(message["content"], cls=JSONEncoder),
         }
 
         if tool_result_message:
-            attributes["tool.result"] = json.dumps(tool_result_message["content"])
+            attributes["tool.result"] = json.dumps(tool_result_message["content"], cls=JSONEncoder)
 
         self._end_span(span, attributes, error)
 
@@ -440,7 +460,7 @@ def start_agent_span(
             attributes["gen_ai.request.model"] = model_id
 
         if tools:
-            tools_json = tools
+            tools_json = json.dumps(tools, cls=JSONEncoder)
             attributes["agent.tools"] = tools_json
             attributes["gen_ai.agent.tools"] = tools_json
 
@@ -472,7 +492,7 @@ def end_agent_span(
         if response:
             attributes.update(
                 {
-                    "gen_ai.completion": str(response),
+                    "gen_ai.completion": json.dumps(response, cls=JSONEncoder),
                 }
             )
 

tests/strands/telemetry/test_tracer.py

@@ -369,7 +369,7 @@ def test_end_agent_span(mock_span):
 
     tracer.end_agent_span(mock_span, mock_response)
 
-    mock_span.set_attribute.assert_any_call("gen_ai.completion", "Agent response")
+    mock_span.set_attribute.assert_any_call("gen_ai.completion", '"<replaced>"')
     mock_span.set_attribute.assert_any_call("gen_ai.usage.prompt_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.total_tokens", 150)