如何打一手好Log(转)

  如果项目上过线的话,那你一定知道Log是多么重要。

  为什么说Log重要呢?因为上线项目不允许你调试,你只能通过Log来分析问题。这时打一手好Log的重要性绝不亚于写一手好代码。项目出问题时,你要能拿出Log证明自己负责的部分没有问题,如果是自己的问题,要从Log里快速找出错误原因。如果没有从Log里找出错误原因,那一定是一件很悲催的事情,特别是在bug不容易重现的情况下。那简直就是叫天天不灵,叫地地不应啊。

 

  一.Log级别

  Log最常用的级别就是DEBUG,INFO,WARN,ERROR,其他的很少用。如何运用合适的Log级别也是非常重要的,在不该用ERROR的地方用了ERROR,可能会给你带来额外的麻烦。下边仅根据自己的使用习惯,分别说一下我对各种级别的理解。

  1.ERROR:

  ERROR是错误的意思,但不代表出现异常的地方就该打ERROR。我认为ERROR是相对程序正确运行来说的,如果出现了ERROR那就代表出问题了,开发人员必须要查一下原因,或许是程序问题,或许是环境问题,或许是理论上不该出错的地方出错了。总之,如果你觉得某个地方出问题时需要解决,就打ERROR,如果不需要解决就不要打ERROR。

  举例来说,如果有一个接口。调用者传过来的参数不在你的接受范围内,在这种情况下你不能打ERROR,因为传什么值是用户决定的,并不影响程序正确运行。想象一下,如果你的服务器上有监控程序的话,检测到ERROR或WARN就报警,参数错误你也打ERROR,那运维人员会疯掉的。

  如果做一个对讲机,在解析语音数据包时出错了,那就要打ERROR了,因为这个是理论上不该出错的地方,要不就是你的解析代码有问题,要不就是开发人员在拼凑语音包时存在问题,这个时候需要你来找出问题的原因。所以应该打ERROR。

  2.WARN:

  WARN是指出现了不影响程序正确运行的问题,WARN也是问题但不影响程序正常运行,如果WARN出现的过于频繁或次数太多,那就代表你要检查一下程序或环境或依赖程序是否真的出问题了。

  假如你访问一个接口,设置了一个超时,超时之后会抛异常,你在try块里不该打ERROR也不该打INFO来无视它,这时你应该打WARN,紧紧是警告一下,如果超时过多那就该检查一下了,是不是对方接口有问题了或者是网络环境出问题了。

  3.INFO和DEBUG:

  ERROR和WARN是指有问题,而INFO和DEBUG就是指一般的信息了。在程序出问题时,如果这条log可以帮助你分析问题或查看程序的运行情况,那就应该打个INFO。如果仅仅是为了在调试阶段查看程序是否运行正确那就要打DEBUG。前边讨论的接口参数错误问题,就应该打个INFO了,调用者说你的接口总是返回错误代码,你可以告诉他,是他的哪个参数传错了。

 

  二.如何打

  1.log必备信息

  在每一条log中都要将时间、类名及函数名,可以的话将行号也打印出来(不建议手写行号),像java的log4j就是不错的。

  2.函数开始结束处

  在重要函数的开始结束出应该打上log ,这样在看log时会比较直观,什么时候开始什么时候结束就会一目了然,万一中间出异常导致程序退出了,也知道是在哪个函数突然中断的。也同样适用于一个重要逻辑块的开始结束。

  3.返回结果

  尽量在重要函数或web接口的每个返回分支打印返回结果。在出现不好分析的异常时,从细节下手,这时log会派上用场。如果跟合作方在数据方面出现争议也可以及时拿出证据。

  4.添加Exception异常的捕获

  如果你在代码中捕获了某种异常,那你要在try块后添加Exception的捕获,以防出现运行时异常中断程序。

  5.务必打印堆栈信息

  在异常捕获代码中务必要将堆栈信息打印出来,否则打了那么多的log可能会功亏一篑。

  6.多线程的log

  在多线程的程序中,log最好要标记thredId,否则可能不知道是哪个线程的作业,也无法有条理的来观察一个线程。

  7.成功失败标志

  如果某个函数是做一件比较关键的事情,那么这件事情成功还是失败了,要打印log,否则关键事件运行结果如何都拿不出证据的话,实在是不能让人信服。

  8.前后log的关系

  如果是web程序或接口,那log就不是按照你预定的顺序出现的,可能是好几个响应的log穿插在一起的。代码里如果有几条log前后存在一定的数据关系,那么要将这几条log的关联信息打出来,用来确定是针对同一个响应的。如果没有明确的标志,很难说后边的log跟前边的log是同一个响应或者是针对同一条数据。

  9.关于耗时

   访问一个第三方接口、上传下载文件等可能耗时的操作,都要记录完成这个操作所耗的时间。否则程序性能出了问题,你不知道是网络原因呢,还是你调用的第三方接口性能出现问题呢,还是你自己程序的问题呢。

  10.关于数量

   涉及到数量的操作要打印log,比如查询数据库和批量拷贝文件、上传下载、批量格式转换等批量操作,设计到的数量要打印出来。

 

  总之,打log的目的是为了迅速排错或在有争议时拿出证据证明自己。基于这个目的,log不在多,只要抓住一切对自己有利的信息,就可以了。

  想起其他的再继续补充吧,欢迎大家拍砖补充。

  http://www.cnblogs.com/luguo3000/p/3543487.html

