centersl/dify-docs
1
0
Fork 0
mirror of https://github.com/langgenius/dify-docs.git synced 2026-03-26 13:18:34 +07:00
Code Issues Packages Projects Releases Wiki Activity
Files
a958852d8db9689e05c8ee2025aac73d1ab7a6b2
dify-docs/en/use-dify/monitor/integrations/integrate-phoenix.mdx
Stephen Zhou a958852d8d fix: avoid non-existent variables (#703)
2026-03-11 20:12:06 +08:00

597 lines
14 KiB
Plaintext
Raw Blame History

---
title: Integrate with Phoenix
sidebarTitle: Phoenix
---
### What is Phoenix
Open-source & OpenTelemetry-based observability, evaluation, prompt engineering and experimentation platform for your LLM workflows and agents.
<Info>
For more details, please refer to [Phoenix](https://phoenix.arize.com).
</Info>
***
### How to Configure Phoenix
#### 1. Register/Login to [Phoenix](https://app.arize.com/auth/phoenix/signup)
#### 2. Get your Phoenix API Key
Retrieve your Phoenix API Key from the user menu at the top-right. Click on **API Key**, then on the API Key to copy it:
![Phoenix API Key](https://i.ibb.co/pB1W0pk8/dify-docs-phoenix-api-key.png)
#### 3. Integrating Phoenix with Dify
Configure Phoenix in the Dify application. Open the application you need to monitor, open **Monitoring** in the side menu, and select **Tracing app performance** on the page.
![Tracing app performance](https://i.ibb.co/gMmXxfhQ/dify-docs-phoenix-in-use.png)
After clicking configure, paste the **API Key** and **project name** created in Phoenix into the configuration and save.
![Configure Phoenix](https://i.ibb.co/jv6QFbp7/dify-docs-phoenix-config.png)
Once successfully saved, you can view the monitoring status on the current page.
![Configure Phoenix](https://i.ibb.co/HTJsj9x2/dify-docs-phoenix-in-service.png)
### How to Configure Phoenix Cloud
#### 1. Register/Login to [Phoenix Cloud](https://app.arize.com/auth/phoenix/signup)
#### 2. Create your Phoenix Space
You can create your Phoenix Space from the user menu at the top-right. Click on **Create Space**, then provide a unique URL identifier for your space:
![Phoenix Cloud Create Space](https://i.ibb.co/7JYPzZBf/dify-docs-phoenix-cloud-create-space.png)
Once successfully saved, you can view the space status on the overview page.
![Phoenix Cloud Space Overview](https://i.ibb.co/Z6RqMhhq/dify-docs-phoenix-cloud-space-overview.png)
#### 3. Create your Phoenix API Key
After launching your space, you can create your Phoenix API Key from the **Settings** option in the user menu at the bottom-left. Click on **System Key**, then provide a name for your Phoenix API Key:
![Phoenix Cloud API Key](https://i.ibb.co/SXMyX9K3/dify-docs-phoenix-cloud-api-key.png)
#### 4. Integrating Phoenix Cloud with Dify
Configure Phoenix in the Dify application. Open the application you need to monitor, open **Monitoring** in the side menu, and select **Tracing app performance** on the page.
![Tracing app performance](https://i.ibb.co/gMmXxfhQ/dify-docs-phoenix-in-use.png)
After clicking configure, paste the **API Key** and **project name** along with **Space Hostname** created in Phoenix Cloud into the configuration and save.
![Configure Phoenix](https://i.ibb.co/jv6QFbp7/dify-docs-phoenix-config.png)
Once successfully saved, you can view the monitoring status on the current page.
![Configure Phoenix](https://i.ibb.co/HTJsj9x2/dify-docs-phoenix-in-service.png)
### Monitoring Data List
#### **Workflow/Chatflow Trace Information**
**Used to track workflows and chatflows**
<table>
<thead>
<tr>
<th>Workflow</th>
<th>Phoenix Trace</th>
</tr>
</thead>
<tbody>
<tr>
<td>workflow_app_log_id/workflow_run_id</td>
<td>id</td>
</tr>
<tr>
<td>user_session_id</td>
<td>- placed in metadata</td>
</tr>
<tr>
<td>{"workflow_{id}"}</td>
<td>name</td>
</tr>
<tr>
<td>start_time</td>
<td>start_time</td>
</tr>
<tr>
<td>end_time</td>
<td>end_time</td>
</tr>
<tr>
<td>inputs</td>
<td>inputs</td>
</tr>
<tr>
<td>outputs</td>
<td>outputs</td>
</tr>
<tr>
<td>Model token consumption</td>
<td>usage_metadata</td>
</tr>
<tr>
<td>metadata</td>
<td>metadata</td>
</tr>
<tr>
<td>error</td>
<td>error</td>
</tr>
<tr>
<td>\[workflow]</td>
<td>tags</td>
</tr>
<tr>
<td>"conversation_id/none for workflow"</td>
<td>conversation_id in metadata</td>
</tr>
</tbody>
</table>
**Workflow Trace Info**
- workflow_id - Unique identifier of the workflow
- conversation_id - Conversation ID
- workflow_run_id - ID of the current run
- tenant_id - Tenant ID
- elapsed_time - Time taken for the current run
- status - Run status
- version - Workflow version
- total_tokens - Total tokens used in the current run
- file_list - List of processed files
- triggered_from - Source that triggered the current run
- workflow_run_inputs - Input data for the current run
- workflow_run_outputs - Output data for the current run
- error - Errors encountered during the current run
- query - Query used during the run
- workflow_app_log_id - Workflow application log ID
- message_id - Associated message ID
- start_time - Start time of the run
- end_time - End time of the run
- workflow node executions - Information about workflow node executions
- Metadata
- workflow_id - Unique identifier of the workflow
- conversation_id - Conversation ID
- workflow_run_id - ID of the current run
- tenant_id - Tenant ID
- elapsed_time - Time taken for the current run
- status - Run status
- version - Workflow version
- total_tokens - Total tokens used in the current run
- file_list - List of processed files
- triggered_from - Source that triggered the current run
#### **Message Trace Information**
**Used to track LLM-related conversations**
<table>
<thead>
<tr>
<th>Chat</th>
<th>Phoenix LLM</th>
</tr>
</thead>
<tbody>
<tr>
<td>message_id</td>
<td>id</td>
</tr>
<tr>
<td>user_session_id</td>
<td>- placed in metadata</td>
</tr>
<tr>
<td>"llm"</td>
<td>name</td>
</tr>
<tr>
<td>start_time</td>
<td>start_time</td>
</tr>
<tr>
<td>end_time</td>
<td>end_time</td>
</tr>
<tr>
<td>inputs</td>
<td>inputs</td>
</tr>
<tr>
<td>outputs</td>
<td>outputs</td>
</tr>
<tr>
<td>Model token consumption</td>
<td>usage_metadata</td>
</tr>
<tr>
<td>metadata</td>
<td>metadata</td>
</tr>
<tr>
<td>\["message", conversation_mode]</td>
<td>tags</td>
</tr>
<tr>
<td>conversation_id</td>
<td>conversation_id in metadata</td>
</tr>
</tbody>
</table>
**Message Trace Info**
- message_id - Message ID
- message_data - Message data
- user_session_id - User session ID
- conversation_model - Conversation mode
- message_tokens - Number of tokens in the message
- answer_tokens - Number of tokens in the answer
- total_tokens - Total number of tokens in the message and answer
- error - Error information
- inputs - Input data
- outputs - Output data
- file_list - List of processed files
- start_time - Start time
- end_time - End time
- message_file_data - File data associated with the message
- conversation_mode - Conversation mode
- Metadata
- conversation_id - Conversation ID
- ls_provider - Model provider
- ls_model_name - Model ID
- status - Message status
- from_end_user_id - ID of the sending user
- from_account_id - ID of the sending account
- agent_based - Whether the message is agent-based
- workflow_run_id - Workflow run ID
- from_source - Message source
#### **Moderation Trace Information**
**Used to track conversation moderation**
<table>
<thead>
<tr>
<th>Moderation</th>
<th>Phoenix Tool</th>
</tr>
</thead>
<tbody>
<tr>
<td>user_id</td>
<td>- placed in metadata</td>
</tr>
<tr>
<td>“moderation"</td>
<td>name</td>
</tr>
<tr>
<td>start_time</td>
<td>start_time</td>
</tr>
<tr>
<td>end_time</td>
<td>end_time</td>
</tr>
<tr>
<td>inputs</td>
<td>inputs</td>
</tr>
<tr>
<td>outputs</td>
<td>outputs</td>
</tr>
<tr>
<td>metadata</td>
<td>metadata</td>
</tr>
<tr>
<td>\["moderation"]</td>
<td>tags</td>
</tr>
</tbody>
</table>
**Moderation Trace Info**
- message_id - Message ID
- user_id: User ID
- workflow_app_log_id - Workflow application log ID
- inputs - Moderation input data
- message_data - Message data
- flagged - Whether the content is flagged for attention
- action - Specific actions taken
- preset_response - Preset response
- start_time - Moderation start time
- end_time - Moderation end time
- Metadata
- message_id - Message ID
- action - Specific actions taken
- preset_response - Preset response
#### **Suggested Question Trace Information**
**Used to track suggested questions**
<table>
<thead>
<tr>
<th>Suggested Question</th>
<th>Phoenix LLM</th>
</tr>
</thead>
<tbody>
<tr>
<td>user_id</td>
<td>- placed in metadata</td>
</tr>
<tr>
<td>"suggested_question"</td>
<td>name</td>
</tr>
<tr>
<td>start_time</td>
<td>start_time</td>
</tr>
<tr>
<td>end_time</td>
<td>end_time</td>
</tr>
<tr>
<td>inputs</td>
<td>inputs</td>
</tr>
<tr>
<td>outputs</td>
<td>outputs</td>
</tr>
<tr>
<td>metadata</td>
<td>metadata</td>
</tr>
<tr>
<td>\["suggested_question"]</td>
<td>tags</td>
</tr>
</tbody>
</table>
**Message Trace Info**
- message_id - Message ID
- message_data - Message data
- inputs - Input content
- outputs - Output content
- start_time - Start time
- end_time - End time
- total_tokens - Number of tokens
- status - Message status
- error - Error information
- from_account_id - ID of the sending account
- agent_based - Whether the message is agent-based
- from_source - Message source
- model_provider - Model provider
- model_id - Model ID
- suggested_question - Suggested question
- level - Status level
- status_message - Status message
- Metadata
- message_id - Message ID
- ls_provider - Model provider
- ls_model_name - Model ID
- status - Message status
- from_end_user_id - ID of the sending user
- from_account_id - ID of the sending account
- workflow_run_id - Workflow run ID
- from_source - Message source
#### **Dataset Retrieval Trace Information**
**Used to track knowledge base retrieval**
<table>
<thead>
<tr>
<th>Dataset Retrieval</th>
<th>Phoenix Retriever</th>
</tr>
</thead>
<tbody>
<tr>
<td>user_id</td>
<td>- placed in metadata</td>
</tr>
<tr>
<td>"dataset_retrieval"</td>
<td>name</td>
</tr>
<tr>
<td>start_time</td>
<td>start_time</td>
</tr>
<tr>
<td>end_time</td>
<td>end_time</td>
</tr>
<tr>
<td>inputs</td>
<td>inputs</td>
</tr>
<tr>
<td>outputs</td>
<td>outputs</td>
</tr>
<tr>
<td>metadata</td>
<td>metadata</td>
</tr>
<tr>
<td>\["dataset_retrieval"]</td>
<td>tags</td>
</tr>
<tr>
<td>message_id</td>
<td>parent_run_id</td>
</tr>
</tbody>
</table>
**Dataset Retrieval Trace Info**
- message_id - Message ID
- inputs - Input content
- documents - Document data
- start_time - Start time
- end_time - End time
- message_data - Message data
- Metadata
- message_id - Message ID
- ls_provider - Model provider
- ls_model_name - Model ID
- status - Message status
- from_end_user_id - ID of the sending user
- from_account_id - ID of the sending account
- agent_based - Whether the message is agent-based
- workflow_run_id - Workflow run ID
- from_source - Message source
#### **Tool Trace Information**
**Used to track tool invocation**
<table>
<thead>
<tr>
<th>Tool</th>
<th>Phoenix Tool</th>
</tr>
</thead>
<tbody>
<tr>
<td>user_id</td>
<td>- placed in metadata</td>
</tr>
<tr>
<td>tool_name</td>
<td>name</td>
</tr>
<tr>
<td>start_time</td>
<td>start_time</td>
</tr>
<tr>
<td>end_time</td>
<td>end_time</td>
</tr>
<tr>
<td>inputs</td>
<td>inputs</td>
</tr>
<tr>
<td>outputs</td>
<td>outputs</td>
</tr>
<tr>
<td>metadata</td>
<td>metadata</td>
</tr>
<tr>
<td>\["tool", tool_name]</td>
<td>tags</td>
</tr>
</tbody>
</table>
#### **Tool Trace Info**
- message_id - Message ID
- tool_name - Tool name
- start_time - Start time
- end_time - End time
- tool_inputs - Tool inputs
- tool_outputs - Tool outputs
- message_data - Message data
- error - Error information, if any
- inputs - Inputs for the message
- outputs - Outputs of the message
- tool_config - Tool configuration
- time_cost - Time cost
- tool_parameters - Tool parameters
- file_url - URL of the associated file
- Metadata
- message_id - Message ID
- tool_name - Tool name
- tool_inputs - Tool inputs
- tool_outputs - Tool outputs
- tool_config - Tool configuration
- time_cost - Time cost
- error - Error information, if any
- tool_parameters - Tool parameters
- message_file_id - Message file ID
- created_by_role - Role of the creator
- created_user_id - User ID of the creator
**Generate Name Trace Information**
**Used to track conversation title generation**
<table>
<thead>
<tr>
<th>Generate Name</th>
<th>Phoenix Tool</th>
</tr>
</thead>
<tbody>
<tr>
<td>user_id</td>
<td>- placed in metadata</td>
</tr>
<tr>
<td>"generate_conversation_name"</td>
<td>name</td>
</tr>
<tr>
<td>start_time</td>
<td>start_time</td>
</tr>
<tr>
<td>end_time</td>
<td>end_time</td>
</tr>
<tr>
<td>inputs</td>
<td>inputs</td>
</tr>
<tr>
<td>outputs</td>
<td>outputs</td>
</tr>
<tr>
<td>metadata</td>
<td>metadata</td>
</tr>
<tr>
<td>\["generate_name"]</td>
<td>tags</td>
</tr>
</tbody>
</table>
**Generate Name Trace Info**
- conversation_id - Conversation ID
- inputs - Input data
- outputs - Generated conversation name
- start_time - Start time
- end_time - End time
- tenant_id - Tenant ID
- Metadata
- conversation_id - Conversation ID
- tenant_id - Tenant ID
Reference in New Issue View Git Blame Copy Permalink