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 27, 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.1.1)

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 27, 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.1.0.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.1.0-py3-none-any.whl (34.4 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for openinference_instrumentation_openai_agents-2.1.0.tar.gz
Algorithm Hash digest
SHA256 602d93361d255b88350ace024205875af7444775999e2549127fa452665270f7
MD5 b26e6d2d9b2da39fae08a2ef1c3b4e6f
BLAKE2b-256 ae05a919d27d03cdb657ba9c1cd1d6e02ee51157baa5c03ad43383d84372adcf

See more details on using hashes here.

Provenance

The following attestation bundles were made for openinference_instrumentation_openai_agents-2.1.0.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.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for openinference_instrumentation_openai_agents-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a6b7688d4280d71e25d6c12f5bfd0937d93796400238ab5e03ba109402c0b09f
MD5 d8da265a9d5fcd6e4fd031f94b1475f8
BLAKE2b-256 8e642d291bb8116b370ae72b95a5806067fe5fb60a401cbeb871aa47872e3cb3

See more details on using hashes here.

Provenance

The following attestation bundles were made for openinference_instrumentation_openai_agents-2.1.0-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.1.1

2 files

This release

2.1.0 This release

2 files

2.0.2

2 files

2.0.1

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

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page