Update to record function details only on the span.

Author: michaelsafyan

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

@@ -16,37 +16,3 @@
 # Semantic Convention still being defined in:
 # https://github.com/open-telemetry/semantic-conventions/pull/2125
 GCP_GENAI_OPERATION_CONFIG = "gcp.gen_ai.operation.config"
-
-
-# Semantic Convention to be defined.
-# https://github.com/open-telemetry/semantic-conventions/issues/2183
-TOOL_CALL_POSITIONAL_ARG_COUNT = "gen_ai.tool.positional_args.count"
-
-
-# Semantic Convention to be defined.
-# https://github.com/open-telemetry/semantic-conventions/issues/2183
-TOOL_CALL_KEYWORD_ARG_COUNT = "gen_ai.tool.keyword_args.count"
-
-
-# Semantic Convention to be defined.
-# https://github.com/open-telemetry/semantic-conventions/issues/2185
-FUNCTION_TOOL_CALL_START_EVENT_NAME = "function_call.start"
-FUNCTION_TOOL_CALL_START_EVENT_ATTRS_POSITIONAL_ARGS_COUNT = (
-    "positional_argument_count"
-)
-FUNCTION_TOOL_CALL_START_EVENT_ATTRS_KEYWORD_ARGS_COUNT = (
-    "keyword_argument_count"
-)
-FUNCTION_TOOL_CALL_START_EVENT_BODY_POSITIONAL_ARGS = "positional_arguments"
-FUNCTION_TOOL_CALL_START_EVENT_BODY_KEYWORD_ARGS = "keyword_arguments"
-
-
-# Semantic Convention to be defined.
-# https://github.com/open-telemetry/semantic-conventions/issues/2185
-FUNCTION_TOOL_CALL_END_EVENT_NAME = "function_call.end"
-FUNCTION_TOOL_CALL_END_EVENT_BODY_RESULT = "result"
-
-
-# Semantic Convention to be defined.
-# https://github.com/open-telemetry/semantic-conventions/issues/2184
-CODE_MODULE = "code.module"

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

@@ -20,10 +20,6 @@
 from opentelemetry.semconv._incubating.metrics import gen_ai_metrics
 from opentelemetry.semconv.schemas import Schemas
 
-from .custom_semconv import (
-    FUNCTION_TOOL_CALL_END_EVENT_NAME,
-    FUNCTION_TOOL_CALL_START_EVENT_NAME,
-)
 from .version import __version__ as _LIBRARY_VERSION
 
 _logger = logging.getLogger(__name__)
@@ -91,16 +87,6 @@ def log_response_content(self, attributes, body):
         event_name = "gen_ai.choice"
         self._log_event(event_name, attributes, body)
 
-    def log_function_call_start(self, attributes, body):
-        _logger.debug("Recording function call start.")
-        event_name = FUNCTION_TOOL_CALL_START_EVENT_NAME
-        self._log_event(event_name, attributes, body)
-
-    def log_function_call_end(self, attributes, body):
-        _logger.debug("Recording function call end.")
-        event_name = FUNCTION_TOOL_CALL_END_EVENT_NAME
-        self._log_event(event_name, attributes, body)
-
     def _log_event(self, event_name, attributes, body):
         event = Event(event_name, body=body, attributes=attributes)
         self._event_logger.emit(event)

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

@@ -27,16 +27,6 @@
     code_attributes,
 )
 
-from .custom_semconv import (
-    CODE_MODULE,
-    FUNCTION_TOOL_CALL_END_EVENT_BODY_RESULT,
-    FUNCTION_TOOL_CALL_START_EVENT_ATTRS_KEYWORD_ARGS_COUNT,
-    FUNCTION_TOOL_CALL_START_EVENT_ATTRS_POSITIONAL_ARGS_COUNT,
-    FUNCTION_TOOL_CALL_START_EVENT_BODY_KEYWORD_ARGS,
-    FUNCTION_TOOL_CALL_START_EVENT_BODY_POSITIONAL_ARGS,
-    TOOL_CALL_KEYWORD_ARG_COUNT,
-    TOOL_CALL_POSITIONAL_ARG_COUNT,
-)
 from .flags import is_content_recording_enabled
 from .otel_wrapper import OTelWrapper
 
