OpenInference OpenAI Agents Instrumentation
Python auto-instrumentation library for OpenAI Agents python SDK.
The traces emitted by this instrumentation are fully OpenTelemetry compatible and can be sent to an OpenTelemetry collector for viewing, such as arize-phoenix
Installation
pip install openinference-instrumentation-openai-agents
Quickstart
In this example we will instrument a small program that uses OpenAI and observe the traces via arize-phoenix.
Install packages.
pip install openinference-instrumentation-openai-agents arize-phoenix opentelemetry-sdk opentelemetry-exporter-otlp
Start the phoenix server so that it is ready to collect traces. The Phoenix server runs entirely on your machine and does not send data over the internet.
phoenix serve
In a python file, set up the OpenAIAgentsInstrumentor and configure the tracer to send traces to Phoenix.
from agents import Agent, Runner
from openinference.instrumentation.openai_agents import OpenAIAgentsInstrumentor
from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
from opentelemetry.sdk import trace as trace_sdk
from opentelemetry.sdk.trace.export import ConsoleSpanExporter, SimpleSpanProcessor
endpoint = "http://127.0.0.1:6006/v1/traces"
tracer_provider = trace_sdk.TracerProvider()
tracer_provider.add_span_processor(SimpleSpanProcessor(OTLPSpanExporter(endpoint)))
# Optionally, you can also print the spans to the console.
tracer_provider.add_span_processor(SimpleSpanProcessor(ConsoleSpanExporter()))
OpenAIAgentsInstrumentor().instrument(tracer_provider=tracer_provider)
agent = Agent(name="Assistant", instructions="You are a helpful assistant")
result = Runner.run_sync(agent, "Write a haiku about recursion in programming.")
print(result.final_output)
Since we are using OpenAI, we must set the OPENAI_API_KEY environment variable to authenticate with the OpenAI API.
export OPENAI_API_KEY=your-api-key
Now simply run the python file and observe the traces in Phoenix.
python your_file.py
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file openinference_instrumentation_openai_agents-0.1.10.tar.gz.
File metadata
- Download URL: openinference_instrumentation_openai_agents-0.1.10.tar.gz
- Upload date:
- Size: 11.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.13.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
785027a19382fa646c317fb1d2cdc5145ec0f095ebfaf1c8dd90384f49e55f14
|
|
| MD5 |
9c55e847d065668b13de5c4630765e37
|
|
| BLAKE2b-256 |
fbbbdf22a3e1d9e25ea0417fb8e56217daca51c884e4d0bac3f76acad610d204
|
File details
Details for the file openinference_instrumentation_openai_agents-0.1.10-py3-none-any.whl.
File metadata
- Download URL: openinference_instrumentation_openai_agents-0.1.10-py3-none-any.whl
- Upload date:
- Size: 13.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.13.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9235c550be87473d643b3f9b186a13b44f356b9b10ff4f44aef4b56558606c51
|
|
| MD5 |
0364f35173e0df12b5feccad86752b91
|
|
| BLAKE2b-256 |
a0ae85adcbf53331c74bb76278d5fd8d465576233af59ce9f8bc1ca90ce279ef
|
