Provide default agent configuration values

Author: nagkumar91

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

@@ -44,14 +44,6 @@
 _CAPTURE_METRICS_ENV = "OTEL_INSTRUMENTATION_OPENAI_AGENTS_CAPTURE_METRICS"
 
 
-_AGENT_NAME_ENV = "OTEL_INSTRUMENTATION_OPENAI_AGENTS_AGENT_NAME"
-_AGENT_ID_ENV = "OTEL_INSTRUMENTATION_OPENAI_AGENTS_AGENT_ID"
-_AGENT_DESCRIPTION_ENV = "OTEL_INSTRUMENTATION_OPENAI_AGENTS_AGENT_DESCRIPTION"
-_BASE_URL_ENV = "OTEL_INSTRUMENTATION_OPENAI_AGENTS_BASE_URL"
-_SERVER_ADDRESS_ENV = "OTEL_INSTRUMENTATION_OPENAI_AGENTS_SERVER_ADDRESS"
-_SERVER_PORT_ENV = "OTEL_INSTRUMENTATION_OPENAI_AGENTS_SERVER_PORT"
-
-
 def _load_tracing_module():  # pragma: no cover - exercised via tests
     return importlib.import_module("agents.tracing")
 
@@ -129,39 +121,6 @@ def _resolve_bool(value: Any, default: bool) -> bool:
     return default
 
 
-def _resolve_optional_str(value: Any, env_name: str) -> str | None:
-    if isinstance(value, str):
-        candidate = value.strip()
-        if candidate:
-            return candidate
-    elif value is not None:
-        candidate = str(value).strip()
-        if candidate:
-            return candidate
-    env_val = os.getenv(env_name)
-    if env_val and env_val.strip():
-        return env_val.strip()
-    return None
-
-
-def _resolve_optional_int(value: Any, env_name: str) -> int | None:
-    if value is not None:
-        try:
-            return int(value)
-        except (TypeError, ValueError):
-            logger.debug(
-                "Invalid integer override for %s: %r", env_name, value
-            )
-            return None
-    env_val = os.getenv(env_name)
-    if env_val and env_val.strip():
-        try:
-            return int(env_val)
-        except ValueError:
-            logger.debug("Invalid integer from env %s: %r", env_name, env_val)
-    return None
-
-
 class OpenAIAgentsInstrumentor(BaseInstrumentor):
     """Instrumentation that bridges OpenAI Agents tracing to OpenTelemetry."""
 
@@ -198,20 +157,12 @@ def _instrument(self, **kwargs) -> None:
             metrics_override = os.getenv(_CAPTURE_METRICS_ENV)
         metrics_enabled = _resolve_bool(metrics_override, default=True)
 
-        agent_name = _resolve_optional_str(
-            kwargs.get("agent_name"), _AGENT_NAME_ENV
-        )
-        agent_id = _resolve_optional_str(kwargs.get("agent_id"), _AGENT_ID_ENV)
-        agent_description = _resolve_optional_str(
-            kwargs.get("agent_description"), _AGENT_DESCRIPTION_ENV
-        )
-        base_url = _resolve_optional_str(kwargs.get("base_url"), _BASE_URL_ENV)
-        server_address = _resolve_optional_str(
-            kwargs.get("server_address"), _SERVER_ADDRESS_ENV
-        )
-        server_port = _resolve_optional_int(
-            kwargs.get("server_port"), _SERVER_PORT_ENV
-        )
+        agent_name = kwargs.get("agent_name")
+        agent_id = kwargs.get("agent_id")
+        agent_description = kwargs.get("agent_description")
+        base_url = kwargs.get("base_url")
+        server_address = kwargs.get("server_address")
+        server_port = kwargs.get("server_port")
 
         processor = GenAISemanticProcessor(
             tracer=tracer,
@@ -226,6 +177,12 @@ def _instrument(self, **kwargs) -> None:
             base_url=base_url,
             server_address=server_address,
             server_port=server_port,
+            agent_name_default="OpenAI Agent",
+            agent_id_default="agent",
+            agent_description_default="OpenAI Agents instrumentation",
+            base_url_default="https://api.openai.com",
+            server_address_default="api.openai.com",
+            server_port_default=443,
         )
 
         tracing = _load_tracing_module()

