guide洞察面板

# 洞察面板 - 概述

洞察面板功能允许收集、列出和过滤来自 CKBox 服务器的业务(审计)日志。这些日志提供了对您环境内部情况的良好洞察。此外,洞察面板还用作一个有用的调试工具,尤其是在与 CKBox 集成时。

Insights Panel overview.

# 激活洞察功能

默认情况下,洞察功能在所有环境中都被关闭。

要激活洞察功能,请按照以下步骤操作。

登录云服务仪表板(使用本地部署时为管理面板),并转到所选环境的功能配置选项卡。请注意,每个环境都需要单独激活该功能。

Go to Management Panel.

在“洞察”部分,打开“业务日志”切换按钮。

Toggle Insights Panel feature.

打开切换按钮后,服务器将从现在开始为该环境收集业务日志和详细信息日志。

# 列出日志

要列出收集的日志,请转到云服务仪表板(或使用本地部署版本时在管理面板中)的“洞察面板”选项卡。默认情况下,日志列表显示过去 5 分钟的业务日志和详细信息日志。要更改时间范围,请使用日期选择器设置所需的过滤范围。

Insights panel logs.

# 过滤日志

要搜索日志,您可以使用过滤器缩小所需的搜索结果范围。

当前可用的过滤器包括

  • user - 按 userId 过滤,
  • error level - 按 warnfailerror 等级过滤,
  • trace - 按 traceId 过滤,
  • asset - 按 assetId 过滤,
  • category - 按 categoryId 过滤。

过滤器可以组合使用。

您可以将过滤器值粘贴到过滤器框中(在按 trace 搜索时很有用)。还可以选择建议值之一 - 这些值来自与您的查询匹配的日志。

# 日志结构

以下是日志中包含的关键字段

  • msg - 详细的日志消息。
  • traceId - 唯一的 RPC 调用 ID。
  • data - 包含附加信息的项。它可能因不同的日志而异。
  • time - 发生日期。
  • tags - 与日志关联的标签。可能的标签包括 business(有关用户或 API 启动的主要操作的信息)或 details(有关主要操作的详细信息或有关由主要操作触发的附加事件的信息)。
  • status - 记录的操作的结果。

日志示例

{
    "msg": "The user uploaded a new asset (userId: xhb1jjs10uq8un9wt0vc)",
    "traceId": "b36f1967-7778-4c0d-97a2-37caba24d59e",
    "data": {
      "assetId": "vem71503nieel8ewoxjb",
      "environmentId": "ciy6g1w4y1a6qm146our",
      "folderId": "f5qt-UIwHFqq",
      "userId": "xhb1jjs10uq8un9wt0vc",
      "originalFileName": "spreadsheet.xlsx",
      "mimeType": "application/octet-stream"
    },
    "time": "2023-02-07T09:53:01.257Z",
    "tags": "business",
    "status": "success"
}

日志流记录分组在一起,可以包含由 traceId 链接在一起的 businessdetails 日志。单击日志记录后,即可查看日志详细信息。

# 日志保留

所有超过 14 天的日志都会定期从环境中删除。此操作会自动执行,无需额外的配置。