Get Started

Log In & Create a Phoenix Space

• Make a free Phoenix Cloud account

• Click the Create a Space button in the upper-right corner of the dashboard.

• Enter a name for your new space.

• After creating your space, launch your Phoenix instance directly from the dashboard.

You can navigate back to https://app.phoenix.arize.com/management/spaces anytime to manage your spaces.

Set Up Keys

To create a new API key, go to your Settings page & click down to the API Keys section. Click the Add System Key button, then provide a name for your API key. You may also include an optional description and set an expiration date if desired. All your API keys will be listed and manageable in this section.

System vs User API Keys

• System API keys represent the actions taken by the system as a whole (not tied to specific user)

• User API keys represent the actions of a particular user. They are tied to lifespan of the user that created them.

(optional) Add Collaborators

Phoenix Cloud supports team collaboration by allowing you to invite members to your space. You can also assign roles and permissions to manage access levels securely.

Roles

• Admins have full control over the space, including managing members, settings, system and user API keys, and roles.

• Members can access their own profile and manage their own user API keys

Adding Collaborators

On the Settings page, click the Add User button. Enter the user’s name, email address, and assign a role. The user will receive an email invitation to log in to the Phoenix instance.

Congratulations! You now have Phoenix up and running. From here, you can start sending traces, create and upload datasets, run experiments, and explore everything else Phoenix has to offer.

Continue to the next guide to send your first trace and begin working with Phoenix in action.

Install the Phoenix Library

Run the following command in your terminal to install Phoenix:

pip install arize-phoenix

Start Phoenix

Once installed, start the Phoenix server with:

phoenix serve

This will launch Phoenix locally and make the application available in your browser. It should look something like this:

Open Phoenix UI

Once Phoenix is running, you can open the UI directly from the links displayed in your terminal. By default, the Phoenix UI will be available at:

👉 http://localhost:6006

This launches the Phoenix dashboard in your browser, where you can begin exploring logs, traces, and other features.

Congratulations! You now have Phoenix up and running. From here, you can start sending traces, create and upload datasets, run experiments, and explore everything else Phoenix has to offer.

Continue to the next guide to send your first trace and begin working with Phoenix in action.

Prerequisites

1. Ensure Docker is installed and running on your system. You can verify this by running:

   Copy

   docker info

   If you don't see any server information in the output, make sure Docker is installed correctly and launch the Docker daemon.

2. Phoenix Version

   Our Docker Compose files are pegged to the latest release of Phoenix. If you want to use a different version, you can specify it in the docker-compose.yml file.

Some Optional Steps

1. Persistent Disc

   You can configure external disc storage to store your data in a SQLite databse

2. External Postgres

   You will need to set the PHOENIX_SQL_DATABASE_URL environment variable to the connection string for your Postgres instance.

Run Local Instance of Arize Phoenix

docker pull arizephoenix/phoenix

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

services:
  phoenix:
    image: arizephoenix/phoenix:latest
    ports:
      - "6006:6006"  # UI and OTLP HTTP collector
      - "4317:4317"  # OTLP gRPC collector
  backend:
    build:
      context: ./backend
      dockerfile: Dockerfile
      args:
        OPENAI_API_KEY: ${OPENAI_API_KEY}
    ports:
      - "8000:8000"
    environment:
      - OPENAI_API_KEY=${OPENAI_API_KEY}
      - COLLECTOR_ENDPOINT=http://phoenix:6006/v1/traces
      - PROD_CORS_ORIGIN=http://localhost:3000
      # Set INSTRUMENT_LLAMA_INDEX=false to disable instrumentation
      - INSTRUMENT_LLAMA_INDEX=true
    healthcheck:
      test: ["CMD", "wget", "--spider", "http://0.0.0.0:8000/api/chat/healthcheck"]
      interval: 5s
      timeout: 1s
      retries: 5
  frontend:
    build: frontend
    ports:
      - "3000:3000"
    depends_on:
      backend:
        condition: service_healthy

docker compose up

# docker-compose.yml
services:
  phoenix:
    image: arizephoenix/phoenix:latest # Must be greater than 4.0 version to work
    depends_on:
      - db
    ports:
      - 6006:6006  # PHOENIX_PORT
      - 4317:4317  # PHOENIX_GRPC_PORT
      - 9090:9090  # [Optional] PROMETHEUS PORT IF ENABLED
    environment:
      - PHOENIX_SQL_DATABASE_URL=postgresql://postgres:postgres@db:5432/postgres
  db:
    image: postgres
    restart: always
    environment:
      - POSTGRES_USER=postgres
      - POSTGRES_PASSWORD=postgres
      - POSTGRES_DB=postgres
    ports:
      - 5432
    volumes:
      - database_data:/var/lib/postgresql/data
volumes:
  database_data:
    driver: local

docker compose up --build

# docker-compose.yml
services:
  phoenix:
    image: arizephoenix/phoenix:latest # Must be greater than 4.0 version to work
    ports:
      - 6006:6006  # PHOENIX_PORT
      - 4317:4317  # PHOENIX_GRPC_PORT
      - 9090:9090  # [Optional] PROMETHEUS PORT IF ENABLED
    environment:
      - PHOENIX_WORKING_DIR=/mnt/data
    volumes:
      - phoenix_data:/mnt/data   # PHOENIX_WORKING_DIR
volumes:
  phoenix_data:
    driver: local

Congratulations! You now have Phoenix up and running. From here, you can start sending traces, create and upload datasets, run experiments, and explore everything else Phoenix has to offer.

Continue to the next guide to send your first trace and begin working with Phoenix in action.