有关日志打印的几点经验

客官°小女子只卖身不卖艺 2022-08-09 16:41 233阅读 0赞

前段时间，完善智能导航发送告警短信中短信太长接收不到的bug，牵涉出了日志打印的问题；日志打印这件事说小事小，说大也大，写好日志能方便自己调试代码和发现解决问题，以下就是有关日志打印自己总结的几点经验教训：

日志打印应该分层、分角度，一个好的日志不应该只打印与业务有关的日志。  
日志打印应该从以下几个方面去打印：

**模块运行日志**：模块运行日志包括消息队列的监控、线程的运行状态。该日志应该以INFO级别打印，并且采用间隔打印，或叫做定时打印。以减少日志打印总量。从该角度可以反应出该模块是否有消息队列积压，是否所有线程都运行正常。消息队列的打印可以采用日下格式：

09:16:59.347  INFO  |Monitor|ReceiveTimerQueue|0/s|0/s|0|0|0|
    09:16:59.347  INFO  |Monitor|SendRegistQueue|0/s|0/s|0|0|0|
    09:16:59.347  INFO  |Monitor|boss->omc|0/s|0/s|0|0|0|
    09:16:59.347  INFO  |Monitor|SendQueue|0/s|0/s|0|0|0|
    09:16:59.347  INFO  |Monitor|boss->pss|0/s|0/s|7037|7037|0|
    09:16:59.347  INFO  |Monitor|ReceiveAuthQueue|0/s|0/s|0|0|0|
    09:16:59.347  INFO  |Monitor|ReceiveQueue|0/s|0/s|0|0|0|
    09:16:59.348  INFO  |Monitor|receiveHandler5|0|SendHandler1|0|receiveAuthMsgHandleThread1|0|
    receiveTimerMsgHandler1|0|SendRegHandler|0|SendHandler3|0|SendHandler2|0|receiveHandler4|0|receiveHandler8|0|receiveHandler7|0|receiveHandler2|0|receiveHandler3|0|receiveHandler6|0|receiveHandler1|0|

**模块性能日志**：模块的性能日志应该能够通过该日志清晰的反应该模块目前性能，包括外部请求的压力，内部请求处理速度。

**模块外部资源日志**：模块的外部资源日志需要详细记录，现今单独的模块很少见了，很多大型复杂的系统往往是由多个模块构成，模块间采用或标准或私有协议进行通信。这种场景下爆发的问题往往比较复杂，并且与多个模块都有关系或是责任。所以在模块级别上将该模块所依赖的外部资源都打印出来非常重要，通过这些日志应该能够完成快速定位问题与哪些模块相关联或是哪些模块需要负根本责任。通常模块的外部资源包括数据库，系统间内部模块、第三方系统。如BossAgent的外部资源包括数据库，系统间内部模块为PSS、第三方系统应该是一级Boss。数据库资源的打印应该包括所有的SQL语句，这个非常重要，无论是问题的定位还是后续的SQL优化，还是数据库架构的调整，都需要这些信息能够快读的整理出该模块所有的SQL语句，提供给专业的DBA进行分析。SQL语句的打印还应该包括参数的打印。

第三方系统的打印主要包括，请求压力的统计、截流告警、请求处理的延迟、以及超时。

**1、对异常的打印**

异常日志的打印对于问题的分析和定义有极大的帮助，异常日志的打印应该注意以下几点，杂异常分支必须打印日志。如switch case语句块中的default，if else中的 else分支。Try catch语句块中catch分支。对于catch分支的打印，应该尽量使用标准的异常打印，不应该打印的控制台上，对于异常的处理不在本开发指南的讨论范围，所以简单说明。异常应该打印堆栈信息，并且打印日志发生的场景。

**2、日志级别**

日志级别对于定位问题的重要性，在现网运营的过程中，往往都会打印低级别的日志，一些过于详细得日志记录程DEBUG，而一些总结性的日志记录为INFO级别，对于外部资源日志，如果日志过于庞大，请将日志打印为DEBUG日志，在此基础上在抽取总结性日志，打印为INFO日志。

**3、考虑日志对性能的影响**

日志的频繁打印会对模块的性能产生极大的影响。如BPP的在每次接受到消息后都会打印消息结构体，将该日志注掉，性能在原有的基础上上升了600条/秒。

**4、日志打印内容**

4.1 不打印无用的日志

如现网的BossAgent将与PSS之间通信的心跳消息结构体打印出来，该日志不仅打印频繁，而且没有任何意义。

4.1 不打印不完全的日志

不打印不完全的日志，如BossAgent的消息队列积压的告警日志，只打印了消息队列满，但是没有打印是谁满了，也就是缺少主语，对于后续的定位产生了极大的阻碍。

4.3不打印重复的日志

如上BossAgent日志，将MM2消息结构体打印了多次，没有任何意义。

4.4不在循环里打印日志

如果代码的逻辑是一个无限循环或是循环的次数较多，这里的日志不应当打印太过频繁，使用尽量缩减日志量，并且将有用的信息打印出来。在循环打印日志或占用大量CPU时间，这里需要进行特殊的打印。就是采取间隔打印或是定时打印。

5、日志格式

日志格式统一使用**主语+谓语+宾语+状语**的格式，日志打印应该遵从人类的自然语言，任何没有开发经验或是外行人都能从你的日志中捕获到有用的信息，相信你的日志就打印的很成功了。

加入分隔符，使用分隔符使每个域都能够清晰识别，分隔符可以提高日志可分析性，也可以过滤空格。

如下日志：13722223310 register 200，没有采用域分隔符，这样都手机号码中出现异常数据如13722223310+空格，无法快速定位。加入域分隔符以后13722223310 |register|200|，可以清晰的看清楚手机号码后有多余的空格。

还有更多的有关日志打印的内容参照以下文章。

[http://ju.outofmemory.cn/entry/72841][http_ju.outofmemory.cn_entry_72841]

[http://blog.csdn.net/mgoann/article/details/5681759][http_blog.csdn.net_mgoann_article_details_5681759]

[http_ju.outofmemory.cn_entry_72841]: http://ju.outofmemory.cn/entry/72841
[http_blog.csdn.net_mgoann_article_details_5681759]: http://blog.csdn.net/mgoann/article/details/5681759