arize-trace
Original:🇺🇸 English
Translated
INVOKE THIS SKILL when downloading or exporting Arize traces and spans. Covers exporting traces by ID, sessions by ID, and debugging LLM application issues using the ax CLI.
27installs
Sourcearize-ai/arize-skills
Added on
NPX Install
npx skill4agent add arize-ai/arize-skills arize-traceTags
Translated version includes tags in frontmatterSKILL.md Content
View Translation Comparison →Arize Trace Skill
Concepts
- Trace = a tree of spans sharing a , rooted at a span with
context.trace_idparent_id = null - Span = a single operation (LLM call, tool call, retriever, chain, agent)
- Session = a group of traces sharing (e.g., a multi-turn conversation)
attributes.session.id
Use to download trace data. This is the only supported command for retrieving spans.
ax spans exportExploratory 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.
--trace-id--span-id--session-id-l 50Default output directory: Always use on every call. The CLI automatically creates the directory and adds it to .
--output-dir .arize-tmp-tracesax spans export.gitignorePrerequisites
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.
axInstall ax
Verify is installed and working before proceeding:
ax- Check if is on PATH:
ax(Unix) orcommand -v ax(Windows)where ax - If not found, check common install locations:
- macOS/Linux:
test -x ~/.local/bin/ax && export PATH="$HOME/.local/bin:$PATH" - Windows: check or
%APPDATA%\Python\Scripts\ax.exe%LOCALAPPDATA%\Programs\Python\Scripts\ax.exe
- macOS/Linux:
- 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:
pip install arize-ax-cli
- Preferred:
- After install, if is not on PATH:
ax- macOS/Linux:
export PATH="$HOME/.local/bin:$PATH" - Windows (PowerShell):
$env:PATH = "$env:APPDATA\Python\Scripts;$env:PATH"
- macOS/Linux:
- If fails with an SSL/certificate error:
ax --version- macOS:
export SSL_CERT_FILE=/etc/ssl/cert.pem - Linux:
export SSL_CERT_FILE=/etc/ssl/certs/ca-certificates.crt - Windows (PowerShell): (or use
$env:SSL_CERT_FILE = "C:\Program Files\Common Files\SSL\cert.pem"to find the cert bundle)python -c "import certifi; print(certifi.where())"
- macOS:
- must succeed before proceeding. If it doesn't, stop and ask the user for help.
ax --version
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>&1Windows (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>&1Read 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 and present as selectable options
ax projects list -o json --limit 100 --space-id $ARIZE_SPACE_ID - Project unclear → ask, or run and search for a match
ax projects list -o json --limit 100
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.
--space-idPROJECTExport Spans: ax spans export
ax spans exportThe 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-tracesBy span ID
bash
ax spans export PROJECT_NAME --span-id SPAN_ID --space-id SPACE_ID --output-dir .arize-tmp-tracesBy session ID
bash
ax spans export PROJECT_NAME --session-id SESSION_ID --space-id SPACE_ID --output-dir .arize-tmp-tracesFlags
| Flag | Type | Required | Description |
|---|---|---|---|
| string | mutex | Filter: |
| string | mutex | Filter: |
| string | mutex | Filter: |
| string (positional) | yes (or | Project name or base64 ID (positional arg, not a flag) |
| string | yes (when | 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: |
| bool | no | Print JSON to stdout instead of file |
| bool | no | Use Arrow Flight for bulk export (see below) |
Exactly one of , , is required.
--trace-id--span-id--session-idOutput is a JSON array of span objects. File naming: .
{type}_{id}_{timestamp}/spans.jsonBulk export with --all
(Arrow Flight)
--allBy 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.
ax spans export--limit--allbash
ax spans export PROJECT_NAME --space-id SPACE_ID --filter "status_code = 'ERROR'" --all --output-dir .arize-tmp-tracesREST 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.
--all
When to use :
--all- 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.
-l-l--allRequirements for :
--all- is required (Flight uses
--space-id+space_id, notproject_name)project_id - is ignored when
--limitis set--all
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:
--allflight.arize.com:443api.arize.com- ax profile: ,
flight_host,flight_portflight_scheme - Environment variables: ,
ARIZE_FLIGHT_HOST,ARIZE_FLIGHT_PORTARIZE_FLIGHT_SCHEME
The flag is also available on , , and with the same behavior (REST by default, Flight with ).
--allax traces exportax datasets exportax experiments export--allExport Traces: ax traces export
ax traces exportExport full traces -- all spans belonging to traces that match a filter. Uses a two-phase approach:
- Phase 1: Find spans matching (up to
--filtervia REST, or all via Flight with--limit)--all - 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'" --allFlags
| 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 |
| string | default | Configuration profile |
How it differs from ax spans export
ax spans export- exports individual spans matching a filter
ax spans export - 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)
ax traces export
Filter Syntax Reference
SQL-like expressions passed to .
--filterCommon 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 | |
| string | Span kind | |
| string | LLM model | |
| string | Span input | |
| string | Span output | |
| string | Error type | |
| string | Error message | |
| string | Error tracebacks | Use CONTAINS (not exact match) |
Operators
=!=<<=>>=ANDORINCONTAINSLIKEIS NULLIS NOT NULLExamples
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
INconditions:ORnotname IN ('a', 'b', 'c')name = 'a' OR name = 'b' OR name = 'c' - Start broad with , then switch to
LIKEor=once you know exact valuesIN - Use for
CONTAINS(error tracebacks) -- exact match is unreliable on complex textevent.attributes - 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
status_code: ERROR - Check and
attributes.error.typeon error spansattributes.error.message
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
start_timecontext.trace_id - If you only have a trace_id, export that trace first, then look for in the output to get the session ID
attributes.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. |
| When the span started (ISO 8601) |
| When the span ended |
| Duration in milliseconds |
| |
| Optional message (usually set on errors) |
| |
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. |
| Format hint: |
| The output. For LLM spans, the model's response. For chain/agent spans, the final answer. |
| Format hint for output |
LLM-specific message arrays (structured chat format):
| Column | What it contains |
|---|---|
| Structured input messages array (system, user, assistant, tool). Where chat prompts live in role-based format. |
| Array of roles: |
| Array of message content strings |
| Structured output messages from the model |
| Model response content |
| Tool calls the model wants to make |
| Arguments for those tool calls |
Prompt templates:
| Column | What it contains |
|---|---|
| The prompt template with variable placeholders (e.g., |
| Template variable values (JSON object) |
Finding prompts by span kind:
- LLM span: Check for structured chat messages, OR
attributes.llm.input_messagesfor serialized prompt. Checkattributes.input.valuefor the template.attributes.llm.prompt_template.template - Chain/Agent span: Check for the user's question. Actual LLM prompts are on child LLM spans.
attributes.input.value - Tool span: Check for tool input,
attributes.input.valuefor tool result.attributes.output.value
LLM Model and Cost
| Column | Description |
|---|---|
| Model identifier (e.g., |
| Model parameters JSON (temperature, max_tokens, top_p, etc.) |
| Input token count |
| Output token count |
| Total tokens |
| Input cost in USD |
| Output cost in USD |
| Total cost in USD |
Tool Spans
| Column | Description |
|---|---|
| Tool/function name |
| Tool description |
| Tool parameter schema (JSON) |
Retriever Spans
| Column | Description |
|---|---|
| Retrieved documents array |
| Document IDs |
| Relevance scores |
| Document text content |
| Document metadata |
Reranker Spans
| Column | Description |
|---|---|
| The query being reranked |
| Reranker model |
| Number of results |
| Input documents (ids, scores, contents, metadatas) |
| 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., |
Errors and Exceptions
| Column | Description |
|---|---|
| Exception class name (e.g., |
| Exception message text |
| Error tracebacks and detailed event data. Use |
Evaluations and Annotations
| Column | Description |
|---|---|
| Human or auto-eval label (e.g., |
| Numeric score (e.g., |
| Freeform annotation text |
Embeddings
| Column | Description |
|---|---|
| Embedding model name |
| Text chunks that were embedded |
Troubleshooting
| Problem | Solution |
|---|---|
| Check |
| macOS: |
| The installed |
| Follow "Resolve credentials" in Prerequisites to auto-discover or prompt for the API key |
| You are likely using a project name (e.g., |
| Expand |
| Check column name spelling, wrap string values in single quotes |
| Use |
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.
~/.arize/config.tomlRead 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"