Quickstart

The easiest way to run Phoenix is locally in your own computer. To launch Phoenix, use the following steps.

Install

Using pip

pip install arize-phoenix

Using conda

conda install -c conda-forge arize-phoenix

Docker

Phoenix server images are available via Docker Hub and can be used via docker compose or if you simply want a long-running phoenix instance to share with your team.

docker pull arizephoenix/phoenix:latest

app.phoenix.arize.com

If you don't want to host an instance of Phoenix yourself or use a notebook instance, you can use a persistent instance provided on our site. Sign up for an Arize Phoenix account at https://app.phoenix.arize.com/login

For more details, see Hosted Phoenix

Launch Phoenix

Launching phoenix can be done in many ways depending on your use-case.

Command Line

Launch your local Phoenix instance using:

python3 -m phoenix.server.main serve

For details on customizing a local terminal deployment, see Terminal Setup.

Docker

Launch the phoenix docker image using:

docker run -p 6006:6006 -p 4317:4317 arizephoenix/phoenix:latest

This will expose the Phoenix UI and REST API on localhost:6006 and exposes the gRPC endpoint for spans on localhost:4317

For more details on customizing a docker deployment, see Docker

Notebook

Within your notebook, launch Phoenix using:

import phoenix as px
px.launch_app()

By default, notebook instances do not have persistent storage, so your traces will disappear after the notebook is closed. See Persistence or use one of the other deployment options to retain traces.

app.phoenix.arize.com

Hosted Phoenix instances are always online. Nothing more to do here!

Connect your App

To collect traces from your application, you must configure an OpenTelemetry TracerProvider to send traces to Phoenix. The register utility from the phoenix.otel module streamlines this process.

Python

If arize-phoenix is not installed in your python environment, you can use arize-phoenix-otel to quickly connect to your phoenix instance.

pip install arize-phoenix-otel

Connect your application to your instance using:

from phoenix.otel import register

# defaults to endpoint="http://localhost:4317"
register(
  project_name="my-llm-app", # Default is 'default'
  endpoint="http://localhost:4317",  # Sends traces using gRPC
)  

You do not have to use phoenix.otel to connect to your phoenix instance, you can use OpenTelemetry itself to initialize your OTEL connection. SeeUsing OTEL Python Directly

See Setup Tracing: Python for more details on configuration and setup

TypeScript

For setting up tracing and OpenTelemetry with TypeScript, see Setup Tracing: TS

Notebook

Connect your notebook to Phoenix:

from phoenix.otel import register

# defaults to endpoint="http://localhost:4317"
register(
  project_name="my-llm-app", # Default is 'default'
  endpoint="http://localhost:4317",  # Sends traces using gRPC
) 

app.phoenix.arize.com

If arize-phoenix is not installed in your python environment, you can use arize-phoenix-otel to quickly connect to your phoenix instance.

pip install arize-phoenix-otel

Connect your application to your cloud instance using:

import os
from phoenix.otel import register

# Add Phoenix API Key for tracing
os.environ["PHOENIX_CLIENT_HEADERS"] = "api_key=...:..."

# configure the Phoenix tracer
register(
  project_name="my-llm-app", # Default is 'default'
  endpoint="https://app.phoenix.arize.com/v1/traces",
) 

Your Phoenix API key can be found on the Keys section of your dashboard.

Next Steps

• Trace a running application

• Run evaluations on traces

• Test changes to you prompts, models, and application via experiments