如何编写更容易排查问题的错误日志
2015-06-01 09:45
267 查看
一、程序错误日志的内容可能存在如下问题
1、错误日志没有指明错误参数和内容
2、错误场景不明确
3、内容不明确, 或不明其义
4、排查问题的引导内容不明确
5、错误内容不够具体细致
6、半英文句式读起来不够清晰明白,需要思考来拼凑起完整的意思
二、如何编写更容易排查问题的错误日志
1、尽可能完整。 每一条错误日志都完整描述了: 什么场景下发生了什么错误, 什么原因(或者哪些可能原因), 如何解决(或解决提示);
2、尽可能具体。 比如 NC 资源不足, 究竟具体指什么资源不足, 是否可以通过程序直接指明; 通用错误,比如 VM NOT EXIST , 要指明在什么场景下发生的,可能便于后续统计的工作。
3、尽可能直接。 最理想的错误日志应该让人在第一直觉下能够知道是什么原因导致,该怎么去解决,而不是还要通过若干步骤去查找真正的原因。
4、将已有经验集成直接到系统中。 所有已经解决过的问题及经验都要尽可能以友好的方式集成到系统中,给新进人员更好的提示,而不是埋藏在其他地方。
5、排版要整洁有序, 格式统一化规范化。 密密麻麻、随笔式的日志看着就揪心, 相当不友好, 也不便于排查问题。
6.、采用多个关键字唯一标识请求,突出显示关键字: 时间、实体标识(比如vmname)、操作名称。
参考资料: 如何编写错误日志才更容易排查问题
http://www.studyofnet.com/news/826.html
一、程序错误日志的内容可能存在如下问题
1、错误日志没有指明错误参数和内容
2、错误场景不明确
3、内容不明确, 或不明其义
4、排查问题的引导内容不明确
5、错误内容不够具体细致
6、半英文句式读起来不够清晰明白,需要思考来拼凑起完整的意思
二、如何编写更容易排查问题的错误日志
1、尽可能完整。 每一条错误日志都完整描述了: 什么场景下发生了什么错误, 什么原因(或者哪些可能原因), 如何解决(或解决提示);
2、尽可能具体。 比如 NC 资源不足, 究竟具体指什么资源不足, 是否可以通过程序直接指明; 通用错误,比如 VM NOT EXIST , 要指明在什么场景下发生的,可能便于后续统计的工作。
3、尽可能直接。 最理想的错误日志应该让人在第一直觉下能够知道是什么原因导致,该怎么去解决,而不是还要通过若干步骤去查找真正的原因。
4、将已有经验集成直接到系统中。 所有已经解决过的问题及经验都要尽可能以友好的方式集成到系统中,给新进人员更好的提示,而不是埋藏在其他地方。
5、排版要整洁有序, 格式统一化规范化。 密密麻麻、随笔式的日志看着就揪心, 相当不友好, 也不便于排查问题。
6.、采用多个关键字唯一标识请求,突出显示关键字: 时间、实体标识(比如vmname)、操作名称。
参考资料: 如何编写错误日志才更容易排查问题
http://www.studyofnet.com/news/826.html
相关文章推荐
- Android 实现ActionBar定制
- 男士拍照经典姿势
- Masonry介绍与使用实践(快速上手Autolayout) 来自里脊串的开发随笔
- openwrt下安装和配置ser2net
- 百度分享--分享按钮的实现
- 嵌入式 自旋锁、互斥锁、读写锁、递归锁
- 如何用Spring 3.1的Environment和Profile简化工作
- 嵌入式 互斥锁和读写锁区别
- 百度分享--分享按钮的实现
- js统计文本框内已输入字数
- Android性能优化之查看GPU渲染性能
- Esper学习之二:事件类型 .
- javascript 用call来继承实例属性
- 浅谈JS DDoS攻击原理与防御
- ubuntu创建新账号在登录界面找不到相应的帐号
- Java数组不能通过toString方法转为字符串
- 使用旗正规则引擎内存表出错的原因及解决方法
- JavaScript实现把rgb颜色转换成16进制颜色的方法
- linux查看java jdk安装路径和设置环境变量
- 利用正则表达式来设置最大输入字符长度