OpenInference OpenAI Agents Instrumentation

pypi

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 or Arize AX.

Compatibility

openinference-instrumentation-openai-agents openai-agents Python
>=2.0 >=0.11.0 >=3.10, <3.15
>=1.4.1, <2.0 >=0.2.6 >=3.10, <3.15
>=1.2.0, <1.4.1 >=0.2.6 >=3.9, <3.14
>=1.0.0, <1.2.0 >=0.1.0 >=3.9, <3.14
<1.0.0 >=0.0.3 >=3.9, <3.14

Instrumentor >=2.0 requires openai-agents>=0.11.0. Three things changed below that floor which the instrumentor no longer accommodates: the run internals moved out of agents._run_impl into agents.run_internal in 0.8.0, openai-agents moved from openai<2 to openai>=2.9 in the same release, and tool namespaces (agents.tool_namespace) arrived in 0.11.0. Tools grouped by a namespace report tool.description and tool.parameters only on instrumentor >=2.0.

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

Realtime audio

OpenAIAgentsInstrumentor().instrument(...) also traces agents.realtime.RealtimeSession (the OpenAI Agents SDK's voice/audio runtime) when the realtime extras are installed. No additional setup is required — instrument(...) applies the realtime patches whenever agents.realtime is importable.

For each turn the instrumentor produces this span tree:

AUDIO   "conversation.turn"     ← parent; aggregated input/output transcripts, llm.model_name, llm.invocation_parameters
├─ USER  "user"                 ← input.audio.url (WAV data URI), input.audio.transcript, or input.value for text input
├─ LLM   "assistant"            ← output.audio.url, output.audio.transcript, token counts, time_to_first_token_ms
│  └─ TOOL "<tool_name>"        ← one per function call within the turn
└─ ...                          ← additional USER / LLM siblings for split input or tool round-trips

A runnable mic/speaker example with two function tools lives at examples/realtime_with_tools.py.

Audio redaction

The realtime instrumentor recognizes three environment variables for redacting captured audio:

  • OPENINFERENCE_HIDE_INPUT_AUDIO — when truthy (1 / true / yes / on), drops input.audio.url, input.audio.mime_type, and input.audio.transcript from USER spans. Default: false.
  • OPENINFERENCE_HIDE_OUTPUT_AUDIO — same shape, drops the output.audio.* attributes from LLM spans. Default: false.
  • OPENINFERENCE_BASE64_AUDIO_MAX_LENGTH — caps the base64 payload length of audio data: URIs. The data:audio/wav;base64, prefix is always preserved. Default: 32000.

TraceConfig(hide_inputs=True) and TraceConfig(hide_outputs=True) also cascade to the corresponding audio attributes.

More Info

Project links

Data verified by PyPI on Aug 24, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (2.0.2)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for arizeai from gravatar.com arizeai

Credits

Author: OpenInference Authors

GitHub Statistics

Data verified by PyPI on Aug 24, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

Apache-2.0
View SPDX License List

Requires

Python <3.15, >=3.10

Provides Extra

instruments

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openinference_instrumentation_openai_agents-2.0.1.tar.gz (31.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openinference_instrumentation_openai_agents-2.0.1-py3-none-any.whl (34.4 kB view details)

Uploaded Python 3

File details

Details for the file openinference_instrumentation_openai_agents-2.0.1.tar.gz.

File metadata

File hashes

Hashes for openinference_instrumentation_openai_agents-2.0.1.tar.gz
Algorithm Hash digest
SHA256 020de5980e0a545a1587d7f8c7cc528830e82b2003dd1720218552ecd3d58c6b
MD5 eb847d0b761c0029aed3f259d0eacd01
BLAKE2b-256 cd89044a330481b8204605f689bd95b621799c73f2d257db4d5b1937300d01f1

See more details on using hashes here.

Provenance

The following attestation bundles were made for openinference_instrumentation_openai_agents-2.0.1.tar.gz:

Publisher: publish.yaml on Arize-ai/openinference

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file openinference_instrumentation_openai_agents-2.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for openinference_instrumentation_openai_agents-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 778a7a21abb80d8657ed0461ebde075e35af1f3f5125d6aa22de517d8f945644
MD5 0f8c54e5247f9d500f72ee365624b26b
BLAKE2b-256 296efab4bc9467b4704a992242bd8eae0d73f0d871ba93aac93b03100c4e0885

See more details on using hashes here.

Provenance

The following attestation bundles were made for openinference_instrumentation_openai_agents-2.0.1-py3-none-any.whl:

Publisher: publish.yaml on Arize-ai/openinference

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

2.0.2

2 files

This release

2.0.1 This release

2 files

2.0.0

2 files

1.6.2

2 files

1.6.1

2 files

1.6.0

2 files

1.5.1

2 files

1.5.0

2 files

1.4.3

2 files

1.4.2

2 files

1.4.1

2 files

1.4.0

2 files

1.3.1

2 files

1.3.0

2 files

1.2.0

2 files

1.1.1

2 files

1.1.0

2 files

1.0.0

2 files

0.1.14

2 files

0.1.13

2 files

0.1.12

2 files

0.1.11

2 files

0.1.10

2 files

0.1.9

2 files

0.1.8

2 files

0.1.7

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page