@@ -74,95 +64,48 @@ def _create_function_span_attributes(
     if extra_span_attributes:
         result.update(extra_span_attributes)
     result[code_attributes.CODE_FUNCTION_NAME] = wrapped_function.__name__
-    result[CODE_MODULE] = wrapped_function.__module__
-    result[TOOL_CALL_POSITIONAL_ARG_COUNT] = len(function_args)
-    result[TOOL_CALL_KEYWORD_ARG_COUNT] = len(function_kwargs)
+    result["code.module"] = wrapped_function.__module__
+    result["code.args.positional.count"] = len(function_args)
+    result["code.args.keyword.count"] = len(function_kwargs)
     return result
 
 
-def _record_function_call_span_attributes(
+def _record_function_call_arguments(
     otel_wrapper, wrapped_function, function_args, function_kwargs
 ):
     """Records the details about a function invocation as span attributes."""
-    if not is_content_recording_enabled():
-        return
+    include_values = is_content_recording_enabled()
     span = trace.get_current_span()
     signature = inspect.signature(wrapped_function)
     params = list(signature.parameters.values())
     for index, entry in enumerate(function_args):
         param_name = f"args[{index}]"
         if index < len(params):
             param_name = params[index].name
-        attribute_name = f"code.function.params.{param_name}"
-        span.set_attribute(attribute_name, _to_otel_value(entry))
+        attribute_prefix = f"code.function.parameters.{param_name}"
+        type_attribute = f"{attribute_prefix}.type"
+        span.set_attribute(type_attribute, type(entry).__name__)
+        if include_values:
+            value_attribute = f"{attribute_prefix}.value"
+            span.set_attribute(value_attribute, _to_otel_value(entry))
     for key, value in function_kwargs.items():
-        attribute_name = f"code.function.params.{key}"
-        span.set_attribute(attribute_name, _to_otel_value(value))
+        attribute_prefix = f"code.function.parameters.{key}"
+        type_attribute = f"{attribute_prefix}.type"
+        span.set_attribute(type_attribute, type(value).__name__)
+        if include_values:
+            value_attribute = f"{attribute_prefix}.value"
+            span.set_attribute(value_attribute, _to_otel_value(value))
 
 
-def _record_function_call_event(
-    otel_wrapper, wrapped_function, function_args, function_kwargs
-):
-    """Records the details about a function invocation as a log event."""
-    attributes = {
-        code_attributes.CODE_FUNCTION_NAME: wrapped_function.__name__,
-        CODE_MODULE: wrapped_function.__module__,
-        FUNCTION_TOOL_CALL_START_EVENT_ATTRS_POSITIONAL_ARGS_COUNT: len(
-            function_args
-        ),
-        FUNCTION_TOOL_CALL_START_EVENT_ATTRS_KEYWORD_ARGS_COUNT: len(
-            function_kwargs
-        ),
-    }
-    body = {}
-    if is_content_recording_enabled():
-        body[FUNCTION_TOOL_CALL_START_EVENT_BODY_POSITIONAL_ARGS] = (
-            _to_otel_value(function_args)
-        )
-        body[FUNCTION_TOOL_CALL_START_EVENT_BODY_KEYWORD_ARGS] = (
-            _to_otel_value(function_kwargs)
-        )
-    otel_wrapper.log_function_call_start(attributes, body)
-
-
-def _record_function_call_arguments(
-    otel_wrapper, wrapped_function, function_args, function_kwargs
-):
-    _record_function_call_span_attributes(
-        otel_wrapper, wrapped_function, function_args, function_kwargs
-    )
-    _record_function_call_event(
-        otel_wrapper, wrapped_function, function_args, function_kwargs
-    )
-
-
-def _record_function_call_result_event(otel_wrapper, wrapped_function, result):
-    """Records the details about a function result as a log event."""
-    attributes = {
-        code_attributes.CODE_FUNCTION_NAME: wrapped_function.__name__,
-        CODE_MODULE: wrapped_function.__module__,
-    }
-    body = {}
-    if is_content_recording_enabled():
-        body[FUNCTION_TOOL_CALL_END_EVENT_BODY_RESULT] = _to_otel_value(result)
-    otel_wrapper.log_function_call_end(attributes, body)
-
-
-def _record_function_call_result_span_attributes(
+def _record_function_call_result(
     otel_wrapper, wrapped_function, result
 ):
     """Records the details about a function result as span attributes."""
-    if not is_content_recording_enabled():
-        return
+    include_values = is_content_recording_enabled()
     span = trace.get_current_span()
-    span.set_attribute("code.function.return_value", _to_otel_value(result))
-
-
-def _record_function_call_result(otel_wrapper, wrapped_function, result):
-    _record_function_call_result_event(otel_wrapper, wrapped_function, result)
-    _record_function_call_result_span_attributes(
-        otel_wrapper, wrapped_function, result
-    )
+    span.set_attribute("code.function.return.type", type(result).__name__)
+    if include_values:
+        span.set_attribute("code.function.return.value", _to_otel_value(result))
 
 
 def _wrap_sync_tool_function(

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

@@ -111,10 +111,17 @@ def somefunction(someparam, otherparam=2):
         self.otel.assert_has_span_named("tool_call somefunction")
         generated_span = self.otel.get_span_named("tool_call somefunction")
         self.assertEqual(
-            generated_span.attributes["code.function.params.someparam"], "123"
+            generated_span.attributes["code.function.parameters.someparam.type"], "int"
         )
         self.assertEqual(
-            generated_span.attributes["code.function.params.otherparam"],
+            generated_span.attributes["code.function.parameters.otherparam.type"],
+            "str",
+        )
+        self.assertEqual(
+            generated_span.attributes["code.function.parameters.someparam.value"], "123"
+        )
+        self.assertEqual(
+            generated_span.attributes["code.function.parameters.otherparam.value"],
             "'abc'",
         )
 
@@ -146,11 +153,18 @@ def somefunction(someparam, otherparam=2):
         wrapped_somefunction(123, otherparam="abc")
         self.otel.assert_has_span_named("tool_call somefunction")
         generated_span = self.otel.get_span_named("tool_call somefunction")
+        self.assertEqual(
+            generated_span.attributes["code.function.parameters.someparam.type"], "int"
+        )
+        self.assertEqual(
+            generated_span.attributes["code.function.parameters.otherparam.type"],
+            "str",
+        )
         self.assertNotIn(
-            "code.function.params.someparam", generated_span.attributes
+            "code.function.parameters.someparam.value", generated_span.attributes
         )
         self.assertNotIn(
-            "code.function.params.otherparam", generated_span.attributes
+            "code.function.parameters.otherparam.value", generated_span.attributes
         )
 
     def test_tool_calls_record_return_values_on_span_if_enabled(self):
@@ -182,7 +196,10 @@ def somefunction(x, y=2):
         self.otel.assert_has_span_named("tool_call somefunction")
         generated_span = self.otel.get_span_named("tool_call somefunction")
         self.assertEqual(
-            generated_span.attributes["code.function.return_value"], "125"
+            generated_span.attributes["code.function.return.type"], "int"
+        )
+        self.assertEqual(
+            generated_span.attributes["code.function.return.value"], "125"
         )
 
     def test_tool_calls_do_not_record_return_values_if_not_enabled(self):
@@ -213,6 +230,9 @@ def somefunction(x, y=2):
         wrapped_somefunction(123)
         self.otel.assert_has_span_named("tool_call somefunction")
         generated_span = self.otel.get_span_named("tool_call somefunction")
+        self.assertEqual(
+            generated_span.attributes["code.function.return.type"], "int"
+        )
         self.assertNotIn(
-            "code.function.return_value", generated_span.attributes
+            "code.function.return.value", generated_span.attributes
         )