instrumentation-genai/opentelemetry-instrumentation-openai-agents-v2/src/opentelemetry/instrumentation/openai_agents/genai_semantic_processor.py

@@ -270,6 +270,12 @@ def __init__(
         server_address: Optional[str] = None,
         server_port: Optional[int] = None,
         metrics_enabled: bool = True,
+        agent_name_default: Optional[str] = None,
+        agent_id_default: Optional[str] = None,
+        agent_description_default: Optional[str] = None,
+        base_url_default: Optional[str] = None,
+        server_address_default: Optional[str] = None,
+        server_port_default: Optional[int] = None,
     ):
         """Initialize processor with metrics support.
 
@@ -291,22 +297,31 @@ def __init__(
         self.include_sensitive_data = include_sensitive_data and (
             content_mode.capture_in_span or content_mode.capture_in_event
         )
-        self.base_url = base_url
+        effective_base_url = base_url or base_url_default
+        self.base_url = effective_base_url
         # Legacy emission removed; parameter retained for compatibility but unused
         self.emit_legacy = False
 
         # Agent information - prefer explicit overrides; otherwise defer to span data
         self.agent_name = agent_name
         self.agent_id = agent_id
         self.agent_description = agent_description
+        self._agent_name_default = agent_name_default
+        self._agent_id_default = agent_id_default
+        self._agent_description_default = agent_description_default
 
         # Server information - use init parameters, then base_url inference
-        self.server_address = server_address
-        self.server_port = server_port
+        self.server_address = server_address or server_address_default
+        resolved_port = (
+            server_port if server_port is not None else server_port_default
+        )
+        self.server_port = resolved_port
 
         # If server info not provided, try to extract from base_url
-        if (not self.server_address or not self.server_port) and base_url:
-            server_attrs = _infer_server_attributes(base_url)
+        if (
+            not self.server_address or not self.server_port
+        ) and effective_base_url:
+            server_attrs = _infer_server_attributes(effective_base_url)
             if not self.server_address:
                 self.server_address = server_attrs.get("server.address")
             if not self.server_port:
@@ -1139,6 +1154,8 @@ def on_span_start(self, span: Span[Any]) -> None:
         agent_name = self.agent_name
         if not agent_name and _is_instance_of(span.span_data, AgentSpanData):
             agent_name = getattr(span.span_data, "name", None)
+        if not agent_name:
+            agent_name = self._agent_name_default
 
         tool_name = (
             getattr(span.span_data, "name", None)
@@ -1157,12 +1174,17 @@ def on_span_start(self, span: Span[Any]) -> None:
         # Legacy emission removed
 
         # Add configured agent and server attributes
-        if self.agent_name:
-            attributes[GEN_AI_AGENT_NAME] = self.agent_name
-        if self.agent_id:
-            attributes[GEN_AI_AGENT_ID] = self.agent_id
-        if self.agent_description:
-            attributes[GEN_AI_AGENT_DESCRIPTION] = self.agent_description
+        agent_name_override = self.agent_name or self._agent_name_default
+        agent_id_override = self.agent_id or self._agent_id_default
+        agent_desc_override = (
+            self.agent_description or self._agent_description_default
+        )
+        if agent_name_override:
+            attributes[GEN_AI_AGENT_NAME] = agent_name_override
+        if agent_id_override:
+            attributes[GEN_AI_AGENT_ID] = agent_id_override
+        if agent_desc_override:
+            attributes[GEN_AI_AGENT_DESCRIPTION] = agent_desc_override
         attributes.update(self._get_server_attributes())
 
         otel_span = self._tracer.start_span(
@@ -1328,12 +1350,17 @@ def _extract_genai_attributes(
         # Legacy emission removed
 
         # Add configured agent attributes (always include when set)
-        if self.agent_name:
-            yield GEN_AI_AGENT_NAME, self.agent_name
-        if self.agent_id:
-            yield GEN_AI_AGENT_ID, self.agent_id
-        if self.agent_description:
-            yield GEN_AI_AGENT_DESCRIPTION, self.agent_description
+        agent_name_override = self.agent_name or self._agent_name_default
+        agent_id_override = self.agent_id or self._agent_id_default
+        agent_desc_override = (
+            self.agent_description or self._agent_description_default
+        )
+        if agent_name_override:
+            yield GEN_AI_AGENT_NAME, agent_name_override
+        if agent_id_override:
+            yield GEN_AI_AGENT_ID, agent_id_override
+        if agent_desc_override:
+            yield GEN_AI_AGENT_DESCRIPTION, agent_desc_override
 
         # Server attributes
         for key, value in self._get_server_attributes().items():
@@ -1493,16 +1520,26 @@ def _get_attributes_from_agent_span_data(
         """Extract attributes from agent span."""
         yield GEN_AI_OPERATION_NAME, self._get_operation_name(span_data)
 
-        name = self.agent_name or getattr(span_data, "name", None)
+        name = (
+            self.agent_name
+            or getattr(span_data, "name", None)
+            or self._agent_name_default
+        )
         if name:
             yield GEN_AI_AGENT_NAME, name
 
-        agent_id = self.agent_id or getattr(span_data, "agent_id", None)
+        agent_id = (
+            self.agent_id
+            or getattr(span_data, "agent_id", None)
+            or self._agent_id_default
+        )
         if agent_id:
             yield GEN_AI_AGENT_ID, agent_id
 
-        description = self.agent_description or getattr(
-            span_data, "description", None
+        description = (
+            self.agent_description
+            or getattr(span_data, "description", None)
+            or self._agent_description_default
         )
         if description:
             yield GEN_AI_AGENT_DESCRIPTION, description

instrumentation-genai/opentelemetry-instrumentation-openai-agents-v2/tests/test_z_instrumentor_behaviors.py

@@ -44,43 +44,24 @@ def test_instrumentation_dependencies_exposed():
     assert instrumentor.instrumentation_dependencies() == _instruments
 
 
-def test_env_fallback_configuration(monkeypatch):
+def test_default_agent_configuration():
     set_trace_processors([])
     provider = TracerProvider()
     instrumentor = OpenAIAgentsInstrumentor()
 
-    monkeypatch.setenv(
-        "OTEL_INSTRUMENTATION_OPENAI_AGENTS_AGENT_NAME", "EnvAgent"
-    )
-    monkeypatch.setenv(
-        "OTEL_INSTRUMENTATION_OPENAI_AGENTS_AGENT_ID", "agent-env"
-    )
-    monkeypatch.setenv(
-        "OTEL_INSTRUMENTATION_OPENAI_AGENTS_AGENT_DESCRIPTION",
-        "Env provided description",
-    )
-    monkeypatch.setenv(
-        "OTEL_INSTRUMENTATION_OPENAI_AGENTS_BASE_URL",
-        "https://env.example.com",
-    )
-    monkeypatch.setenv(
-        "OTEL_INSTRUMENTATION_OPENAI_AGENTS_SERVER_ADDRESS", "env.example.com"
-    )
-    monkeypatch.setenv(
-        "OTEL_INSTRUMENTATION_OPENAI_AGENTS_SERVER_PORT",
-        "8080",
-    )
-
     try:
         instrumentor.instrument(tracer_provider=provider)
         processor = instrumentor._processor
         assert processor is not None
-        assert processor.agent_name == "EnvAgent"
-        assert processor.agent_id == "agent-env"
-        assert processor.agent_description == "Env provided description"
-        assert processor.base_url == "https://env.example.com"
-        assert processor.server_address == "env.example.com"
-        assert processor.server_port == 8080
+        assert getattr(processor, "_agent_name_default") == "OpenAI Agent"
+        assert getattr(processor, "_agent_id_default") == "agent"
+        assert (
+            getattr(processor, "_agent_description_default")
+            == "OpenAI Agents instrumentation"
+        )
+        assert processor.base_url == "https://api.openai.com"
+        assert processor.server_address == "api.openai.com"
+        assert processor.server_port == 443
     finally:
         instrumentor.uninstrument()
         set_trace_processors([])