Add OpenAI Agents manual and zero-code examples

Author: nagkumar91

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

@@ -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,37 @@
+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. Update the `.env <.env>`_ file 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
+
+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,63 @@
+# pylint: skip-file
+"""Manual OpenAI Agents instrumentation example."""
+
+from __future__ import annotations
+
+from agents import Agent, Runner, function_tool
+
+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:
+    configure_otel()
+    run_agent()
+
+
+if __name__ == "__main__":
+    main()

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

@@ -0,0 +1,5 @@
+openai-agents~=0.3.3
+
+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

@@ -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

instrumentation-genai/opentelemetry-instrumentation-openai-agents/examples/zero-code/README.rst

@@ -0,0 +1,37 @@
+OpenTelemetry OpenAI Agents Zero-Code Instrumentation Example
+=============================================================
+
+This example shows how to capture telemetry from OpenAI Agents without
+changing your application code by using ``opentelemetry-instrument``.
+
+When `main.py <main.py>`_ is executed, spans describing the agent workflow are
+exported to the configured OTLP endpoint. The spans include details such as the
+operation name, tool usage, and token consumption (when available).
+
+Setup
+-----
+
+1. Update the `.env <.env>`_ file with your real ``OPENAI_API_KEY``. Adjust the
+   OTLP endpoint settings if your collector is not reachable via
+   ``http://localhost:4317``.
+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 via ``opentelemetry-instrument`` so the OpenAI Agents
+instrumentation is activated automatically:
+
+::
+
+    dotenv run -- opentelemetry-instrument python main.py
+
+You should see the agent response printed to the console while spans export to
+your observability backend.

instrumentation-genai/opentelemetry-instrumentation-openai-agents/examples/zero-code/main.py

@@ -0,0 +1,39 @@
+"""Zero-code OpenAI Agents example."""
+
+from __future__ import annotations
+
+from agents import Agent, Runner, function_tool
+
+
+@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:
+    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:
+    run_agent()
+
+
+if __name__ == "__main__":
+    main()

instrumentation-genai/opentelemetry-instrumentation-openai-agents/examples/zero-code/requirements.txt

@@ -0,0 +1,6 @@
+openai-agents~=0.3.3
+
+opentelemetry-sdk~=1.36.0
+opentelemetry-exporter-otlp-proto-grpc~=1.36.0
+opentelemetry-distro~=0.57b0
+opentelemetry-instrumentation-openai-agents~=0.1.0.dev