updates to binary data tracing (#43854)

* updates to binary data tracing

* code formatter changes

* pylint fix

* updated readme based on review feedback

Author: M-Hietala

sdk/ai/azure-ai-projects/README.md

@@ -418,6 +418,15 @@ To enable content recording, set the `OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE
 
 The AI Projects client library automatically instruments OpenAI responses and conversations operations through `AiProjectInstrumentation`. You can disable this instrumentation by setting the environment variable `AZURE_TRACING_GEN_AI_INSTRUMENT_RESPONSES_API` to `false`. If the environment variable is not set, the responses and conversations APIs will be instrumented by default.
 
+### Tracing Binary Data
+
+Binary data are images and files sent to the service as input messages. When you enable content recording (`OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT` set to `true`), by default you only trace file IDs and filenames. To enable full binary data tracing, set `AZURE_TRACING_GEN_AI_INCLUDE_BINARY_DATA` to `true`. In this case:
+
+- **Images**: Image URLs (including data URIs with base64-encoded content) are included
+- **Files**: File data is included if sent via the API
+
+**Important:** Binary data can contain sensitive information and may significantly increase trace size. Some trace backends and tracing implementations may have limitations on the maximum size of trace data that can be sent to and/or supported by the backend. Ensure your observability backend and tracing implementation support the expected trace payload sizes when enabling binary data tracing.
+
 ### Additional resources
 
 For more information see:

sdk/ai/azure-ai-projects/azure/ai/projects/telemetry/_responses_instrumentor.py

@@ -52,6 +52,7 @@
 
 _responses_traces_enabled: bool = False
 _trace_responses_content: bool = False
+_trace_binary_data: bool = False
 
 # Azure OpenAI system identifier for traces
 AZURE_OPENAI_SYSTEM = "azure.openai"
@@ -132,6 +133,14 @@ def is_content_recording_enabled(self) -> bool:
         """
         return self._impl.is_content_recording_enabled()
 
+    def is_binary_data_enabled(self) -> bool:
+        """This function gets the binary data tracing value.
+
+        :return: A bool value indicating whether binary data tracing is enabled.
+        :rtype: bool
+        """
+        return self._impl.is_binary_data_enabled()
+
 
 class _ResponsesInstrumentorPreview:  # pylint: disable=too-many-instance-attributes,too-many-statements,too-many-public-methods
     """
@@ -389,10 +398,14 @@ def instrument(self, enable_content_recording: Optional[bool] = None):
                 os.environ.get("OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT", "false")
             )
 
+        # Check if binary data tracing is enabled
+        enable_binary_data = self._str_to_bool(os.environ.get("AZURE_TRACING_GEN_AI_INCLUDE_BINARY_DATA", "false"))
+
         if not self.is_instrumented():
-            self._instrument_responses(enable_content_recording)
+            self._instrument_responses(enable_content_recording, enable_binary_data)
         else:
             self.set_enable_content_recording(enable_content_recording)
+            self.set_enable_binary_data(enable_binary_data)
 
     def uninstrument(self):
         """
@@ -431,6 +444,23 @@ def is_content_recording_enabled(self) -> bool:
         """
         return self._is_content_recording_enabled()
 
+    def set_enable_binary_data(self, enable_binary_data: bool = False) -> None:
+        """This function sets the binary data tracing value.
+
+        :param enable_binary_data: Indicates whether tracing of binary data (such as images) should be enabled.
+                                   This only takes effect when content recording is also enabled.
+        :type enable_binary_data: bool
+        """
+        self._set_enable_binary_data(enable_binary_data=enable_binary_data)
+
+    def is_binary_data_enabled(self) -> bool:
+        """This function gets the binary data tracing value.
+
+        :return: A bool value indicating whether binary data tracing is enabled.
+        :rtype: bool
+        """
+        return self._is_binary_data_enabled()
+
     def _set_attributes(self, span: "AbstractSpan", *attrs: Tuple[str, Any]) -> None:
         for attr in attrs:
             span.add_attribute(attr[0], attr[1])
@@ -474,7 +504,8 @@ def _add_message_event(
         event_body: Dict[str, Any] = {}
 
         if _trace_responses_content and content:
-            event_body["text"] = content
+            # Use consistent structured format with content array
+            event_body["content"] = [{"type": "text", "text": content}]
 
         attributes = self._create_event_attributes(
             conversation_id=conversation_id,
@@ -560,6 +591,138 @@ def _add_tool_message_events(
         # Use "tool" for the event name: gen_ai.tool.message
         span.span_instance.add_event(name="gen_ai.tool.message", attributes=attributes)
 
+    # pylint: disable=too-many-branches
+    def _add_structured_input_events(
+        self,
+        span: "AbstractSpan",
+        input_list: List[Any],
+        conversation_id: Optional[str] = None,
+    ) -> None:
+        """
+        Add message events for structured input (list format).
+        This handles cases like messages with images, multi-part content, etc.
+        """
+        for input_item in input_list:
+            try:
+                # Extract role - handle both dict and object
+                if isinstance(input_item, dict):
+                    role = input_item.get("role", "user")
+                    content = input_item.get("content")
+                else:
+                    role = getattr(input_item, "role", "user")
+                    content = getattr(input_item, "content", None)
+
+                if not content:
+                    continue
+
+                # Build structured event content with content parts
+                event_body: Dict[str, Any] = {}
+
+                # Only process content if content recording is enabled
+                if _trace_responses_content:
+                    content_parts = []
+                    has_non_text_content = False
+
+                    # Content can be a list of content items
+                    if isinstance(content, list):
+                        for content_item in content:
+                            content_type = None
+
+                            # Handle dict format
+                            if isinstance(content_item, dict):
+                                content_type = content_item.get("type")
+                                if content_type in ("input_text", "text"):
+                                    text = content_item.get("text")
+                                    if text:
+                                        content_parts.append({"type": "text", "text": text})
+                                elif content_type == "input_image":
+                                    has_non_text_content = True
+                                    image_part = {"type": "image"}
+                                    # Include image data if binary data tracing is enabled
+                                    if _trace_binary_data:
+                                        image_url = content_item.get("image_url")
+                                        if image_url:
+                                            image_part["image_url"] = image_url
+                                    content_parts.append(image_part)
+                                elif content_type == "input_file":
+                                    has_non_text_content = True
+                                    file_part = {"type": "file"}
+                                    # Only include filename and file_id if content recording is enabled
+                                    filename = content_item.get("filename")
+                                    if filename:
+                                        file_part["filename"] = filename
+                                    file_id = content_item.get("file_id")
+                                    if file_id:
+                                        file_part["file_id"] = file_id
+                                    # Only include file_data if binary data tracing is enabled
+                                    if _trace_binary_data:
+                                        file_data = content_item.get("file_data")
+                                        if file_data:
+                                            file_part["file_data"] = file_data
+                                    content_parts.append(file_part)
+                                elif content_type:
+                                    # Other content types (audio, video, etc.)
+                                    has_non_text_content = True
+                                    content_parts.append({"type": content_type})
+
+                            # Handle object format
+                            elif hasattr(content_item, "type"):
+                                content_type = getattr(content_item, "type", None)
+                                if content_type in ("input_text", "text"):
+                                    text = getattr(content_item, "text", None)
+                                    if text:
+                                        content_parts.append({"type": "text", "text": text})
+                                elif content_type == "input_image":
+                                    has_non_text_content = True
+                                    image_part = {"type": "image"}
+                                    # Include image data if binary data tracing is enabled
+                                    if _trace_binary_data:
+                                        image_url = getattr(content_item, "image_url", None)
+                                        if image_url:
+                                            image_part["image_url"] = image_url
+                                    content_parts.append(image_part)
+                                elif content_type == "input_file":
+                                    has_non_text_content = True
+                                    file_part = {"type": "file"}
+                                    # Only include filename and file_id if content recording is enabled
+                                    filename = getattr(content_item, "filename", None)
+                                    if filename:
+                                        file_part["filename"] = filename
+                                    file_id = getattr(content_item, "file_id", None)
+                                    if file_id:
+                                        file_part["file_id"] = file_id
+                                    # Only include file_data if binary data tracing is enabled
+                                    if _trace_binary_data:
+                                        file_data = getattr(content_item, "file_data", None)
+                                        if file_data:
+                                            file_part["file_data"] = file_data
+                                    content_parts.append(file_part)
+                                elif content_type:
+                                    # Other content types
+                                    has_non_text_content = True
+                                    content_parts.append({"type": content_type})
+
+                    # Only add content if we have content parts
+                    if content_parts:
+                        # Always use consistent structured format
+                        event_body["content"] = content_parts
+
+                # Create event attributes
+                attributes = self._create_event_attributes(
+                    conversation_id=conversation_id,
+                    message_role=role,
+                )
+                attributes[GEN_AI_EVENT_CONTENT] = json.dumps(event_body, ensure_ascii=False)
+
+                # Add the event
+                event_name = f"gen_ai.{role}.message"
+                span.span_instance.add_event(name=event_name, attributes=attributes)
+
+            except Exception:  # pylint: disable=broad-exception-caught
+                # Skip items that can't be processed
+                logger.debug("Failed to process structured input item: %s", input_item, exc_info=True)
+                continue
+
     def _emit_tool_call_event(
         self,
         span: "AbstractSpan",
@@ -868,6 +1031,14 @@ def start_responses_span(
                     content=input_text,
                     conversation_id=conversation_id,
                 )
+            elif isinstance(input_to_check, list) and not has_tool_outputs:
+                # Handle structured input (list format) - extract text content from user messages
+                # This handles cases like image inputs with text prompts
+                self._add_structured_input_events(
+                    span,
+                    input_list=input_to_check,
+                    conversation_id=conversation_id,
+                )
 
         return span
 
@@ -2982,7 +3153,7 @@ def _available_responses_apis_and_injectors(self):
         """
         yield from self._generate_api_and_injector(self._all_api_list())
 
-    def _instrument_responses(self, enable_content_tracing: bool = False):
+    def _instrument_responses(self, enable_content_tracing: bool = False, enable_binary_data: bool = False):
         """This function modifies the methods of the Responses API classes to
         inject logic before calling the original methods.
         The original methods are stored as _original attributes of the methods.
@@ -2991,15 +3162,20 @@ def _instrument_responses(self, enable_content_tracing: bool = False):
                                     This also controls whether function call tool function names,
                                     parameter names and parameter values are traced.
         :type enable_content_tracing: bool
+        :param enable_binary_data: Indicates whether tracing of binary data (such as images) should be enabled.
+                                   This only takes effect when content recording is also enabled.
+        :type enable_binary_data: bool
         """
         # pylint: disable=W0603
         global _responses_traces_enabled
         global _trace_responses_content
+        global _trace_binary_data
         if _responses_traces_enabled:
             return
 
         _responses_traces_enabled = True
         _trace_responses_content = enable_content_tracing
+        _trace_binary_data = enable_binary_data
 
         # Initialize metrics instruments
         self._initialize_metrics()
@@ -3050,6 +3226,14 @@ def _is_content_recording_enabled(self) -> bool:
         global _trace_responses_content
         return _trace_responses_content
 
+    def _set_enable_binary_data(self, enable_binary_data: bool = False) -> None:
+        global _trace_binary_data
+        _trace_binary_data = enable_binary_data
+
+    def _is_binary_data_enabled(self) -> bool:
+        global _trace_binary_data
+        return _trace_binary_data
+
     def record_error(self, span, exc):
         # pyright: ignore [reportPossiblyUnboundVariable]
         span.span_instance.set_status(StatusCode.ERROR, str(exc))