Merge branch 'main' into feature/genai-genai-spec-updates

Author: nagkumar91

docs/nitpick-exceptions.ini

@@ -45,6 +45,7 @@ py-class=
     psycopg.AsyncConnection
     ObjectProxy
     fastapi.applications.FastAPI
+    _contextvars.Token
 
 any=
     ; API

instrumentation-genai/opentelemetry-instrumentation-google-genai/examples/manual/main.py

@@ -22,8 +22,7 @@
 
 import google.genai
 
-# NOTE: OpenTelemetry Python Logs and Events APIs are in beta
-from opentelemetry import _events as otel_events
+# NOTE: OpenTelemetry Python Logs API is in beta
 from opentelemetry import _logs as otel_logs
 from opentelemetry import metrics as otel_metrics
 from opentelemetry import trace as otel_trace
@@ -40,7 +39,6 @@
     GoogleGenAiSdkInstrumentor,
 )
 from opentelemetry.instrumentation.requests import RequestsInstrumentor
-from opentelemetry.sdk._events import EventLoggerProvider
 from opentelemetry.sdk._logs import LoggerProvider
 from opentelemetry.sdk._logs.export import BatchLogRecordProcessor
 from opentelemetry.sdk.metrics import MeterProvider
@@ -56,12 +54,11 @@ def setup_otel_tracing():
     )
 
 
-def setup_otel_logs_and_events():
+def setup_otel_logs():
     otel_logs.set_logger_provider(LoggerProvider())
     otel_logs.get_logger_provider().add_log_record_processor(
         BatchLogRecordProcessor(OTLPLogExporter())
     )
-    otel_events.set_event_logger_provider(EventLoggerProvider())
 
 
 def setup_otel_metrics():
@@ -77,7 +74,7 @@ def setup_otel_metrics():
 
 def setup_opentelemetry():
     setup_otel_tracing()
-    setup_otel_logs_and_events()
+    setup_otel_logs()
     setup_otel_metrics()
 
 

instrumentation-genai/opentelemetry-instrumentation-google-genai/pyproject.toml

@@ -37,7 +37,7 @@ classifiers = [
   "Programming Language :: Python :: 3.12"
 ]
 dependencies = [
-  "opentelemetry-api >=1.37, <2",
+  "opentelemetry-api ~=1.37",
   "opentelemetry-instrumentation >=0.52b1, <2",
   "opentelemetry-semantic-conventions >=0.52b1, <2"
 ]

instrumentation-genai/opentelemetry-instrumentation-openai-agents/.gitignore

@@ -1,2 +1,3 @@
 examples/.env
 examples/openai_agents_multi_agent_travel/.env
+examples/**/.env

instrumentation-genai/opentelemetry-instrumentation-openai-agents/CHANGELOG.md

@@ -9,3 +9,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial barebones package skeleton: minimal instrumentor stub, version module,
   and packaging metadata/entry point.
