> ## Documentation Index
> Fetch the complete documentation index at: https://dify-6c0370d8-docs-new-agent-experience.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 集成 Phoenix

> 本文档由 AI 自动翻译。如有任何不准确之处，请参考 [英文原版](/en/cloud/use-dify/monitor/integrations/integrate-phoenix)。

### Phoenix 简介

开源且基于 OpenTelemetry 的可观测性、评估、提示工程和实验平台，适用于你的 LLM 工作流程和代理。

<Callout>
  Phoenix [官网介绍](https://phoenix.arize.com)
</Callout>

### 配置 Phoenix

本章节将指引你注册 Phoenix 并将其集成至 Dify 平台内。

#### 1. 注册/登录 [Phoenix](https://app.arize.com/auth/phoenix/signup)

### 2. 获取 Phoenix API 密钥

从右上角的用户菜单中获取 Phoenix API 密钥。点击 **API Key**，然后点击 API Key 进行复制：

<Frame>
  ![](https://i.ibb.co/pB1W0pk8/dify-docs-phoenix-api-key.png)
</Frame>

### 3. 集成 Phoenix 与 Dify

在 Dify 应用程序中配置 Phoenix。打开需要监控的应用程序，在侧边菜单中打开 **监控**，并在页面上选择 **追踪应用性能**。

<Frame>
  ![](https://i.ibb.co/gMmXxfhQ/dify-docs-phoenix-in-use.png)
</Frame>

点击配置后，将在 Phoenix 中创建的 **API Key** 和 **项目名称**粘贴到配置中并保存。

<Frame>
  ![](https://i.ibb.co/jv6QFbp7/dify-docs-phoenix-config.png)
</Frame>

成功保存后，你可以在当前页面查看监控状态。

<Frame>
  ![](https://i.ibb.co/HTJsj9x2/dify-docs-phoenix-in-service.png)
</Frame>

### 配置 Phoenix Cloud

本章节将指引你注册 Phoenix Cloud 并将其集成至 Dify 平台内。

#### 1. 注册/登录 [Phoenix Cloud](https://app.arize.com/auth/phoenix/signup)

### 2. 创建你的 Phoenix 空间

你可以在右上角的用户菜单中创建 Phoenix 空间。点击 创建空间，然后为你的空间提供一个唯一的 URL 标识符：

<Frame>
  ![](https://i.ibb.co/7JYPzZBf/dify-docs-phoenix-cloud-create-space.png)
</Frame>

保存成功后，你可以在概览页面查看空间的状态。

<Frame>
  ![](https://i.ibb.co/Z6RqMhhq/dify-docs-phoenix-cloud-space-overview.png)
</Frame>

### 3. 创建你的 Phoenix API 密钥

启动空间后，你可以在左下角的用户菜单中点击 设置 来创建 Phoenix API 密钥。点击 系统密钥，然后为你的 API 密钥命名：

<Frame>
  ![](https://i.ibb.co/SXMyX9K3/dify-docs-phoenix-cloud-api-key.png)
</Frame>

### 4. 集成 Phoenix Cloud 与 Dify

在 Dify 应用程序中配置 Phoenix。打开需要监控的应用程序，在侧边菜单中打开 **监控**，并在页面上选择 **追踪应用性能**。

<Frame>
  ![](https://i.ibb.co/gMmXxfhQ/dify-docs-phoenix-in-use.png)
</Frame>

点击配置后，粘贴从 Phoenix Cloud 中获取的 API 密钥、项目名称 和 空间主机名 到配置项中并保存。

<Frame>
  ![](https://i.ibb.co/jv6QFbp7/dify-docs-phoenix-config.png)
</Frame>

成功保存后，你可以在当前页面查看监控状态。

<Frame>
  ![](https://i.ibb.co/HTJsj9x2/dify-docs-phoenix-in-service.png)
</Frame>

## 监控数据列表

### **工作流/对话流追踪信息**

**用于追踪工作流和对话流**

| 工作流                                      | Phoenix 追踪                   |
| ---------------------------------------- | ---------------------------- |
| workflow\_app\_log\_id/workflow\_run\_id | id                           |
| user\_session\_id                        | - 放置在元数据中                    |
| `workflow_{id}`                          | name                         |
| start\_time                              | start\_time                  |
| end\_time                                | end\_time                    |
| inputs                                   | inputs                       |
| outputs                                  | outputs                      |
| Model token consumption                  | usage\_metadata              |
| metadata                                 | metadata                     |
| error                                    | error                        |
| \[workflow]                              | tags                         |
| conversation\_id/none for workflow       | conversation\_id in metadata |

**工作流追踪信息**

* workflow\_id - 工作流唯一标识符
* conversation\_id - 对话 ID
* workflow\_run\_id - 当前运行的 ID
* tenant\_id - 租户 ID
* elapsed\_time - 当前运行所用时间
* status - 运行状态
* version - 工作流版本
* total\_tokens - 当前运行使用的总令牌数
* file\_list - 处理的文件列表
* triggered\_from - 触发当前运行的来源
* workflow\_run\_inputs - 当前运行的输入数据
* workflow\_run\_outputs - 当前运行的输出数据
* error - 当前运行期间遇到的错误
* query - 运行期间使用的查询
* workflow\_app\_log\_id - 工作流应用程序日志 ID
* message\_id - 关联的消息 ID
* start\_time - 运行开始时间
* end\_time - 运行结束时间
* workflow node executions - 工作流节点执行信息
* 元数据
  * workflow\_id - 工作流唯一标识符
  * conversation\_id - 对话 ID
  * workflow\_run\_id - 当前运行的 ID
  * tenant\_id - 租户 ID
  * elapsed\_time - 当前运行所用时间
  * status - 运行状态
  * version - 工作流版本
  * total\_tokens - 当前运行使用的总令牌数
  * file\_list - 处理的文件列表
  * triggered\_from - 触发当前运行的来源

#### **消息追踪信息**

**用于追踪 LLM 相关对话**

| 聊天                               | Phoenix LLM                  |
| -------------------------------- | ---------------------------- |
| message\_id                      | id                           |
| user\_session\_id                | - 放置在元数据中                    |
| "llm"                            | name                         |
| start\_time                      | start\_time                  |
| end\_time                        | end\_time                    |
| inputs                           | inputs                       |
| outputs                          | outputs                      |
| Model token consumption          | usage\_metadata              |
| metadata                         | metadata                     |
| \["message", conversation\_mode] | tags                         |
| conversation\_id                 | conversation\_id in metadata |

**消息追踪信息**

* message\_id - 消息 ID
* message\_data - 消息数据
* user\_session\_id - 用户会话 ID
* conversation\_model - 对话模式
* message\_tokens - 消息中的令牌数
* answer\_tokens - 答案中的令牌数
* total\_tokens - 消息和答案中的总令牌数
* error - 错误信息
* inputs - 输入数据
* outputs - 输出数据
* file\_list - 处理的文件列表
* start\_time - 开始时间
* end\_time - 结束时间
* message\_file\_data - 与消息关联的文件数据
* conversation\_mode - 对话模式
* 元数据
  * conversation\_id - 对话 ID
  * ls\_provider - 模型供应商
  * ls\_model\_name - 模型 ID
  * status - 消息状态
  * from\_end\_user\_id - 发送用户的 ID
  * from\_account\_id - 发送账户的 ID
  * agent\_based - 消息是否基于代理
  * workflow\_run\_id - 工作流运行 ID
  * from\_source - 消息来源

#### **审核追踪信息**

**用于追踪对话审核**

| 审核              | Phoenix Tool |
| --------------- | ------------ |
| user\_id        | - 放置在元数据中    |
| "moderation"    | name         |
| start\_time     | start\_time  |
| end\_time       | end\_time    |
| inputs          | inputs       |
| outputs         | outputs      |
| metadata        | metadata     |
| \["moderation"] | tags         |

**审核追踪信息**

* message\_id - 消息 ID
* user\_id - 用户 ID
* workflow\_app\_log\_id - 工作流应用程序日志 ID
* inputs - 审核输入数据
* message\_data - 消息数据
* flagged - 内容是否被标记需要注意
* action - 采取的具体行动
* preset\_response - 预设响应
* start\_time - 审核开始时间
* end\_time - 审核结束时间
* 元数据
  * message\_id - 消息 ID
  * action - 采取的具体行动
  * preset\_response - 预设响应

#### **建议问题追踪信息**

**用于追踪建议问题**

| 建议问题                     | Phoenix LLM |
| ------------------------ | ----------- |
| user\_id                 | - 放置在元数据中   |
| "suggested\_question"    | name        |
| start\_time              | start\_time |
| end\_time                | end\_time   |
| inputs                   | inputs      |
| outputs                  | outputs     |
| metadata                 | metadata    |
| \["suggested\_question"] | tags        |

**消息追踪信息**

* message\_id - 消息 ID
* message\_data - 消息数据
* inputs - 输入内容
* outputs - 输出内容
* start\_time - 开始时间
* end\_time - 结束时间
* total\_tokens - 令牌数量
* status - 消息状态
* error - 错误信息
* from\_account\_id - 发送账户的 ID
* agent\_based - 是否基于代理
* from\_source - 消息来源
* model\_provider - 模型供应商
* model\_id - 模型 ID
* suggested\_question - 建议问题
* level - 状态级别
* status\_message - 状态消息
* 元数据
  * message\_id - 消息 ID
  * ls\_provider - 模型供应商
  * ls\_model\_name - 模型 ID
  * status - 消息状态
  * from\_end\_user\_id - 发送用户的 ID
  * from\_account\_id - 发送账户的 ID
  * workflow\_run\_id - 工作流运行 ID
  * from\_source - 消息来源

#### **数据集检索追踪信息**

**用于追踪知识库检索**

| 数据集检索                   | Phoenix Retriever |
| ----------------------- | ----------------- |
| user\_id                | - 放置在元数据中         |
| "dataset\_retrieval"    | name              |
| start\_time             | start\_time       |
| end\_time               | end\_time         |
| inputs                  | inputs            |
| outputs                 | outputs           |
| metadata                | metadata          |
| \["dataset\_retrieval"] | tags              |
| message\_id             | parent\_run\_id   |

**数据集检索追踪信息**

* message\_id - 消息 ID
* inputs - 输入内容
* documents - 文档数据
* start\_time - 开始时间
* end\_time - 结束时间
* message\_data - 消息数据
* 元数据
  * message\_id - 消息 ID
  * ls\_provider - 模型供应商
  * ls\_model\_name - 模型 ID
  * status - 消息状态
  * from\_end\_user\_id - 发送用户的 ID
  * from\_account\_id - 发送账户的 ID
  * agent\_based - 是否基于代理
  * workflow\_run\_id - 工作流运行 ID
  * from\_source - 消息来源

#### **工具追踪信息**

**用于追踪工具调用**

| 工具                    | Phoenix Tool |
| --------------------- | ------------ |
| user\_id              | - 放置在元数据中    |
| tool\_name            | name         |
| start\_time           | start\_time  |
| end\_time             | end\_time    |
| inputs                | inputs       |
| outputs               | outputs      |
| metadata              | metadata     |
| \["tool", tool\_name] | tags         |

#### **工具追踪信息**

* message\_id - 消息 ID
* tool\_name - 工具名称
* start\_time - 开始时间
* end\_time - 结束时间
* tool\_inputs - 工具输入
* tool\_outputs - 工具输出
* message\_data - 消息数据
* error - 错误信息（如果有）
* inputs - 消息的输入
* outputs - 消息的输出
* tool\_config - 工具配置
* time\_cost - 时间消耗
* tool\_parameters - 工具参数
* file\_url - 关联文件的 URL
* 元数据
  * message\_id - 消息 ID
  * tool\_name - 工具名称
  * tool\_inputs - 工具输入
  * tool\_outputs - 工具输出
  * tool\_config - 工具配置
  * time\_cost - 时间消耗
  * error - 错误信息（如果有）
  * tool\_parameters - 工具参数
  * message\_file\_id - 消息文件 ID
  * created\_by\_role - 创建者角色
  * created\_user\_id - 创建者用户 ID

#### **生成名称追踪信息**

**用于追踪对话标题生成**

| 生成名称                           | Phoenix Tool |
| ------------------------------ | ------------ |
| user\_id                       | - 放置在元数据中    |
| "generate\_conversation\_name" | name         |
| start\_time                    | start\_time  |
| end\_time                      | end\_time    |
| inputs                         | inputs       |
| outputs                        | outputs      |
| metadata                       | metadata     |
| \["generate\_name"]            | tags         |

**生成名称追踪信息**

* conversation\_id - 对话 ID
* inputs - 输入数据
* outputs - 生成的对话名称
* start\_time - 开始时间
* end\_time - 结束时间
* tenant\_id - 租户 ID
* 元数据
  * conversation\_id - 对话 ID
  * tenant\_id - 租户 ID