nebula-logger-console

使用 Nebula Logger 控制台

控制台简介

Logger 控制台是随 Nebula Logger 一同发布的 Salesforce Lightning 应用。它为管理员、支持工程师和开发者提供了专门的界面来浏览日志，无需每次生产环境发生问题时都手动针对日志管理自定义对象（Log__c、LogEntry__c、LogEntryTag__c、LoggerScenario__c、LoggerTag__c）编写 SOQL。

• 应用 API 名称：LoggerConsole。
• 导航项包括 Log__c、LogEntry__c、LoggerScenario__c、LoggerTag__c 和 LogEntryTag__c。
• 实用程序栏（LoggerConsoleUtilityBar FlexiPage）提供 Logger Settings 面板，可在不离开控制台的情况下编辑生效的层级记录。

标准列表视图

Nebula Logger 为全部五个日志管理自定义对象提供了丰富的列表视图，因此大多数日常调查都不需要自定义视图：

• Log__c：AllLogs、AllOpenLogs、AllClosedLogs、AllResolvedLogs、AllLogsWithERROREntries、AllLogsWithERRORorWARNEntries、AllAsynchronousLogs、AllBatchLogs、AllChildLogs、AllImpersonatedLogs、AllRESTLogs、LogsToPurgeSoon、MyAssignedLogs、MyAssignedOpenLogs、MyGeneratedLogs。
• LogEntry__c：All、AllERRORLogEntries、AllERRORandWARNLogEntries、AllApexLogEntries、AllComponentLogEntries、AllFlowLogEntries、AllHttpRequestLogEntries、AllHttpResponseLogEntries、AllRestRequestLogEntries、AllRestResponseLogEntries、AllExceptionLogEntries、AllImpersonatedLogEntries、AllOmniStudioLogEntries、MyGeneratedLogEntries。
• LogEntryTag__c：All、AllImpersonatedLogEntryTags。
• LoggerScenario__c：All、MyAssignedLoggerScenarios。
• LoggerTag__c：All。

调查事件时，请先使用预建视图，再通过列筛选器缩小范围，然后再创建新的自定义列表视图。

记录页面

Nebula Logger 为每个面向用户的日志管理对象都提供了专用 FlexiPage。LogEntryTag__c 关联对象通过其记录页面浏览，但在日志管理文件夹中没有自己的 FlexiPage，而是使用标准记录页面布局呈现。

日志记录页面

Log__c 记录页面（LogRecordPage FlexiPage）展示：

• 标准 Log__c 字段（事务 ID、保存方法、用户、场景、标签、总计）。
• 按时间顺序排列的相关 LogEntry__c 列表。
• 汇总计数（TotalERRORLogEntries__c、TotalWARNLogEntries__c 等），便于快速查看严重程度。
• 设置了父日志事务 ID 时的相关子日志（参见 Apex 日志记录技能文档中的父子日志关联模式）。

日志条目记录页面

LogEntry__c 记录页面（LogEntryRecordPage FlexiPage）展示：

• 消息、日志级别、来源类型 / API 名称和时间戳。
• 使用 .setRecord(...) 创建条目时的相关记录 ID 和记录 JSON 快照。
• 条目来自异常时的堆栈跟踪和异常字段。
• 应用于该条目的标签（通过 LogEntryTag__c 关联对象）。

日志条目标签记录页面

LogEntryTag__c 记录页面（LogEntryTagRecordPage FlexiPage）展示一行标签关联记录：该标签关联应用到的 LogEntry__c，以及所应用的 LoggerTag__c。直接打开此页面的情况很少——大多数标签调查都通过 LogEntry__c 或 LoggerTag__c 上的相关列表进行——但在通过 AllImpersonatedLogEntryTags 审计被模拟用户的标签活动时，此页面很有用。

Logger 场景记录页面

LoggerScenario__c 记录页面（LoggerScenarioRecordPage FlexiPage）展示场景在任何事务调用 Logger.setScenario(...) 后保存的状态，以及使用该场景的相关 Log__c 记录。可用它来回答“哪些事务在场景 X 下运行，以及分配给谁跟进”。

Logger 标签记录页

LoggerTag__c 记录页（LoggerTagRecordPage FlexiPage）会显示标签目录条目及其关联的 LogEntryTag__c 关联记录，也就是当前带有此标签的所有日志条目。可使用此页面审核标签分类的使用情况，或查找标签目录中的拼写错误／重复项。

主页与实时流

控制台主页（LoggerHomePage FlexiPage）集中展示了控制台中大多数用于日常运维的工具：

• logEntryEventStream - 订阅 LogEntryEvent__e 平台事件，并在日志条目发布时实时显示。测试场景中，无需等待异步保存路径持久化记录，即可通过此工具最快确认日志记录是否正常触发。
• logBatchPurge - 按需触发日志清理批处理，并报告数量。
• loggerSettings - 与实用程序栏中相同的设置编辑器，以整页画布形式展示。
• loggerHomeHeader - 导航页眉，提供指向发行说明、GitHub 和文档的快捷链接。
• 内嵌报表和仪表板，展示 Log__c、LogEntry__c、LogEntryTag__c、LoggerScenario__c 和 LoggerTag__c 中的近期活动。

这些工具汇集在一个页面上，方便管理员回答“当前日志记录是否正常？实际情况如何？”。

典型工作流

调查特定错误

1. 打开 AllERRORLogEntries 列表视图。
2. 筛选感兴趣的时间范围。
3. 打开一条 LogEntry__c 记录——关联的 Log__c 会显示完整事务；Log__c 上的相关列表会按顺序显示该事务中的所有条目。
4. 如果事务属于异步链，请沿 ParentLog__c 向上追溯到父事务。

调查用户会话

1. 打开 AllLogs 列表视图。
2. 按 LoggedBy__c 和时间范围筛选。
3. 按 StartTime__c 排序，查看用户的事务顺序。

确认复现问题时日志记录是否正常触发

1. 打开 Logger Console 主页（LoggerHomePage）。
2. 找到 Log Entry Event Stream 组件。
3. 在另一个标签页中复现该场景。
4. 观察 LogEntryEvent__e 平台事件发布时出现的条目。条目停止出现时，表示异步保存已完成；此时可以查询 Log__c、LogEntry__c、LogEntryTag__c、LoggerScenario__c 和 LoggerTag__c 中已持久化的记录。

相关技能

• nebula-logger-instrumentation - 编写显示在此处的日志条目。
• nebula-logger-purging-and-retention - 了解这些视图中的记录会保留多久。