+  ([#3805](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3805))
+- Implement OpenAI Agents span processing aligned with GenAI semantic conventions.
+  ([#3817](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3817))

instrumentation-genai/opentelemetry-instrumentation-openai-agents/examples/manual/.env.example

@@ -0,0 +1,11 @@
+# Update this with your real OpenAI API key
+OPENAI_API_KEY=sk-YOUR_API_KEY
+
+# Uncomment and adjust if you use a non-default OTLP collector endpoint
+# OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317
+# OTEL_EXPORTER_OTLP_PROTOCOL=grpc
+
+OTEL_SERVICE_NAME=opentelemetry-python-openai-agents-manual
+
+# Optionally override the agent name reported on spans
+# OTEL_GENAI_AGENT_NAME=Travel Concierge

instrumentation-genai/opentelemetry-instrumentation-openai-agents/examples/manual/README.rst

@@ -0,0 +1,42 @@
+OpenTelemetry OpenAI Agents Instrumentation Example
+===================================================
+
+This example demonstrates how to manually configure the OpenTelemetry SDK
+alongside the OpenAI Agents instrumentation.
+
+Running `main.py <main.py>`_ produces spans for the end-to-end agent run,
+including tool invocations and model generations. Spans are exported through
+OTLP/gRPC to the endpoint configured in the environment.
+
+Setup
+-----
+
+1. Copy `.env.example <.env.example>`_ to `.env` and update it with your real
+   ``OPENAI_API_KEY``. If your
+   OTLP collector is not reachable via ``http://localhost:4317``, adjust the
+   endpoint variables as needed.
+2. Create a virtual environment and install the dependencies:
+
+   ::
+
+       python3 -m venv .venv
+       source .venv/bin/activate
+       pip install "python-dotenv[cli]"
+       pip install -r requirements.txt
+
+Run
+---
+
+Execute the sample with ``dotenv`` so the environment variables from ``.env``
+are applied:
+
+::
+
+    dotenv run -- python main.py
+
+The script automatically loads environment variables from ``.env`` so running
+``python main.py`` directly also works if the shell already has the required
+values exported.
+
+You should see the agent response printed to the console while spans export to
+your configured observability backend.

instrumentation-genai/opentelemetry-instrumentation-openai-agents/examples/manual/main.py

@@ -0,0 +1,65 @@
+# pylint: skip-file
+"""Manual OpenAI Agents instrumentation example."""
+
+from __future__ import annotations
+
+from agents import Agent, Runner, function_tool
+from dotenv import load_dotenv
+
+from opentelemetry import trace
+from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import (
+    OTLPSpanExporter,
+)
+from opentelemetry.instrumentation.openai_agents import (
+    OpenAIAgentsInstrumentor,
+)
+from opentelemetry.sdk.trace import TracerProvider
+from opentelemetry.sdk.trace.export import BatchSpanProcessor
+
+
+def configure_otel() -> None:
+    """Configure the OpenTelemetry SDK for exporting spans."""
+
+    provider = TracerProvider()
+    provider.add_span_processor(BatchSpanProcessor(OTLPSpanExporter()))
+    trace.set_tracer_provider(provider)
+
+    OpenAIAgentsInstrumentor().instrument(tracer_provider=provider)
+
+
+@function_tool
+def get_weather(city: str) -> str:
+    """Return a canned weather response for the requested city."""
+
+    return f"The forecast for {city} is sunny with pleasant temperatures."
+
+
+def run_agent() -> None:
+    """Create a simple agent and execute a single run."""
+
+    assistant = Agent(
+        name="Travel Concierge",
+        instructions=(
+            "You are a concise travel concierge. Use the weather tool when the"
+            " traveler asks about local conditions."
+        ),
+        tools=[get_weather],
+    )
+
+    result = Runner.run_sync(
+        assistant,
+        "I'm visiting Barcelona this weekend. How should I pack?",
+    )
+
+    print("Agent response:")
+    print(result.final_output)
+
+
+def main() -> None:
+    load_dotenv()
+    configure_otel()
+    run_agent()
+
+
+if __name__ == "__main__":
+    main()

instrumentation-genai/opentelemetry-instrumentation-openai-agents/examples/manual/requirements.txt

@@ -0,0 +1,6 @@
+openai-agents~=0.3.3
+python-dotenv~=1.0
+
+opentelemetry-sdk~=1.36.0
+opentelemetry-exporter-otlp-proto-grpc~=1.36.0
+opentelemetry-instrumentation-openai-agents~=0.1.0.dev

instrumentation-genai/opentelemetry-instrumentation-openai-agents/examples/zero-code/.env.example

@@ -0,0 +1,14 @@
+# Update this with your real OpenAI API key
+OPENAI_API_KEY=sk-YOUR_API_KEY
+
+# Uncomment and adjust if you use a non-default OTLP collector endpoint
+# OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317
+# OTEL_EXPORTER_OTLP_PROTOCOL=grpc
+
+OTEL_SERVICE_NAME=opentelemetry-python-openai-agents-zero-code
+
+# Enable auto-instrumentation for logs if desired
+OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED=true
+
+# Optionally override the agent name reported on spans
+# OTEL_GENAI_AGENT_NAME=Travel Concierge