# Log 日志管理

SDK 日志主要包括控制台输出和本地持久化日志两部分。控制台日志适合开发和问题复现阶段使用;如果需要在应用运行后保留日志文件,则需要额外集成 XLog 扩展 SDK。

重要

控制台日志和本地日志文件的输出,前提是 SDK 初始化时配置了有效的 logLevel。

logLevel 默认值为 none。如果初始化 SDK 时没有开启日志级别,即使日志代理配置了 isConsoleLog、writeFile 等属性,也不会产生对应的控制台日志或本地日志文件。

# 1. 日志初始化配置

# 1.1 配置 SDK 日志级别

SDK 初始化时通过 IFinAppConfig.logLevel 配置日志级别,支持 none、info、debug、warn 和 error,默认为 none。

日志代理的具体配置方式(包括控制台输出、文件写入、日志目录、日志保留时间和日志回调)请参考 LogHandler。

日志代理需要在 FinAppClient.init(...) 之前完成配置,SDK 初始化后再修改代理配置,可能无法影响已经创建的日志实例。

# 1.2 集成 XLog 扩展 SDK

从 1.4.3 版本开始,核心 SDK 不再包含将日志持久化存储在本地的功能。

如果需要持久化日志,请集成 XLog 扩展 SDK,并在核心 SDK 初始化之前调用:

import { FinAppletXLog } from '@finclip/xlog-sdk'

// 必须在 FinAppClient.init(...) 之前调用
FinAppletXLog.init()

完成 XLog 初始化后,再按需配置 LogHandler,最后调用 FinAppClient.init(...)。只有集成 XLog 后,日志代理中的 writeFile 配置才会用于本地文件落盘。

# 2. 导出日志文件

集成 XLog 并开启文件写入后,可以使用 hdc 文件传输工具 (opens new window) 导出日志文件。

默认日志目录为:

${context.filesDir}/${productIdentification || 'Applet'}/logs/

在默认入口模块 entry 下,常见路径如下。请将包名、入口模块名和本地路径替换为实际值:

hdc file recv /data/app/el2/100/base/包名/haps/入口模块名/files/Applet/logs /local/path/on/pc

如果配置了自定义 logDir,请将命令中的日志目录替换为自定义路径。

XLog 使用异步方式写入日志。刚产生的日志可能暂时保留在缓冲区中,未立即出现在文件里;SDK 销毁生命周期会刷新并关闭日志。XLog 文件为二进制压缩格式,不能直接使用文本编辑器查看,需要使用匹配的 XLog/Mars 解码工具进行解析。

# 3. 日志文件不存在时的排查方式

  1. SDK 初始化时的 logLevel 是否设置为 none;
  2. 是否已经集成 @finclip/xlog-sdk;
  3. 是否在 FinAppClient.init(...) 之前调用了 FinAppletXLog.init();
  4. 日志代理是否将 writeFile 设置为 false;
  5. 是否配置了自定义的 logDir;
  6. 是否配置了 productIdentification,如果配置了,需要将默认路径中的 Applet 替换为对应的标识;
  7. 包名和入口模块名是否正确;
  8. 日志是否刚产生,仍在异步写入缓冲区中。

# 4. 生产环境使用建议

  • 不需要持久化日志时,不要仅为了开启控制台日志而集成 XLog;
  • 生产环境应按需设置 logLevel,并关闭不必要的控制台输出;
  • SDK 不会自动上传日志,日志导出、脱敏和上传由宿主自行处理;
  • 日志保留时间的最小生效值为 1 天,请根据实际需求配置。
© FinClip with ❤ , Since 2017