用途:指导在 Salesforce 组织中首次安装并完成 Nebula Logger 的初始配置。相比仅用 System.debug(),它提供跨 Apex、LWC、Aura、Flow、OmniStudio 的一致、可查询日志模型,便于按业务记录、场景或标签检索历史日志。
包选择:解锁包无命名空间、补丁更快、源码可见、支持插件框架、功能最全,是多数团队的默认选择;管理包带 Nebula 命名空间、发布节奏较慢(约每年三次),功能为子集且暂无插件框架,仅在必须使用命名空间时选用。安装前请在 GitHub releases 确认最新版本。
安装方式:解锁包 v4.19.5 提供沙箱与生产安装链接,CLI 命令为 sf package install --wait 20 --security-type AdminsOnly --package 04tg7000000IzRdAAK;管理包 v4.19.0 的 CLI 命令为 sf package install --wait 30 --security-type AdminsOnly --package 04tg7000000GZbJAAW。
权限集:LoggerAdmin(完全控制)、LoggerLogViewer(只读)、LoggerEndUser(受限日常访问)、LoggerLogCreator(生成日志所需最小权限,适用于集成与 Experience Cloud 组件用户)。
配置:通过 LoggerSettings__c 层级自定义设置按组织默认、简档、用户三级调整,重点字段包括 IsEnabled__c、LoggingLevel__c、DefaultSaveMethod__c、DefaultLogPurgeAction__c、DefaultNumberOfDaysToRetainLogs__c。注意旧资料中的 DefaultLoggingLevel__c 在当前代码库中已改为 LoggingLevel__c。
参数与脱敏:LoggerParameter__mdt 自带约 40 条记录控制运行时行为,可按需调整 SOQL 同步查询、堆栈解析、堆大小捕获、状态 API 调用及各类功能开关;每条记录含 Description__c 说明。LogEntryDataMaskRule__mdt 提供社保号与几种信用卡号的脱敏规则,含正则、替换模式、作用范围与启用开关,可按组织需要补充自定义规则并先测试正则。
限制与排查:日志未生成时优先检查权限集分配,尤其是 LoggerEndUser 或 LoggerLogCreator。修改 CMDT 记录属于行为变更,应重跑相关测试。后续可参考日志埋点、清理与保留、最佳实践及控制台相关技能。