OpenInference OpenAI Instrumentation

Python auto-instrumentation library for OpenAI's 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.

Installation

pip install openinference-instrumentation-openai

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 "openai>=1.26" 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.

python -m phoenix.server.main serve

In a python file, setup the OpenAIInstrumentor and configure the tracer to send traces to Phoenix.

import openai
from openinference.instrumentation.openai import OpenAIInstrumentor
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()))

OpenAIInstrumentor().instrument(tracer_provider=tracer_provider)


if __name__ == "__main__":
    client = openai.OpenAI()
    response = client.chat.completions.create(
        model="gpt-3.5-turbo",
        messages=[{"role": "user", "content": "Write a haiku."}],
        max_tokens=20,
        stream=True,
        stream_options={"include_usage": True},
    )
    for chunk in response:
        if chunk.choices and (content := chunk.choices[0].delta.content):
            print(content, end="")

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

FAQ

Q: How to get token counts when streaming?

A: To get token counts when streaming, install openai>=1.26 and set stream_options={"include_usage": True} when calling create. See the example shown above. For more info, see here.

More Info

Release files for openinference-instrumentation-openai 0.1.58

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openinference-instrumentation-openai 0.1.58
File	Size	Uploaded
openinference_instrumentation_openai-0.1.58.tar.gz	23.7 kB	Sep 4, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for openinference-instrumentation-openai 0.1.58
File	Interpreter	ABI	Platform	Reset
openinference_instrumentation_openai-0.1.58-py3-none-any.whl 31.3 kB Sep 4, 2026	Python 3	none	any	Details

Total release size: 55.1 kB

Release files / openinference_instrumentation_openai-0.1.58.tar.gz

Download URL	openinference_instrumentation_openai-0.1.58.tar.gz
Size	23.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`2ceabffdb126cc0f0dd82728ed4141c5bdf6124bdd2a6df65c2a994564e81aa8`
BLAKE2b-256 checksum How to use checksums	`60ed4664bcbfe458e4ff85388add861c3bc9684519ea440f52925885b0e9cd45`
Upload date	Sep 4, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/Arize-ai/openinference
Publishing commit: github.com/Arize-ai/openinference/tree/165627009da577e3762a8268845471bd41f65363

Workflow

Publishing configuration: github.com/Arize-ai/openinference/blob/165627009da577e3762a8268845471bd41f65363/.github/workflows/publish.yaml
Publishing logs: github.com/Arize-ai/openinference/actions/runs/33915302019/attempts/1

Artifact

Subject: openinference_instrumentation_openai-0.1.58.tar.gz
SHA-256 checksum: 2ceabffdb126cc0f0dd82728ed4141c5bdf6124bdd2a6df65c2a994564e81aa8 Verifying attestations

Release files / openinference_instrumentation_openai-0.1.58-py3-none-any.whl

Download URL	openinference_instrumentation_openai-0.1.58-py3-none-any.whl
Size	31.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`276e6dc951c466adebbf9c8788adc10741175ac5f40a56eefcf638475db1d9f8`
BLAKE2b-256 checksum How to use checksums	`2764ab5ec95e8c0aa144086c4615a0d554bcb48fb65bfe6bb6d780134279edee`
Upload date	Sep 4, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/Arize-ai/openinference
Publishing commit: github.com/Arize-ai/openinference/tree/165627009da577e3762a8268845471bd41f65363

Workflow

Publishing configuration: github.com/Arize-ai/openinference/blob/165627009da577e3762a8268845471bd41f65363/.github/workflows/publish.yaml
Publishing logs: github.com/Arize-ai/openinference/actions/runs/33915302019/attempts/1

Artifact

Subject: openinference_instrumentation_openai-0.1.58-py3-none-any.whl
SHA-256 checksum: 276e6dc951c466adebbf9c8788adc10741175ac5f40a56eefcf638475db1d9f8 Verifying attestations