如何编写更容易排查问题的错误日志



一、程序错误日志的内容可能存在如下问题

 

 

1、错误日志没有指明错误参数和内容

2、错误场景不明确

3、内容不明确, 或不明其义

4、排查问题的引导内容不明确

5、错误内容不够具体细致

6、半英文句式读起来不够清晰明白，需要思考来拼凑起完整的意思

 

 

二、如何编写更容易排查问题的错误日志 

 

1、尽可能完整。 每一条错误日志都完整描述了： 什么场景下发生了什么错误， 什么原因（或者哪些可能原因）， 如何解决（或解决提示）；

 

2、尽可能具体。 比如 NC 资源不足， 究竟具体指什么资源不足， 是否可以通过程序直接指明； 通用错误，比如 VM NOT EXIST ， 要指明在什么场景下发生的，可能便于后续统计的工作。

 

3 、尽可能直接。 最理想的错误日志应该让人在第一直觉下能够知道是什么原因导致，该怎么去解决，而不是还要通过若干步骤去查找真正的原因。

 

4、将已有经验集成直接到系统中。 所有已经解决过的问题及经验都要尽可能以友好的方式集成到系统中，给新进人员更好的提示，而不是埋藏在其他地方。

 

5、排版要整洁有序， 格式统一化规范化。 密密麻麻、随笔式的日志看着就揪心， 相当不友好， 也不便于排查问题。 

 

6.、采用多个关键字唯一标识请求，突出显示关键字： 时间、实体标识（比如vmname）、操作名称。

参考资料：  如何编写错误日志才更容易排查问题   http://www.studyofnet.com/news/826.html