Arize-OTel

0.12.0 · active · verified Thu Apr 16

Arize-OTel is a helper package designed to streamline OpenTelemetry (OTel) setup for sending traces to Arize AI and Arize Phoenix. It simplifies instrumenting Python applications by providing pre-configured exporters and an instrumentor for common libraries, enabling quick observability integration. The current version is 0.12.0, and the project maintains a regular release cadence for new features, bug fixes, and dependency updates.

Common errors

```
ImportError: cannot import name 'configure_opentelemetry_for_arize' from 'arize_otel.tracing.config'
```
cause The function `configure_opentelemetry_for_arize` was renamed to `configure_opentelemetry_for_arize_phoenix` in version 0.10.0.

fix Update your import and function call to `from arize_otel.tracing.config import configure_opentelemetry_for_arize_phoenix`.
```
ModuleNotFoundError: No module named 'arize_phoenix.data' (or 'arize_phoenix.evals')
```
cause The core `arize-otel` installation does not include all optional dependencies for `arize-phoenix`'s data and evals components.

fix Install `arize-otel` with the necessary extras: `pip install "arize-otel[data,evals]"`.
```
My Flask/Requests/Django application is not being automatically traced, even with ArizeInstrumentor().instrument() called.
```
cause Automatic instrumentation relies on specific `opentelemetry-instrumentation-*` packages for each library. These must be installed separately.

fix Ensure you have installed the relevant instrumentation package (e.g., `pip install opentelemetry-instrumentation-requests` for `requests`) in addition to `arize-otel`.

Warnings

breaking The primary configuration function `configure_opentelemetry_for_arize` was renamed to `configure_opentelemetry_for_arize_phoenix` in `arize-otel` version 0.10.0.
Fix: Update your import statement and function call to `from arize_otel.tracing.config import configure_opentelemetry_for_arize_phoenix`.
gotcha To utilize all features of Arize Phoenix (e.g., data visualization, evaluations), you must install `arize-otel` with the `data` and `evals` extras.
Fix: Install using `pip install "arize-otel[data,evals]"`.
gotcha Automatic instrumentation of third-party libraries (like `requests`, `flask`, `django`, `fastapi`) requires their respective `opentelemetry-instrumentation-*` packages to be installed alongside `arize-otel` and `ArizeInstrumentor().instrument()` to be called.
Fix: For example, to instrument `requests`, run `pip install opentelemetry-instrumentation-requests` and ensure `ArizeInstrumentor().instrument()` is part of your setup.
gotcha Arize API and Space Keys (`ARIZE_API_KEY`, `ARIZE_SPACE_KEY`) are crucial for sending traces to Arize. Ensure these are provided either via environment variables or explicitly passed to `configure_opentelemetry_for_arize_phoenix`.
Fix: Set `export ARIZE_API_KEY='your_api_key'` and `export ARIZE_SPACE_KEY='your_space_key'` in your environment, or pass them as arguments: `configure_opentelemetry_for_arize_phoenix(arize_api_key='...', arize_space_key='...')`.

Install

pip install arize-otel Basic Installation
pip install "arize-otel[data,evals]" With Phoenix Data and Evals Features

Imports

configure_opentelemetry_for_arize_phoenix
wrong:
```
from arize_otel.tracing.config import configure_opentelemetry_for_arize
```
correct:
```
from arize_otel.tracing.config import configure_opentelemetry_for_arize_phoenix
```
The function name changed in v0.10.0 from `configure_opentelemetry_for_arize` to `configure_opentelemetry_for_arize_phoenix`.

ArizeInstrumentor

from arize_otel.tracing.instrumentation import ArizeInstrumentor

Quickstart

This quickstart initializes OpenTelemetry with Arize and Phoenix exporters, then demonstrates both manual and automatic instrumentation. Ensure `ARIZE_API_KEY` and `ARIZE_SPACE_KEY` environment variables are set for Arize and Phoenix is running locally if using the default host. For automatic instrumentation, relevant `opentelemetry-instrumentation-*` packages must be installed separately (e.g., `pip install opentelemetry-instrumentation-requests`).

import os
from opentelemetry import trace
from arize_otel.tracing.config import configure_opentelemetry_for_arize_phoenix
from arize_otel.tracing.instrumentation import ArizeInstrumentor

# Configure OpenTelemetry to send traces to Arize and Phoenix
# Ensure ARIZE_API_KEY and ARIZE_SPACE_KEY environment variables are set.
configure_opentelemetry_for_arize_phoenix(
    arize_api_key=os.environ.get("ARIZE_API_KEY", ""),
    arize_space_key=os.environ.get("ARIZE_SPACE_KEY", ""),
    phoenix_host="http://localhost:6006" # Optional: defaults to "http://localhost:6006"
)

# Manually instrument an application using OpenTelemetry Tracer
tracer = trace.get_tracer("my-arize-app")

with tracer.start_as_current_span("my-manual-span"):
    print("Performing some traced operation...")

# Automatically instrument common libraries (e.g., requests, flask, django)
# Ensure you have installed the respective opentelemetry-instrumentation- packages.
ArizeInstrumentor().instrument()

# Example using a common library (e.g., requests) which will be automatically traced
try:
    import requests
    response = requests.get("https://www.example.com")
    print(f"Requests response status: {response.status_code}")
except ImportError:
    print("Install 'opentelemetry-instrumentation-requests' to trace requests.")

print("Tracing configured and example operation completed.")

view raw JSON →