Allow overriding OpenAI agent name via environment variable

Author: nagkumar91

instrumentation-genai/opentelemetry-instrumentation-openai-agents/src/opentelemetry/instrumentation/openai_agents/__init__.py

@@ -17,6 +17,7 @@
 from __future__ import annotations
 
 import importlib
+import os
 from typing import TYPE_CHECKING, Any, Collection, Protocol
 
 from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
@@ -97,8 +98,15 @@ def _instrument(self, **kwargs) -> None:
         )
 
         system = _resolve_system(kwargs.get("system"))
+        agent_name_override = kwargs.get("agent_name") or os.getenv(
+            "OTEL_GENAI_AGENT_NAME"
+        )
 
-        processor = _OpenAIAgentsSpanProcessor(tracer=tracer, system=system)
+        processor = _OpenAIAgentsSpanProcessor(
+            tracer=tracer,
+            system=system,
+            agent_name_override=agent_name_override,
+        )
 
         tracing = _load_tracing_module()
         provider = tracing.get_trace_provider()

instrumentation-genai/opentelemetry-instrumentation-openai-agents/src/opentelemetry/instrumentation/openai_agents/span_processor.py

@@ -134,9 +134,20 @@ class _SpanContext:
 class _OpenAIAgentsSpanProcessor(TracingProcessor):
     """Convert OpenAI Agents traces into OpenTelemetry spans."""
 
-    def __init__(self, tracer: Tracer, system: str) -> None:
+    def __init__(
+        self,
+        tracer: Tracer,
+        system: str,
+        agent_name_override: str | None = None,
+    ) -> None:
         self._tracer = tracer
         self._system = system
+        self._agent_name_override = (
+            agent_name_override.strip()
+            if isinstance(agent_name_override, str)
+            and agent_name_override.strip()
+            else None
+        )
         self._root_spans: dict[str, Span] = {}
         self._spans: dict[str, _SpanContext] = {}
         self._lock = RLock()
@@ -308,7 +319,7 @@ def _attributes_from_agent(self, span_data: Any) -> dict[str, Any]:
             GenAI.GenAiOperationNameValues.INVOKE_AGENT.value
         )
 
-        name = getattr(span_data, "name", None)
+        name = self._agent_name_override or getattr(span_data, "name", None)
         if name:
             attributes[GenAI.GEN_AI_AGENT_NAME] = name
         output_type = getattr(span_data, "output_type", None)
@@ -325,7 +336,7 @@ def _attributes_from_agent_creation(
             GenAI.GenAiOperationNameValues.CREATE_AGENT.value
         )
 
-        name = getattr(span_data, "name", None)
+        name = self._agent_name_override or getattr(span_data, "name", None)
         if name:
             attributes[GenAI.GEN_AI_AGENT_NAME] = name
         description = getattr(span_data, "description", None)

instrumentation-genai/opentelemetry-instrumentation-openai-agents/tests/test_tracer.py

@@ -45,14 +45,14 @@
 from opentelemetry.trace import SpanKind  # noqa: E402
 
 
-def _instrument_with_provider():
+def _instrument_with_provider(**instrument_kwargs):
     set_trace_processors([])
     provider = TracerProvider()
     exporter = InMemorySpanExporter()
     provider.add_span_processor(SimpleSpanProcessor(exporter))
 
     instrumentor = OpenAIAgentsInstrumentor()
-    instrumentor.instrument(tracer_provider=provider)
+    instrumentor.instrument(tracer_provider=provider, **instrument_kwargs)
 
     return instrumentor, exporter
 
@@ -158,3 +158,32 @@ def test_agent_create_span_records_attributes():
     finally:
         instrumentor.uninstrument()
         exporter.clear()
+
+
+def test_agent_name_override_applied_to_agent_spans():
+    instrumentor, exporter = _instrument_with_provider(
+        agent_name="Travel Concierge"
+    )
+
+    try:
+        with trace("workflow"):
+            with agent_span(operation="invoke", name="support_bot"):
+                pass
+
+        spans = exporter.get_finished_spans()
+        agent_span_record = next(
+            span
+            for span in spans
+            if span.attributes[GenAI.GEN_AI_OPERATION_NAME]
+            == GenAI.GenAiOperationNameValues.INVOKE_AGENT.value
+        )
+
+        assert agent_span_record.kind is SpanKind.CLIENT
+        assert agent_span_record.name == "invoke_agent Travel Concierge"
+        assert (
+            agent_span_record.attributes[GenAI.GEN_AI_AGENT_NAME]
+            == "Travel Concierge"
+        )
+    finally:
+        instrumentor.uninstrument()
+        exporter.clear()