无极开物Docs
附加功能

错误报告

从 Kaiwu 发送问题报告,可选择附带诊断信息以便更快排查分流。

Kaiwu 在应用设置中内置了问题报告流程。

在服务端启用后,用户可以提交:

  • 简要的问题描述,
  • 可选的诊断数据(例如日志),
  • 有助于技术支持复现与分类排查问题的元数据。

服务端配置项

在 Kaiwu 服务端上可配置以下环境变量:

  • KAIWU_FEATURE_BUG_REPORTS__ENABLED(兼容 KAIWU_FEATURE_BUG_REPORTS__ENABLED,默认值:1)
  • KAIWU_FEATURE_BUG_REPORTS__PROVIDER_URL(兼容 KAIWU_FEATURE_BUG_REPORTS__PROVIDER_URL,默认值:https://kaiwu.wujilabs.cn)
    • 若配置为无效 URL,系统将直接禁用提供商提交功能,而不会回退到中心默认地址。
  • KAIWU_FEATURE_BUG_REPORTS__DEFAULT_INCLUDE_DIAGNOSTICS(默认值:1)
  • KAIWU_FEATURE_BUG_REPORTS__MAX_ARTIFACT_BYTES(默认值:10485760)
  • KAIWU_FEATURE_BUG_REPORTS__UPLOAD_TIMEOUT_MS(默认值:120000)
  • KAIWU_FEATURE_BUG_REPORTS__CONTEXT_WINDOW_MS(默认值:1800000;最小值:1000,最大值:86400000)
  • KAIWU_FEATURE_BUG_REPORTS__ACCEPTED_ARTIFACT_KINDS(以逗号分隔的白名单)
  • KAIWU_BUG_REPORTS_SERVER_DIAGNOSTICS_ENABLED(默认值:0)
  • KAIWU_BUG_REPORTS_SERVER_DIAGNOSTICS_ACCESS_MODE(默认值:owner,可选值:authenticated、owner)
  • KAIWU_SERVER_OWNER_USER_IDS(以逗号分隔的服务端所有者账户 ID,用于仅限所有者使用的功能)
  • KAIWU_BUG_REPORTS_SERVER_LOG_PATH(可选,显式指定服务端日志路径)
  • KAIWU_BUG_REPORTS_SERVER_LOG_MAX_BYTES(默认值:262144,服务端日志快照读取的最大末尾字节数)
  • KAIWU_DIAGNOSTICS_BUG_REPORT_SNAPSHOT_RATE_LIMIT_MAX(默认值:30)
  • KAIWU_DIAGNOSTICS_BUG_REPORT_SNAPSHOT_RATE_LIMIT_WINDOW(默认值:1 minute)

如需强制禁止向外导出服务端日志,请保留 KAIWU_BUG_REPORTS_SERVER_DIAGNOSTICS_ENABLED=0,或从 KAIWU_FEATURE_BUG_REPORTS__ACCEPTED_ARTIFACT_KINDS 中移除 server(或两者同时执行)。

对于共享服务器,建议保留 KAIWU_BUG_REPORTS_SERVER_DIAGNOSTICS_ACCESS_MODE=owner(或保持未设置状态)并配置 KAIWU_SERVER_OWNER_USER_IDS,确保仅指定的所有者可以获取服务端诊断快照。

KAIWU_SERVER_OWNER_USER_IDS 接收的是 Kaiwu 账户 ID(而非用户名)。所有者可在客户端中通过“设置 → 账户”复制该 ID。

隐私与控制

  • 提交时可自主选择是否上传诊断数据。
  • 针对受限网络环境,服务端运维人员可以禁用向提供商自动提交。
  • 客户端界面会依据服务端的特性标记动态适配。
  • 客户端对未暴露 features.bugReports 的旧版服务端保持向后兼容(视作禁用)。
  • 当提供商提交功能不可用时,客户端仍提供回退方案,可预填并跳转创建公开 GitHub Issue(不包含私有产物)。

相似问题(重复项检测)

为减少重复报告,Kaiwu 可以在你填写报告的同时,在 GitHub 上检索可能相似的现有问题。

  • 在应用中,你可以选择某条建议的现有问题,直接以评论形式追加反馈,而无需新建 Issue。
  • 在 CLI 中,你可以:
    • 传入 --existing-issue-number ⟦K2⟧,将报告作为评论发布到已有问题下
    • 传入 --no-similar-issues,在交互模式下跳过重复问题检索

通过 CLI 提交报告

你也可以通过 CLI 提交报告:

kaiwu bug-report \
  --title "CLI crash while starting daemon" \
  --github-username "@octocat" \
  --summary "Daemon start exits immediately" \
  --current-behavior "kaiwu daemon start exits with unknown error" \
  --expected-behavior "daemon starts successfully" \
  --repro-step "Run kaiwu daemon start" \
  --accept-privacy-notice

在交互式终端中,若缺少必填字段,CLI 会主动提示输入。在非交互模式下,请显式传入所有必需的参数标志。

报告者的 GitHub 用户名(可选)

如果你希望维护者后续能与你取得联系,可通过 --github-username 提供自己的 GitHub 用户名。Kaiwu 会在报告摘要中追加一行 Reporter GitHub: \...``(该内容经过无害化处理,以防意外触发格式错乱或人员提及)。

适用场景

  • 界面渲染异常,
  • 会话同步不一致,
  • 认证或连接问题,
  • 工具时间线或差异对比(diff)渲染回退问题。

相关页面

© 乾元执中(南京)科技有限公司 · WUJI-Labs

On this page