遥测 | Phichain

自 v1.0.0-beta.3 起，Phichain 工具链会收集并上报有关 Phichain 使用和运行环境的一些匿名遥测数据

这些数据有助于 Phichain 开发者分析使用场景、修复漏洞、优化性能，并为未来对 Phichain 功能改进的开发提供数据支持

收集的信息

遥测数据包含以下信息：

一个时间戳
事件的类型
一个唯一的 UUID v4 标识符，代表当前运行的 Phichain 实例。每次启动时都会生成一个新的 UUID。Phichain 不会持久化该 UUID，该 UUID 无法追溯到个人
一个代表当前设备的字符串。该字符串会在客户端和服务端进行加密，该字符串无法追溯到个人
Phichain 的版本信息，包括版本号、是否为测试版
Phichain 工具链的名称，如 phichain-editor、phichain-converter、phichain-renderer
系统相关信息，包括：
- 系统类型，如 Windows、macOS、Linux
- 系统版本，如 Windows 10、Linux 5.14.0
- 系统架构，如 AMD64
硬件数据，包括：
- wgpu 使用的适配器 (AdapterInfo)
- 硬件信息 (SystemInfo)
运行环境信息，包括
- 是否在容器 / CI 中运行
- 是否处于调试环境
事件的其他元数据

您可以通过设置以下环境变量来查看具体收集的内容：PHICHAIN_TELEMETRY_DEBUG=1。当启用时，遥测数据会被输出至标准错误流，而不会被发送到服务器

收集的遥测数据不会包含任何个人信息和敏感数据，包括但不限于环境变量、文件路径、文件内容或谱面信息

示例事件

下面是一个遥测数据的样例：

{
  "adapter": {
    "backend": "Metal",
    "device": 0,
    "device_type": "IntegratedGpu",
    "driver": "",
    "driver_info": "",
    "name": "Apple M3 Pro",
    "vendor": 0
  },
  "device_id": "655e49f3ded2e03f9946b04236855b61d21cc7f78ac36be3508ae74bd0fa7ae1",
  "environment": {
    "ci": false,
    "container": "none",
    "test": false
  },
  "hardware": {
    "core_count": 12,
    "cpu": "Apple M3 Pro",
    "memory": 38654705664,
    "memory_formatted": "36.0 GiB"
  },
  "metadata": {
    "action": "phichain.scripting.debug"
  },
  "performance": {
    "entities": 258,
    "fps": 119.53503112389427,
    "fps_samples": [
      114.55793011233092,
      123.60620102645062,
      120.66426158660474,
      120.33031151833028,
      112.46063877642824
    ],
    "memory": 399572992
  },
  "phichain": {
    "beta": true,
    "debug": true,
    "version": "1.0.0-beta.3"
  },
  "project": {
    "events": 5,
    "lines": 1,
    "notes": 200
  },
  "reporter": "phichain-editor",
  "session_id": "4d58fb4c-327a-417e-83a4-4b670484e50d",
  "system": {
    "arch": "aarch64",
    "name": "Mac OS",
    "os": "macos",
    "version": "15.4.0"
  },
  "timestamp": "2025-04-11T09:39:43.188250+00:00",
  "type": "phichain.editor.action.invoked",
  "uptime": 8.379390716552734
}

关闭遥测

如果你不想 Phichain 收集任何数据，你可以随时通过以下任一方法禁用它：

对于制谱器，在设置 > 常规中可以关闭遥测
通过设置下列任意环境变量以关闭遥测：

PHICHAIN_TELEMETRY_DISABLED=1
DO_NOT_TRACK=1: 关于 Console Do Not Track (DNT)

以上环境变量将覆盖制谱器内的设置。也就是说，如果任意上述环境变量被设置，即使制谱器中启用了遥测功能，仍不会收集任何数据