HarmonyOS 鸿蒙Next HiLog日志能力介绍

HarmonyOS 鸿蒙Next HiLog日志能力介绍

• 日志打印及显示。

  • ArkTS接口：使用HiLog打印日志（ArkTS）。

  • NDK接口：使用HiLog打印日志（C/C++）。

  • 日志打印格式：

    日期 时间 进程号 线程号 日志级别 domainID/日志标签: 日志内容
    

  • 如下所示，这是一条domainID为0x003200和标签是"testTag"的info级别的日志：04-19 17:02:14.735 5394 5394 I A03200/testTag: this is a info level hilog

  • 说明：

    • 日志级别：I表示Info级别，其余级别参考日志等级首字母。
    • domainID：A03200中A表示应用日志，3200表示domainID为0x3200。
    • 约束与限制：单条日志最大长度为4096个字符，超出部分将会被截断丢失。

• 日志配置。

• 日志等级。

  • 说明： 日志级别要符合日志内容的实际级别，日志级别说明如下：

    • FATAL：重大致命异常，表明程序或功能即将崩溃，故障无法恢复。
    • ERROR：程序或功能发生了错误，该错误会影响功能的正常运行或用户的正常使用，可以恢复但恢复代价较高，如重置数据等。
    • WARN：发生了较为严重的非预期情况，但是对用户影响不大，程序可以自动恢复或通过简单的操作就可以恢复的问题。
    • INFO：用来记录业务关键流程节点，可以还原业务的主要运行过程；用来记录非正常情况信息，但这些情况都是可以预期的(如无网络信号、登录失败等)。这些日志都应该由该业务内处于支配地位的模块来记录，避免在多个被调用的模块或低级函数中重复记录。
    • DEBUG：比INFO级别更详细的流程记录，通过该级别的日志可以更详细地分析业务流程和定位分析问题。DEBUG级别的日志在正式发布版本中默认不会被打印，只有在调试版本或打开调试开关的情况下才会打印。

• 日志超限机制。

  为了防止日志打印流量过大导致应用性能恶化和打印失败问题，hilog日志打印时增加超限机制，debug应用默认关闭此机制。 应用进程级别超限机制：应用日志打印时受进程级别超限机制管控，每个进程每秒日志量不超过50K，超过的日志不进行打印，并且有超限提示日志打印，本地调试是可以通过命令关闭应用日志超限机制： hilog -Q pidoff。

  • 应用超限提示日志打印：

    04-19 17:02:34.219  5394  5394 W A00032/LOGLIMIT: ==com.example.myapplication LOGS OVER PROC QUOTA, 3091 DROPPED==
    

  • 说明：本条日志标识进程5394在17:02:34时由于日志打印超限，超限日志有3091行未打印。

• 日志隐私机制。

  为了防止隐私信息泄露，开发者编写代码是需要考虑日志内容是否敏感，对于隐私信息（格式化控制符没有%{public}标识符）的打印，默认打印出来是“private”字符串，debug应用默认关闭此机制。

  • 日志打印：

    OH_LOG_ERROR(LOG_APP, "%s failed to visit %{private}s, reason:%{public}d.", name, url, errno);
    

  • 日志显示：

    12-11 12:21:47.579 2695 2695 E A03200/MY_TAG: <private> failed to visit <private>, reason:11.
    

  • name和url参数格式化符没有%{public}开头，则显示为隐私数据，默认显示"<private>"字符串

• 日志落盘机制。

  开发者可以通过命令将buffer中的日志落盘到/data/log/hilog中。

  • hilog日志落盘命令：

    hilog -w start
    

    hilog -w start -l 8M -n 100
    

  • 日志落盘任务查询命令：

    hilog -w query
    

  • 停止日志落盘命令：

    hilog -w stop
    

• 使用场景介绍（不同打包场景下）：

  • Debug包。 输出全量日志。
  • Release包。 默认不输出debug级别日志，可以参考日志等级修改来输出debug级别日志。

• 丢失排查。

  • 日志丢失分为不同原因，结果也不一样。

    • 某些日志必定不打印： 大概率是因为打印参数传入错误（可以参考一下打印指导：HiLog使用指导），代码分支没有走到，请先排查代码原因。

    • 打印过程中代码概率性丢失（某些日志必能打印，但是打印发现时有时无）： 注意如果打开全量D级别日志时，可能会导致后台日志流量太大，导致日志概率性丢失，可以只打开部分domainID的D级别日志，同时可以参考优化日志丢失调试方法。

    • 优化日志丢失调试方法：

      • 排查日志级别是否合理。

      • 排查代码分支是否走到。

      • 排查日志打印时间点附件有无“LOGLIMIT”、“Slow reader”关键字。

        • LOGLIMIT: 进程日志量过大触发了超限机制、可以使用hilog -Q pidoff命令关闭超限机制。

        • 04-24 17:02:50.167 2650 2650 W A01B01/LOGLIMIT: ==com.ohos.sceneboard LOGS OVER PROC QUOTA, 46 DROPPED==

        • Slow reader: 整机日志量过大导致hilogd buffer中日志被老化掉，可以使用hilog -G 8M增加hilogd buffer内存大小。04-24 17:02:19.315 0 0 I C00000/HiLog: ========Slow reader missed log lines: 209

        • 同时查看是否后台有领域频繁打印日志导致，若发现某个领域日志频繁打印，影响正常日志读取，可以通过命令关闭其领域的日志打印，参考日志等级设置。

    • 整体日志量过大时，可能会导致日志写入socket失败，可以关闭其他日志，只显示自领域日志，例如，只想系统打印0xd003200和 0xd003201的日志，可以执行下面的命令，重启失效：

      hilog -b X
      hilog -b I -D d003200
      hilog -b I -D d003201
      

• 日志等级设置

  日志等级默认为I级别，调试过程中可以使用hilog -b命令修改日志打印等级，测试过程中切记不要打开全局D级别日志，可能会导致日志量过大触发超限机制，若需要打印自模块的D级别日志定位问题可以根据domainID或者Tag设置日志级别。

  • 目前有两类日志打印不受日志级别拦截：

    • debug hap包打印的js日志。因为外部开发者使用hilog打印时，不了解日志级别拦截机制，打印D级别日志时如果打印不出来会影响开发效率。
    • hilog base接口打印的日志。因为一些底层库是通过hilog base接口打印日志，不能调用hilog等级判断接口，日志打印时是直接写入socket。

  • 修改日志等级：

    • 日志级别从高到低：FATAL > ERROR > WARN > INFO > DEBUG。

    • hilog -b F/E/W/I/D， 表示设置当前的全局日志级别，高于这个级别的日志才能打印出来。

      • 想打印Error级别及以上的：hilog -b E。
      • 想打印Debug级别及以上的：hilog -b D。