opentelementry-instrumentation-google-genai: add gen_ai.tool.definitions to experimental semconv

instrumentation-genai/opentelemetry-instrumentation-google-genai/src/opentelemetry/instrumentation/google_genai/generate_content.py

@@ -42,6 +42,8 @@
     GenerateContentConfig,
     GenerateContentConfigOrDict,
     GenerateContentResponse,
+    ToolListUnionDict,
+    ToolUnionDict,
 )
 
 from opentelemetry import context as context_api
@@ -185,6 +187,35 @@ def _to_dict(value: object):
     return json.loads(json.dumps(value))
 
 
+def _to_tool_definition(tool: ToolUnionDict) -> MessagePart:
+    if isinstance(tool, dict):
+        return tool
+    if hasattr(tool, "to_json_dict"):
+        try:
+            return tool.to_json_dict()
+        except TypeError:
+            pass
+    if hasattr(tool, "model_dump"):
+        try:
+            return tool.model_dump(exclude_none=True)
+        except TypeError:
+            pass
+    if callable(tool) and hasattr(tool, "__name__"):
+        doc = getattr(tool, "__doc__", "") or ""
+        return {
+            "function": {
+                "name": getattr(tool, "__name__", str(type(tool))),
+                "description": doc.strip(),
+            }
+        }
+    try:
+        return {"value": str(tool)}
+    except Exception:
+        return {
+            "error": f"failed to serialize tool definition, tool type={type(tool).__name__}"
+        }
+
+
 def _create_request_attributes(
     config: Optional[GenerateContentConfigOrDict],
     allow_list: AllowList,
@@ -285,10 +316,22 @@ def _config_to_system_instruction(
     return config.system_instruction
 
 
+def _config_to_tools(
+    config: Union[GenerateContentConfigOrDict, None],
+) -> Union[ToolListUnionDict, None]:
+    if not config:
+        return None
+
+    if isinstance(config, dict):
+        return GenerateContentConfig.model_validate(config).tools
+    return config.tools
+
+
 def _create_completion_details_attributes(
     input_messages: list[InputMessage],
     output_messages: list[OutputMessage],
     system_instructions: list[MessagePart],
+    tool_definitions: list[MessagePart],
     as_str: bool = False,
 ) -> dict[str, AttributeValue]:
     attributes: dict[str, AttributeValue] = {
@@ -306,6 +349,11 @@ def _create_completion_details_attributes(
             dataclasses.asdict(sys_instr) for sys_instr in system_instructions
         ]
 
+    if tool_definitions:
+        attributes[gen_ai_attributes.GEN_AI_TOOL_DEFINITIONS] = (
+            tool_definitions
+        )
+
     return attributes
 
 
@@ -485,6 +533,10 @@ def _maybe_log_completion_details(
         )
         output_messages = to_output_messages(candidates=candidates)
 
+        tool_definitions = []
+        if tools := _config_to_tools(config):
+            tool_definitions = [_to_tool_definition(tool) for tool in tools]
+
         span = trace.get_current_span()
         event = LogRecord(
             event_name="gen_ai.client.inference.operation.details",
@@ -503,6 +555,7 @@ def _maybe_log_completion_details(
             input_messages,
             output_messages,
             system_instructions,
+            tool_definitions,
         )
         if self._content_recording_enabled in [
             ContentCapturingMode.EVENT_ONLY,

instrumentation-genai/opentelemetry-instrumentation-google-genai/tests/generate_content/nonstreaming_base.py

@@ -39,6 +39,11 @@
 # pylint: disable=too-many-public-methods
 
 
+def _some_tool():
+    """Description of some tool."""
+    return "result"
+
+
 class ExampleResponseSchema(BaseModel):
     name: str = Field(description="A Destination's Name")
 
@@ -359,6 +364,7 @@ def test_new_semconv_record_completion_as_log(self):
             content = "Some input"
             output = "Some response content"
             sys_instr = "System instruction"
+            tools = [_some_tool]
             with self.subTest(
                 f"mode: {mode}", patched_environ=patched_environ
             ):
@@ -371,6 +377,7 @@ def test_new_semconv_record_completion_as_log(self):
                         config=GenerateContentConfig(
                             system_instruction=sys_instr,
                             response_schema=ExampleResponseSchema,
+                            tools=tools,
                         ),
                     )
                     self.otel.assert_has_event_named(
@@ -401,6 +408,11 @@ def test_new_semconv_record_completion_as_log(self):
                             gen_ai_attributes.GEN_AI_SYSTEM_INSTRUCTIONS,
                             event.attributes,
                         )
+                        self.assertNotIn(
+                            gen_ai_attributes.GEN_AI_TOOL_DEFINITIONS,
+                            event.attributes,
+                        )
+
                     else:
                         expected_event_attributes = {
                             gen_ai_attributes.GEN_AI_INPUT_MESSAGES: (
@@ -423,6 +435,14 @@ def test_new_semconv_record_completion_as_log(self):
                             gen_ai_attributes.GEN_AI_SYSTEM_INSTRUCTIONS: (
                                 {"content": sys_instr, "type": "text"},
                             ),
+                            gen_ai_attributes.GEN_AI_TOOL_DEFINITIONS: (
+                                {
+                                    "function": {
+                                        "name": "_some_tool",
+                                        "description": "Description of some tool.",
+                                    }
+                                },
+                            ),
                         }
                         self.assertEqual(
                             event.attributes[
@@ -448,6 +468,14 @@ def test_new_semconv_record_completion_as_log(self):
                                 gen_ai_attributes.GEN_AI_SYSTEM_INSTRUCTIONS
                             ],
                         )
+                        self.assertEqual(
+                            event.attributes[
+                                gen_ai_attributes.GEN_AI_TOOL_DEFINITIONS
+                            ],
+                            expected_event_attributes[
+                                gen_ai_attributes.GEN_AI_TOOL_DEFINITIONS
+                            ],
+                        )
                 self.tearDown()
 
     def test_new_semconv_record_completion_in_span(self):
@@ -477,6 +505,7 @@ def test_new_semconv_record_completion_in_span(self):
                         config=GenerateContentConfig(
                             system_instruction="System instruction",
                             response_schema=ExampleResponseSchema,
+                            tools=[_some_tool],
                         ),
                     )
                     span = self.otel.get_span_named(
@@ -504,6 +533,12 @@ def test_new_semconv_record_completion_in_span(self):
                             ],
                             '[{"content":"System instruction","type":"text"}]',
                         )
+                        self.assertEqual(
+                            span.attributes[
+                                gen_ai_attributes.GEN_AI_TOOL_DEFINITIONS
+                            ],
+                            '[{"function":{"name":"_some_tool","description":"Description of some tool."}}]',
+                        )
                     else:
                         self.assertNotIn(
                             gen_ai_attributes.GEN_AI_INPUT_MESSAGES,
@@ -517,6 +552,10 @@ def test_new_semconv_record_completion_in_span(self):
                             gen_ai_attributes.GEN_AI_SYSTEM_INSTRUCTIONS,
                             span.attributes,
                         )
+                        self.assertNotIn(
+                            gen_ai_attributes.GEN_AI_TOOL_DEFINITIONS,
+                            span.attributes,
+                        )
 
                 self.tearDown()