Arize Trace Skill
Concepts
- Trace = a tree of spans sharing a , rooted at a span with
- Span = a single operation (LLM call, tool call, retriever, chain, agent)
- Session = a group of traces sharing (e.g., a multi-turn conversation)
Use
to download trace data. This is the only supported command for retrieving spans.
Exploratory export rule: When exporting spans or traces
without a specific
,
, or
(i.e., browsing/exploring a project), always start with
to pull a small sample first. Summarize what you find, then pull more data only if the user asks or the task requires it. This avoids slow queries and overwhelming output on large projects.
Default output directory: Always use
--output-dir .arize-tmp-traces
on every
call. The CLI automatically creates the directory and adds it to
.
Prerequisites
Three things are needed:
CLI, an API key (env var or profile), and a space ID. A project name is also needed but usually comes from the user's message.
Install ax
Verify
is installed and working before proceeding:
- Check if is on PATH: (Unix) or (Windows)
- If not found, check common install locations:
- macOS/Linux:
test -x ~/.local/bin/ax && export PATH="$HOME/.local/bin:$PATH"
- Windows: check
%APPDATA%\Python\Scripts\ax.exe
or %LOCALAPPDATA%\Programs\Python\Scripts\ax.exe
- If still not found, install it (requires shell access to install packages):
- Preferred:
uv tool install arize-ax-cli
- Alternative:
pipx install arize-ax-cli
- Fallback:
- After install, if is not on PATH:
- macOS/Linux:
export PATH="$HOME/.local/bin:$PATH"
- Windows (PowerShell):
$env:PATH = "$env:APPDATA\Python\Scripts;$env:PATH"
- If fails with an SSL/certificate error:
- macOS:
export SSL_CERT_FILE=/etc/ssl/cert.pem
- Linux:
export SSL_CERT_FILE=/etc/ssl/certs/ca-certificates.crt
- Windows (PowerShell):
$env:SSL_CERT_FILE = "C:\Program Files\Common Files\SSL\cert.pem"
(or use python -c "import certifi; print(certifi.where())"
to find the cert bundle)
- must succeed before proceeding. If it doesn't, stop and ask the user for help.
Verify environment
Run a quick check for credentials:
macOS/Linux (bash):
bash
ax --version && echo "--- env ---" && echo "ARIZE_API_KEY: ${ARIZE_API_KEY:-(not set)}" && echo "ARIZE_SPACE_ID: ${ARIZE_SPACE_ID:-(not set)}" && echo "--- profiles ---" && ax profiles show 2>&1
Windows (PowerShell):
powershell
ax --version; Write-Host "--- env ---"; Write-Host "ARIZE_API_KEY: $env:ARIZE_API_KEY"; Write-Host "ARIZE_SPACE_ID: $env:ARIZE_SPACE_ID"; Write-Host "--- profiles ---"; ax profiles show 2>&1
Read the output and proceed immediately if either the env var or the profile has an API key. Only ask the user if both are missing. Resolve failures:
- No API key in env and no profile → AskQuestion: "Arize API key (https://app.arize.com/admin > API Keys)"
- Space ID unknown → AskQuestion, or run
ax projects list -o json --limit 100 --space-id $ARIZE_SPACE_ID
and present as selectable options
- Project unclear → ask, or run
ax projects list -o json --limit 100
and search for a match
IMPORTANT: is required when using a human-readable project name as the
positional argument. It is not needed when using a base64-encoded project ID.
Export Spans:
The primary command for downloading trace data to a file.
By trace ID
bash
# Using project name (requires --space-id)
ax spans export PROJECT_NAME --trace-id TRACE_ID --space-id SPACE_ID --output-dir .arize-tmp-traces
# Using base64 project ID (no --space-id needed)
ax spans export PROJECT_ID --trace-id TRACE_ID --output-dir .arize-tmp-traces
By span ID
bash
ax spans export PROJECT_NAME --span-id SPAN_ID --space-id SPACE_ID --output-dir .arize-tmp-traces
By session ID
bash
ax spans export PROJECT_NAME --session-id SESSION_ID --space-id SPACE_ID --output-dir .arize-tmp-traces
Flags
| Flag | Type | Required | Description |
|---|
| string | mutex | Filter: |
| string | mutex | Filter: |
| string | mutex | Filter: attributes.session.id = 'X'
|
| string (positional) | yes (or ) | Project name or base64 ID (positional arg, not a flag) |
| string | yes (when is a name) | Space ID; required to resolve project names |
| int | no | Lookback window (default: 30) |
| string | no | Override start (ISO 8601) |
| string | no | Override end (ISO 8601) |
| string | no | Output directory (default: ; ensure it is gitignored — see above) |
| bool | no | Print JSON to stdout instead of file |
| bool | no | Use Arrow Flight for bulk export (see below) |
Exactly one of
,
,
is required.
Output is a JSON array of span objects. File naming:
{type}_{id}_{timestamp}/spans.json
.
Bulk export with (Arrow Flight)
By default,
uses the REST API which is limited to 500 spans per page and capped by
. Pass
to switch to Arrow Flight for streaming bulk export with no span limit.
bash
ax spans export PROJECT_NAME --space-id SPACE_ID --filter "status_code = 'ERROR'" --all --output-dir .arize-tmp-traces
REST vs Flight trade-offs:
- REST (default): Lower friction -- no Arrow/Flight dependency needed, uses standard HTTPS ports, works through any corporate proxy or firewall. Limited to 500 spans per page.
- Flight (): Required for bulk export beyond 500 spans. Uses gRPC+TLS on a separate host/port which some corporate networks may block.
- Exporting more than 500 spans
- Downloading full traces with many child spans
- Large time-range exports
Agent auto-escalation rule: If a REST export returns exactly the number of spans requested by
(or 500 if no limit was set), the result is likely truncated. Increase
or re-run with
to get the full dataset — but only when the user asks or the task requires more data.
- is required (Flight uses + , not )
- is ignored when is set
Networking notes for :
Arrow Flight connects to
via gRPC+TLS -- this is a different host from the REST API (
). On internal or private networks, the Flight endpoint may use a different host/port. Configure via:
- ax profile: , ,
- Environment variables: , ,
The
flag is also available on
,
, and
with the same behavior (REST by default, Flight with
).
Export Traces:
Export full traces -- all spans belonging to traces that match a filter. Uses a two-phase approach:
- Phase 1: Find spans matching (up to via REST, or all via Flight with )
- Phase 2: Extract unique trace IDs, then fetch every span for those traces
bash
# Explore recent traces (start small with -l 50, pull more if needed)
ax traces export PROJECT_NAME --space-id SPACE_ID -l 50 --output-dir .arize-tmp-traces
# Export traces with error spans (REST, up to 500 spans in phase 1)
ax traces export PROJECT_NAME --space-id SPACE_ID --filter "status_code = 'ERROR'" --stdout
# Export all traces matching a filter via Flight (no limit)
ax traces export PROJECT_NAME --space-id SPACE_ID --filter "status_code = 'ERROR'" --all
Flags
| Flag | Type | Default | Description |
|---|
| string | required | Positional argument (name or base64 ID) |
| string | none | Filter expression for phase-1 span lookup |
| string | none | Space ID; required when PROJECT is a name or when using |
| int | 50 | Max number of traces to export |
| int | 30 | Lookback window in days |
| string | none | Override start (ISO 8601) |
| string | none | Override end (ISO 8601) |
| string | | Output directory |
| bool | false | Print JSON to stdout instead of file |
| bool | false | Use Arrow Flight for both phases (see spans docs above) |
| string | default | Configuration profile |
How it differs from
- exports individual spans matching a filter
- exports complete traces -- it finds spans matching the filter, then pulls ALL spans for those traces (including siblings and children that may not match the filter)
Filter Syntax Reference
SQL-like expressions passed to
.
Common filterable columns
| Column | Type | Description | Example Values |
|---|
| string | Span name | , |
| string | Status | , , |
| number | Duration in ms | , |
| string | Parent span ID | null for root spans |
| string | Trace ID | |
| string | Span ID | |
| string | Session ID | |
attributes.openinference.span.kind
| string | Span kind | , , , , , , , , |
attributes.llm.model_name
| string | LLM model | , |
| string | Span input | |
| string | Span output | |
| string | Error type | , |
| string | Error message | |
| string | Error tracebacks | Use CONTAINS (not exact match) |
Operators
,
,
,
,
,
,
,
,
,
,
,
,
Examples
status_code = 'ERROR'
latency_ms > 5000
name = 'ChatCompletion' AND status_code = 'ERROR'
attributes.llm.model_name = 'gpt-4o'
attributes.openinference.span.kind IN ('LLM', 'AGENT')
attributes.error.type LIKE '%Transport%'
event.attributes CONTAINS 'TimeoutError'
Tips
- Prefer over multiple conditions: not
name = 'a' OR name = 'b' OR name = 'c'
- Start broad with , then switch to or once you know exact values
- Use for (error tracebacks) -- exact match is unreliable on complex text
- Always wrap string values in single quotes
Workflows
Debug a failing trace
ax traces export PROJECT --space-id SPACE_ID --filter "status_code = 'ERROR'" -l 50 --output-dir .arize-tmp-traces
- Read the output file, look for spans with
- Check and on error spans
Download a conversation session
ax spans export PROJECT --session-id SESSION_ID --space-id SPACE_ID --output-dir .arize-tmp-traces
- Spans are ordered by , grouped by
- If you only have a trace_id, export that trace first, then look for in the output to get the session ID
Export for offline analysis
bash
ax spans export PROJECT --trace-id TRACE_ID --space-id SPACE_ID --output-dir .arize-tmp-traces --stdout | jq '.[]'
Span Column Reference (OpenInference Semantic Conventions)
Core Identity and Timing
| Column | Description |
|---|
| Span operation name (e.g., , ) |
| Trace ID -- all spans in a trace share this |
| Unique span ID |
| Parent span ID. for root spans (= traces) |
| When the span started (ISO 8601) |
| When the span ended |
| Duration in milliseconds |
| , , |
| Optional message (usually set on errors) |
attributes.openinference.span.kind
| , , , , , , , , |
Where to Find Prompts and LLM I/O
Generic input/output (all span kinds):
| Column | What it contains |
|---|
| The input to the operation. For LLM spans, often the full prompt or serialized messages JSON. For chain/agent spans, the user's question. |
attributes.input.mime_type
| Format hint: or |
| The output. For LLM spans, the model's response. For chain/agent spans, the final answer. |
attributes.output.mime_type
| Format hint for output |
LLM-specific message arrays (structured chat format):
| Column | What it contains |
|---|
attributes.llm.input_messages
| Structured input messages array (system, user, assistant, tool). Where chat prompts live in role-based format. |
attributes.llm.input_messages.roles
| Array of roles: , , , |
attributes.llm.input_messages.contents
| Array of message content strings |
attributes.llm.output_messages
| Structured output messages from the model |
attributes.llm.output_messages.contents
| Model response content |
attributes.llm.output_messages.tool_calls.function.names
| Tool calls the model wants to make |
attributes.llm.output_messages.tool_calls.function.arguments
| Arguments for those tool calls |
Prompt templates:
| Column | What it contains |
|---|
attributes.llm.prompt_template.template
| The prompt template with variable placeholders (e.g., "Answer {question} using {context}"
) |
attributes.llm.prompt_template.variables
| Template variable values (JSON object) |
Finding prompts by span kind:
- LLM span: Check
attributes.llm.input_messages
for structured chat messages, OR for serialized prompt. Check attributes.llm.prompt_template.template
for the template.
- Chain/Agent span: Check for the user's question. Actual LLM prompts are on child LLM spans.
- Tool span: Check for tool input, for tool result.
LLM Model and Cost
| Column | Description |
|---|
attributes.llm.model_name
| Model identifier (e.g., , ) |
attributes.llm.invocation_parameters
| Model parameters JSON (temperature, max_tokens, top_p, etc.) |
attributes.llm.token_count.prompt
| Input token count |
attributes.llm.token_count.completion
| Output token count |
attributes.llm.token_count.total
| Total tokens |
attributes.llm.cost.prompt
| Input cost in USD |
attributes.llm.cost.completion
| Output cost in USD |
attributes.llm.cost.total
| Total cost in USD |
Tool Spans
| Column | Description |
|---|
| Tool/function name |
attributes.tool.description
| Tool description |
attributes.tool.parameters
| Tool parameter schema (JSON) |
Retriever Spans
| Column | Description |
|---|
attributes.retrieval.documents
| Retrieved documents array |
attributes.retrieval.documents.ids
| Document IDs |
attributes.retrieval.documents.scores
| Relevance scores |
attributes.retrieval.documents.contents
| Document text content |
attributes.retrieval.documents.metadatas
| Document metadata |
Reranker Spans
| Column | Description |
|---|
attributes.reranker.query
| The query being reranked |
attributes.reranker.model_name
| Reranker model |
attributes.reranker.top_k
| Number of results |
attributes.reranker.input_documents.*
| Input documents (ids, scores, contents, metadatas) |
attributes.reranker.output_documents.*
| Reranked output documents |
Session, User, and Custom Metadata
| Column | Description |
|---|
| Session/conversation ID -- groups traces into multi-turn sessions |
| End-user identifier |
| Custom key-value metadata. Any key under this prefix is user-defined (e.g., attributes.metadata.user_email
). Filterable. |
Errors and Exceptions
| Column | Description |
|---|
attributes.exception.type
| Exception class name (e.g., , ) |
attributes.exception.message
| Exception message text |
| Error tracebacks and detailed event data. Use for filtering. |
Evaluations and Annotations
| Column | Description |
|---|
| Human or auto-eval label (e.g., , ) |
| Numeric score (e.g., ) |
| Freeform annotation text |
Embeddings
| Column | Description |
|---|
attributes.embedding.model_name
| Embedding model name |
attributes.embedding.texts
| Text chunks that were embedded |
Troubleshooting
| Problem | Solution |
|---|
| Check ; if missing: uv tool install arize-ax-cli
(requires shell access to install packages). Then export PATH="$HOME/.local/bin:$PATH"
|
SSL: CERTIFICATE_VERIFY_FAILED
| macOS: export SSL_CERT_FILE=/etc/ssl/cert.pem
. Linux: export SSL_CERT_FILE=/etc/ssl/certs/ca-certificates.crt
. Windows: $env:SSL_CERT_FILE = (python -c "import certifi; print(certifi.where())")
|
| on a subcommand that should exist | The installed is outdated. Reinstall from the local workspace: uv tool install --force --reinstall /path/to/arize/sdk/python/arize-ax-cli
(requires shell access to install packages) |
| Follow "Resolve credentials" in Prerequisites to auto-discover or prompt for the API key |
| with valid API key | You are likely using a project name (e.g., ) without . Add or use the base64 project ID instead |
| Expand (default 30), verify project ID |
| Check column name spelling, wrap string values in single quotes |
| Use to narrow the time range |
Save Credentials
At session end, if the user manually provided an API key, space ID, or project name (not loaded from an existing profile), offer to save them to
. Use
AskQuestion with "Yes, save them" / "No thanks". Skip if all values were already in the profile.
Read the existing file (or create it), add/update only the new fields, and write it back:
toml
[auth]
api_key = "THE_API_KEY"
[defaults]
space_id = "THE_SPACE_ID"
project = "THE_PROJECT_NAME"