时间: 2024-12-01 07:06:05

如何打一手好Log(转)的相关文章

SpriteBuilder添加的TrueType字体未显示在log中的原因分析

按照书上的说法,在SpriteBuilder中添加的TrueType字体名称会在枚举字体方法显示的log中出现.但是运行程序后没有在log中发现对应的字体名称. 因为该字体是例子中作者制作的,所以字体名称与文件名称一定是匹配的(除了没有文件后缀).而且在运行的程序中的确看到了该字体正确的显示效果(Settings用的是系统自带字体,Slider左边的label字体是用户的TrueType字体): 这就证明字体已经加载成功了,但是为毛log中没有呢? 后来才知道,原来log是在MainScene中

【转载】/var/log/[messages|syslog|kern.log] 的差别

For the purposes of kernel logging, why do I have three different, non-inclusive levels of logging amongst /var/log/messages, /var/log/syslog, and /var/log/kern.log?  Syslog is a standard logging facility. It collects messages of various programs and

warning The transaction log file is corrupted.

Remark Even if appealing using compress option has a constraint when preparing the backup, as clearly stated by Percona: Before you can prepare the backup you'll need to uncompress all the files with qpress. The error message you get is : xtrabackup:

日志-怎么控制,不让linux下debug信息输出到Tomcat下log/catalina.out

问题描述 怎么控制,不让linux下debug信息输出到Tomcat下log/catalina.out 最近维护服务器的时候,发现上传上去的文件大小全部为0, 一查才知道磁盘已经被占满了,排查下来发现tomcat下log/catalina.out文件 竟然达到惊人的10G,观察里面的信息,几乎全部是项目的debug信息, 而项目log4j的配置输出地址日志信息正常,等于是日志信息正常打印到指定位置之后, 又重复打印到catalina.out. 搜了下这个问题,几乎全是如何分割或清空catalin

Linux system log avahi-daemon[3733]: Invalid query packet

在检查Linux的日志文件时,发现大量 avahi-daemon[3733]: Invalid query packet错误(不同服务器对应的数字有所不同) Aug  3 07:00:01 hostname auditd[3143]: Audit daemon rotating log files Aug  3 08:02:39 hostname avahi-daemon[3733]: Invalid query packet. Aug  3 08:03:19 hostname last mes

C++ 日志库 boost::log 以及 glog 的对比

该文章转自阿里ata精选文章,作者为苏樽 日志能方便地诊断程序原因.统计程序运行数据,是大型软件系统必不可少的组件之一.本文将从设计上和功能上对比 C++ 语言常见的两款日志库: boost::log 和 google-glog .   设计 boost::log 的设计主要有日志器( Logger ).日志核心( Logging core ). Sink 前后端( frontend, backend )组成.日志文本以及日志环境由日志器( Logger )负责搜集,日志核心负责处理日志数据(例

extension-关于android里面发邮件的问题,下面是我运行时候的log,请各位帮我看一下。

问题描述 关于android里面发邮件的问题,下面是我运行时候的log,请各位帮我看一下. 04-07 14:06:05.294: I/System.out(2970): DEBUG: JavaMail version 1.4.104-07 14:06:05.294: I/System.out(2970): DEBUG: not loading file: /system/lib/javamail.providers04-07 14:06:05.298: I/System.out(2970):

如何从 Xcode 控制台输出 JavaScript 的 log?

调试 UIWebView 中的 JavaScript 一直以来都是很痛苦的一件事.通常我们会通过下面的方法调试 HTML 和 JavaScript. 1.第一种,使用桌面浏览器调试.大多数现代浏览器都有功能强大的调试器,可以通过 console.log() 方法进行调试. 2.如果桌面浏览器不能追踪到这些 log,我们可以从 Xcode 启动 iOS 模拟器,运行我们的 app.然后,启动 Safari 选择 Develop > iPhone Simulator > tieba.baidu.c

Apache 服务器Log分析应用实例

apache|服务器|应用实例 Apache 服务器Log分析应用实例 rhinux 发表于: 2004-11-28 22:11 互联网的飞速发展,无论是传统企业的网站,还是互联网企业,为了了解自己的客户来源,点击率等资料,对网站日志的分析尤为重要,以下就本人所做的日志分析系统与大家分享,希望能对大家有所帮助. 欢迎大家复制,但请大家保留本文的完整,谢谢!! 一,所用软件及工具 1,Apache服务器 官方网址:http://www.apache.org 2,awstats 日志分析软件 官方网