|
| 1 | +""" |
| 2 | +Content capture demo for the OpenAI Agents instrumentation. |
| 3 | +
|
| 4 | +This script spins up the instrumentation with message capture enabled and |
| 5 | +simulates an agent invocation plus a tool call using the tracing helpers from |
| 6 | +the ``openai-agents`` package. Spans are exported to the console so you can |
| 7 | +inspect captured prompts, responses, and tool payloads without making any |
| 8 | +OpenAI API calls. |
| 9 | +""" |
| 10 | + |
| 11 | +from __future__ import annotations |
| 12 | + |
| 13 | +import json |
| 14 | +import os |
| 15 | +from typing import Any |
| 16 | + |
| 17 | +from agents.tracing import agent_span, function_span, generation_span, trace |
| 18 | +from dotenv import load_dotenv |
| 19 | + |
| 20 | +from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import ( |
| 21 | + OTLPSpanExporter, |
| 22 | +) |
| 23 | +from opentelemetry.instrumentation.openai_agents import ( |
| 24 | + OpenAIAgentsInstrumentor, |
| 25 | +) |
| 26 | +from opentelemetry.sdk.resources import Resource |
| 27 | +from opentelemetry.sdk.trace import TracerProvider |
| 28 | +from opentelemetry.sdk.trace.export import BatchSpanProcessor |
| 29 | + |
| 30 | +load_dotenv() # take environment variables from .env. |
| 31 | + |
| 32 | + |
| 33 | +def configure_tracing() -> None: |
| 34 | + """Configure a tracer provider that exports spans via OTLP.""" |
| 35 | + resource = Resource.create( |
| 36 | + { |
| 37 | + "service.name": os.environ.get( |
| 38 | + "OTEL_SERVICE_NAME", "openai-agents-content-capture-demo" |
| 39 | + ) |
| 40 | + } |
| 41 | + ) |
| 42 | + provider = TracerProvider(resource=resource) |
| 43 | + provider.add_span_processor(BatchSpanProcessor(OTLPSpanExporter())) |
| 44 | + |
| 45 | + # Instrument with explicit content capture mode to ensure prompts/responses are recorded. |
| 46 | + OpenAIAgentsInstrumentor().instrument( |
| 47 | + tracer_provider=provider, |
| 48 | + capture_message_content="span_and_event", |
| 49 | + system="openai", |
| 50 | + agent_name="Travel Concierge", |
| 51 | + base_url="https://api.openai.com/v1", |
| 52 | + ) |
| 53 | + |
| 54 | + |
| 55 | +def dump(title: str, payload: Any) -> None: |
| 56 | + """Pretty-print helper used to show intermediate context.""" |
| 57 | + print(f"\n=== {title} ===") |
| 58 | + print(json.dumps(payload, indent=2)) |
| 59 | + |
| 60 | + |
| 61 | +def run_workflow() -> None: |
| 62 | + """Simulate an agent workflow with a generation and a tool invocation.""" |
| 63 | + itinerary_prompt = [ |
| 64 | + {"role": "system", "content": "Plan high level travel itineraries."}, |
| 65 | + { |
| 66 | + "role": "user", |
| 67 | + "content": "I'm visiting Paris for 3 days in November.", |
| 68 | + }, |
| 69 | + ] |
| 70 | + |
| 71 | + tool_args = {"city": "Paris", "date": "2025-11-12"} |
| 72 | + tool_result = { |
| 73 | + "forecast": "Mostly sunny, highs 15°C", |
| 74 | + "packing_tips": ["light jacket", "comfortable shoes"], |
| 75 | + } |
| 76 | + |
| 77 | + with trace("travel-booking-workflow"): |
| 78 | + with agent_span(name="travel_planner") as agent: |
| 79 | + dump( |
| 80 | + "Agent span started", |
| 81 | + {"span_id": agent.span_id, "trace_id": agent.trace_id}, |
| 82 | + ) |
| 83 | + |
| 84 | + with generation_span( |
| 85 | + input=itinerary_prompt, |
| 86 | + output=[ |
| 87 | + { |
| 88 | + "role": "assistant", |
| 89 | + "content": ( |
| 90 | + "Day 1 visit the Louvre, Day 2 tour Versailles, " |
| 91 | + "Day 3 explore Montmartre." |
| 92 | + ), |
| 93 | + } |
| 94 | + ], |
| 95 | + model="gpt-4o-mini", |
| 96 | + usage={ |
| 97 | + "input_tokens": 128, |
| 98 | + "output_tokens": 96, |
| 99 | + "total_tokens": 224, |
| 100 | + }, |
| 101 | + ): |
| 102 | + pass |
| 103 | + |
| 104 | + with function_span( |
| 105 | + name="fetch_weather", |
| 106 | + input=json.dumps(tool_args), |
| 107 | + output=tool_result, |
| 108 | + ): |
| 109 | + pass |
| 110 | + |
| 111 | + print( |
| 112 | + "\nWorkflow complete – spans exported to the configured OTLP endpoint." |
| 113 | + ) |
| 114 | + |
| 115 | + |
| 116 | +def main() -> None: |
| 117 | + configure_tracing() |
| 118 | + run_workflow() |
| 119 | + |
| 120 | + |
| 121 | +if __name__ == "__main__": |
| 122 | + main() |
0 commit comments