fix(genai-utils): move get_content_attributes to _invocation.py, add test coverage

Author: etserend

util/opentelemetry-util-genai/src/opentelemetry/util/genai/_agent_invocation.py

@@ -22,8 +22,11 @@
 )
 from opentelemetry.semconv.attributes import server_attributes
 from opentelemetry.trace import SpanKind, Tracer
-from opentelemetry.util.genai._content import _get_content_attributes
-from opentelemetry.util.genai._invocation import Error, GenAIInvocation
+from opentelemetry.util.genai._invocation import (
+    Error,
+    GenAIInvocation,
+    get_content_attributes,
+)
 from opentelemetry.util.genai.metrics import InvocationMetricsRecorder
 from opentelemetry.util.genai.types import (
     InputMessage,
@@ -154,7 +157,7 @@ def _get_usage_attributes(self) -> dict[str, Any]:
         return {k: v for k, v in optional_attrs if v is not None}
 
     def _get_content_attributes_for_span(self) -> dict[str, Any]:
-        return _get_content_attributes(
+        return get_content_attributes(
             input_messages=self.input_messages,
             output_messages=self.output_messages,
             system_instruction=self.system_instruction,

util/opentelemetry-util-genai/src/opentelemetry/util/genai/_content.py

@@ -23,8 +23,11 @@
 )
 from opentelemetry.semconv.attributes import server_attributes
 from opentelemetry.trace import INVALID_SPAN, Span, SpanKind, Tracer
-from opentelemetry.util.genai._content import _get_content_attributes
-from opentelemetry.util.genai._invocation import Error, GenAIInvocation
+from opentelemetry.util.genai._invocation import (
+    Error,
+    GenAIInvocation,
+    get_content_attributes,
+)
 from opentelemetry.util.genai.metrics import InvocationMetricsRecorder
 from opentelemetry.util.genai.types import (
     InputMessage,
@@ -118,7 +121,7 @@ def __init__(  # pylint: disable=too-many-locals
         self._start()
 
     def _get_message_attributes(self, *, for_span: bool) -> dict[str, Any]:
-        return _get_content_attributes(
+        return get_content_attributes(
             input_messages=self.input_messages,
             output_messages=self.output_messages,
             system_instruction=self.system_instruction,

util/opentelemetry-util-genai/src/opentelemetry/util/genai/_inference_invocation.py

@@ -18,17 +18,33 @@
 from abc import ABC, abstractmethod
 from contextlib import contextmanager
 from contextvars import Token
-from typing import TYPE_CHECKING, Any, Iterator
+from dataclasses import asdict
+from typing import TYPE_CHECKING, Any, Iterator, Sequence
 
 from typing_extensions import Self, TypeAlias
 
 from opentelemetry._logs import Logger
 from opentelemetry.context import Context, attach, detach
+from opentelemetry.semconv._incubating.attributes import (
+    gen_ai_attributes as GenAI,
+)
 from opentelemetry.semconv.attributes import error_attributes
 from opentelemetry.trace import INVALID_SPAN as _INVALID_SPAN
 from opentelemetry.trace import Span, SpanKind, Tracer, set_span_in_context
 from opentelemetry.trace.status import Status, StatusCode
-from opentelemetry.util.genai.types import Error
+from opentelemetry.util.genai.types import (
+    Error,
+    InputMessage,
+    MessagePart,
+    OutputMessage,
+    ToolDefinition,
+)
+from opentelemetry.util.genai.utils import (
+    ContentCapturingMode,
+    gen_ai_json_dumps,
+    get_content_capturing_mode,
+    is_experimental_mode,
+)
 
 if TYPE_CHECKING:
     from opentelemetry.util.genai.metrics import InvocationMetricsRecorder
@@ -138,3 +154,64 @@ def _managed(self) -> Iterator[Self]:
             self.fail(exc)
             raise
         self.stop()
+
+
+def get_content_attributes(
+    *,
+    input_messages: Sequence[InputMessage],
+    output_messages: Sequence[OutputMessage],
+    system_instruction: Sequence[MessagePart],
+    tool_definitions: Sequence[ToolDefinition] | None,
+    for_span: bool,
+) -> dict[str, Any]:
+    """Serialize messages, system instructions, and tool definitions into attributes.
+
+    Args:
+        input_messages: Input messages to serialize.
+        output_messages: Output messages to serialize.
+        system_instruction: System instructions to serialize.
+        tool_definitions: Tool definitions to serialize (may be None).
+        for_span: If True, serialize for span attributes (JSON string);
+                  if False, serialize for event attributes (list of dicts).
+    """
+    if not is_experimental_mode():
+        return {}
+
+    mode = get_content_capturing_mode()
+    allowed_modes = (
+        (
+            ContentCapturingMode.SPAN_ONLY,
+            ContentCapturingMode.SPAN_AND_EVENT,
+        )
+        if for_span
+        else (
+            ContentCapturingMode.EVENT_ONLY,
+            ContentCapturingMode.SPAN_AND_EVENT,
+        )
+    )
+    if mode not in allowed_modes:
+        return {}
+
+    def serialize(items: Sequence[Any]) -> Any:
+        dicts = [asdict(item) for item in items]
+        return gen_ai_json_dumps(dicts) if for_span else dicts
+
+    optional_attrs = (
+        (
+            GenAI.GEN_AI_INPUT_MESSAGES,
+            serialize(input_messages) if input_messages else None,
+        ),
+        (
+            GenAI.GEN_AI_OUTPUT_MESSAGES,
+            serialize(output_messages) if output_messages else None,
+        ),
+        (
+            GenAI.GEN_AI_SYSTEM_INSTRUCTIONS,
+            serialize(system_instruction) if system_instruction else None,
+        ),
+        (
+            GenAI.GEN_AI_TOOL_DEFINITIONS,
+            serialize(tool_definitions) if tool_definitions else None,
+        ),
+    )
+    return {key: value for key, value in optional_attrs if value is not None}

util/opentelemetry-util-genai/src/opentelemetry/util/genai/_invocation.py

@@ -16,6 +16,7 @@
 from opentelemetry.trace import INVALID_SPAN, SpanKind
 from opentelemetry.util.genai.handler import TelemetryHandler
 from opentelemetry.util.genai.types import (
+    ContentCapturingMode,
     Error,
     FunctionToolDefinition,
     InputMessage,
@@ -79,8 +80,12 @@ def test_all_attributes(self):
         invocation.output_type = "text"
         invocation.temperature = 0.7
         invocation.top_p = 0.9
+        invocation.frequency_penalty = 0.5
+        invocation.presence_penalty = 0.3
         invocation.max_tokens = 1000
+        invocation.stop_sequences = ["END", "STOP"]
         invocation.seed = 42
+        invocation.choice_count = 3
         invocation.input_tokens = 100
         invocation.output_tokens = 200
         invocation.stop()
@@ -97,8 +102,12 @@ def test_all_attributes(self):
         assert attrs[GenAI.GEN_AI_OUTPUT_TYPE] == "text"
         assert attrs[GenAI.GEN_AI_REQUEST_TEMPERATURE] == 0.7
         assert attrs[GenAI.GEN_AI_REQUEST_TOP_P] == 0.9
+        assert attrs[GenAI.GEN_AI_REQUEST_FREQUENCY_PENALTY] == 0.5
+        assert attrs[GenAI.GEN_AI_REQUEST_PRESENCE_PENALTY] == 0.3
         assert attrs[GenAI.GEN_AI_REQUEST_MAX_TOKENS] == 1000
+        assert attrs[GenAI.GEN_AI_REQUEST_STOP_SEQUENCES] == ("END", "STOP")
         assert attrs[GenAI.GEN_AI_REQUEST_SEED] == 42
+        assert attrs[GenAI.GEN_AI_REQUEST_CHOICE_COUNT] == 3
 
     def test_no_response_model_or_finish_reasons(self):
         invocation = self.handler.start_invoke_local_agent("openai")
@@ -164,8 +173,8 @@ def test_default_values(self):
         assert invocation.agent_name is None
         assert invocation.provider == "openai"
         assert invocation.request_model is None
-        assert invocation.input_messages == []
-        assert invocation.output_messages == []
+        assert not invocation.input_messages
+        assert not invocation.output_messages
         assert invocation.tool_definitions is None
         assert invocation.cache_creation_input_tokens is None
         assert invocation.cache_read_input_tokens is None
@@ -239,6 +248,95 @@ def test_provider_always_set(self):
         assert attrs[GenAI.GEN_AI_PROVIDER_NAME] == "gcp_vertex_ai"
 
 
+class TestAgentInvocationContent(unittest.TestCase):
+    def setUp(self):
+        self.span_exporter = InMemorySpanExporter()
+        tracer_provider = TracerProvider()
+        tracer_provider.add_span_processor(
+            SimpleSpanProcessor(self.span_exporter)
+        )
+        self.handler = TelemetryHandler(tracer_provider=tracer_provider)
+
+    @patch(
+        "opentelemetry.util.genai._invocation.get_content_capturing_mode",
+        return_value=ContentCapturingMode.SPAN_AND_EVENT,
+    )
+    @patch(
+        "opentelemetry.util.genai._invocation.is_experimental_mode",
+        return_value=True,
+    )
+    def test_system_instruction_on_span(self, _mock_exp, _mock_cap):
+        invocation = self.handler.start_invoke_local_agent("openai")
+        invocation.system_instruction = [
+            Text(content="You are a helpful assistant."),
+        ]
+        invocation.stop()
+
+        attrs = self.span_exporter.get_finished_spans()[0].attributes
+        assert GenAI.GEN_AI_SYSTEM_INSTRUCTIONS in attrs
+
+    @patch(
+        "opentelemetry.util.genai._invocation.get_content_capturing_mode",
+        return_value=ContentCapturingMode.SPAN_AND_EVENT,
+    )
+    @patch(
+        "opentelemetry.util.genai._invocation.is_experimental_mode",
+        return_value=True,
+    )
+    def test_tool_definitions_on_span(self, _mock_exp, _mock_cap):
+        tool = FunctionToolDefinition(
+            name="get_weather",
+            description="Get the weather",
+            parameters={"type": "object", "properties": {}},
+        )
+        invocation = self.handler.start_invoke_local_agent("openai")
+        invocation.tool_definitions = [tool]
+        invocation.stop()
+
+        attrs = self.span_exporter.get_finished_spans()[0].attributes
+        assert GenAI.GEN_AI_TOOL_DEFINITIONS in attrs
+
+    @patch(
+        "opentelemetry.util.genai._invocation.get_content_capturing_mode",
+        return_value=ContentCapturingMode.SPAN_AND_EVENT,
+    )
+    @patch(
+        "opentelemetry.util.genai._invocation.is_experimental_mode",
+        return_value=True,
+    )
+    def test_messages_on_span(self, _mock_exp, _mock_cap):
+        invocation = self.handler.start_invoke_local_agent("openai")
+        invocation.input_messages = [
+            InputMessage(role="user", parts=[Text(content="Hello")])
+        ]
+        invocation.output_messages = [
+            OutputMessage(
+                role="assistant",
+                parts=[Text(content="Hi!")],
+                finish_reason="stop",
+            )
+        ]
+        invocation.stop()
+
+        attrs = self.span_exporter.get_finished_spans()[0].attributes
+        assert GenAI.GEN_AI_INPUT_MESSAGES in attrs
+        assert GenAI.GEN_AI_OUTPUT_MESSAGES in attrs
+
+    def test_content_not_on_span_by_default(self):
+        invocation = self.handler.start_invoke_local_agent("openai")
+        invocation.system_instruction = [
+            Text(content="You are a helpful assistant."),
+        ]
+        invocation.input_messages = [
+            InputMessage(role="user", parts=[Text(content="Hello")])
+        ]
+        invocation.stop()
+
+        attrs = self.span_exporter.get_finished_spans()[0].attributes
+        assert GenAI.GEN_AI_SYSTEM_INSTRUCTIONS not in attrs
+        assert GenAI.GEN_AI_INPUT_MESSAGES not in attrs
+
+
 class TestRemoteAgentInvocation(unittest.TestCase):
     def setUp(self):
         self.span_exporter = InMemorySpanExporter()