refactor: convert API LogRecord to SDK LogRecord, add unit test

Author: keith-decker

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

@@ -38,9 +38,10 @@
 from uuid import UUID
 
 from opentelemetry import trace
-from opentelemetry._logs import Logger, LogRecord
+from opentelemetry._logs import Logger
 from opentelemetry.context import Context, get_current
 from opentelemetry.metrics import Histogram, Meter, get_meter
+from opentelemetry.sdk._logs._internal import LogRecord as SDKLogRecord
 from opentelemetry.semconv._incubating.attributes import (
     gen_ai_attributes as GenAI,
 )
@@ -85,7 +86,14 @@ def _message_to_log_record(
     provider_name: Optional[str],
     framework: Optional[str],
     capture_content: bool,
-) -> Optional[LogRecord]:
+) -> Optional[SDKLogRecord]:
+    """Build an SDK LogRecord for an input message.
+
+    Returns an SDK-level LogRecord configured with:
+    - body: structured payload for the message (when capture_content is True)
+    - attributes: includes semconv fields and attributes["event.name"]
+    - event_name: mirrors the event name for SDK consumers
+    """
     content = _get_property_value(message, "content")
     message_type = _get_property_value(message, "type")
 
@@ -98,15 +106,17 @@ def _message_to_log_record(
         "gen_ai.framework": framework,
         # TODO: Convert below to constant once opentelemetry.semconv._incubating.attributes.gen_ai_attributes is available
         "gen_ai.provider.name": provider_name,
+        # Prefer structured logs; include event name as an attribute.
+        "event.name": "gen_ai.client.inference.operation.details",
     }
 
     if capture_content:
         attributes["gen_ai.input.messages"] = [message._to_semconv_dict()]
 
-    return LogRecord(
-        event_name="gen_ai.client.inference.operation.details",
-        attributes=attributes,
+    return SDKLogRecord(
         body=body or None,
+        attributes=attributes,
+        event_name="gen_ai.client.inference.operation.details",
     )
 
 
@@ -116,14 +126,21 @@ def _chat_generation_to_log_record(
     provider_name: Optional[str],
     framework: Optional[str],
     capture_content: bool,
-) -> Optional[LogRecord]:
+) -> Optional[SDKLogRecord]:
+    """Build an SDK LogRecord for a chat generation (choice) item.
+
+    Sets both the SDK event_name and attributes["event.name"] to "gen_ai.choice",
+    and includes structured fields in body (index, finish_reason, message).
+    """
     if not chat_generation:
         return None
     attributes = {
         # TODO: add below to opentelemetry.semconv._incubating.attributes.gen_ai_attributes
         "gen_ai.framework": framework,
         # TODO: Convert below to constant once opentelemetry.semconv._incubating.attributes.gen_ai_attributes is available
         "gen_ai.provider.name": provider_name,
+        # Prefer structured logs; include event name as an attribute.
+        "event.name": "gen_ai.choice",
     }
 
     message = {
@@ -138,10 +155,10 @@ def _chat_generation_to_log_record(
         "message": message,
     }
 
-    return LogRecord(
-        event_name="gen_ai.choice",
-        attributes=attributes,
+    return SDKLogRecord(
         body=body or None,
+        attributes=attributes,
+        event_name="gen_ai.choice",
     )
 
 
@@ -376,6 +393,7 @@ def start(self, invocation: LLMInvocation):
                 capture_content=self._capture_content,
             )
             if log and self._logger:
+                # _message_to_log_record returns an SDKLogRecord
                 self._logger.emit(log)
 
     def finish(self, invocation: LLMInvocation):

util/opentelemetry-util-genai/tests/test_utils.py

@@ -3,12 +3,18 @@
 import pytest
 
 from opentelemetry import trace
+from opentelemetry.sdk._logs import LoggerProvider
+from opentelemetry.sdk._logs.export import (
+    InMemoryLogExporter,
+    SimpleLogRecordProcessor,
+)
 from opentelemetry.sdk.trace import TracerProvider
 from opentelemetry.sdk.trace.export import SimpleSpanProcessor
 from opentelemetry.sdk.trace.export.in_memory_span_exporter import (
     InMemorySpanExporter,
 )
 from opentelemetry.util.genai.handler import (
+    TelemetryHandler,
     llm_start,
     llm_stop,
 )
@@ -79,3 +85,64 @@ def test_llm_start_and_stop_creates_span(
     assert invocation.run_id == run_id
     assert invocation.attributes.get("custom_attr") == "value"
     assert invocation.attributes.get("extra") == "info"
+
+
+def test_structured_logs_emitted():
+    # Configure in-memory log exporter and provider
+    log_exporter = InMemoryLogExporter()
+    logger_provider = LoggerProvider()
+    logger_provider.add_log_record_processor(
+        SimpleLogRecordProcessor(log_exporter)
+    )
+
+    # Build a dedicated TelemetryHandler using our logger provider
+    handler = TelemetryHandler(
+        emitter_type_full=True,
+        logger_provider=logger_provider,
+    )
+
+    run_id = uuid4()
+    message = Message(content="hello world", type="user", name="msg")
+    generation = ChatGeneration(
+        content="hello back",
+        type="assistant",
+        finish_reason="stop",
+    )
+
+    # Start and stop via the handler (emits logs at start and finish)
+    handler.start_llm(
+        [message], run_id=run_id, system="test-system", framework="pytest"
+    )
+    handler.stop_llm(run_id, chat_generations=[generation])
+
+    # Collect logs
+    logs = log_exporter.get_finished_logs()
+    # Expect one input-detail log and one choice log
+    assert len(logs) == 2
+    records = [ld.log_record for ld in logs]
+
+    # Assert the first record contains structured details for the input message
+    # Note: order of records is exporter-specific; sort by event.name for stability
+    records_by_event = {
+        rec.attributes.get("event.name"): rec for rec in records
+    }
+
+    input_rec = records_by_event["gen_ai.client.inference.operation.details"]
+    assert input_rec.attributes.get("gen_ai.provider.name") == "test-system"
+    assert input_rec.attributes.get("gen_ai.framework") == "pytest"
+    assert input_rec.body == {
+        "type": "user",
+        "content": "hello world",
+    }
+
+    choice_rec = records_by_event["gen_ai.choice"]
+    assert choice_rec.attributes.get("gen_ai.provider.name") == "test-system"
+    assert choice_rec.attributes.get("gen_ai.framework") == "pytest"
+    assert choice_rec.body == {
+        "index": 0,
+        "finish_reason": "stop",
+        "message": {
+            "type": "assistant",
+            "content": "hello back",
+        },
+    }