洞察面板

# 洞察面板概述

洞察面板功能允许收集、列出和过滤来自服务器的业务（审计）日志。这些日志提供了对您环境内部运行情况的良好洞察。此外，洞察面板也用作一个有用的调试工具，尤其是在集成期间。

使用洞察面板功能，您可以查看 CKEditor 协作服务、CKBox、导入/导出至 Word 和导出至 PDF 的日志。
对于导入/导出至 Word 和导出至 PDF，洞察面板功能仅适用于 SaaS 变体。

Insights Panel overview.

# 激活洞察功能

默认情况下，所有环境的洞察功能都处于关闭状态。

要激活洞察功能

登录到云服务仪表板（使用本地部署时为管理面板），然后转到所选环境的“功能配置”选项卡。请注意，此功能是为每个环境分别激活的。
在“洞察”部分下，打开“业务日志”切换按钮。
打开切换按钮后，CS 服务器将从现在开始开始为该环境收集业务和详细信息日志。

# 列出日志

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

# 过滤日志

要搜索日志，请使用过滤器缩小所需的搜索结果。

当前可用的过滤器包括

document – 按 documentId 过滤 – 仅适用于 CKEditor 协作服务。
asset – 按 assetId 过滤 – 仅适用于 CKBox。
category – 按 categoryId 过滤 – 仅适用于 CKBox。
user – 按 userId 过滤。
error level – 按 warn、fail 和 error 等级过滤。
trace – 按 traceId 过滤。

过滤器可以相互组合使用。

您可以将过滤器值粘贴到过滤器框中（对于按 trace 搜索很有用）。还可以选择其中一个建议的值 - 这些值是从与您的查询匹配的日志中汇总的。

# 日志结构

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

msg - 详细的日志消息。
traceId - 唯一的 RPC 调用 ID。
data - 包含其他信息的物件。它可能因不同的日志而异。
time - 发生日期。
tags - 与日志关联的标签。可能的标签是 business（有关用户或 API 启动的主要操作的信息）或 details（有关主要操作的详细信息或有关由主要操作触发的其他事件的信息）。

日志示例

{
    "msg": "The user authenticated to the server (userId: xhb1jjs10uq8un9wt0vc)",
    "traceId": "b36f1967-7778-4c0d-97a2-37caba24d59e",
    "data": {
      "socketId": "vem71503nieel8ewoxjb",
      "environmentId": "ciy6g1w4y1a6qm146our",
      "userId": "xhb1jjs10uq8un9wt0vc"
    },
    "time": "2022-04-25T09:53:01.257Z",
    "tags": "business"
}

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

# 日志保留

所有超过 14 天的日志都会定期从环境中删除。这是自动完成的，不需要额外的配置。