Logging,你用对了吗?

这是一篇外文,介绍了日志的使用,原文在这里。下文由本人翻译。

最近Stack Overflow上有个帖子讨论了一个程序员的日志风格,里面提到了他的日志风格:

INFO 级别

  • 打印方法的开始和结束log
  • 打印重要的循环的开始和结束log
  • 打印重要的case/switch语句的开始(进入)log

DEBUG 级别

  • 打印传入方法中的参数
  • 打印(数据库等)查询结果集的行数
  • 打印传递给方法是可能包含某些不确切数据的数据记录
  • 打印任何“生成的”文件路径,连接字符串,或者其他在特定环境中被拼接起来的值

ERROR Level

  • 打印异常的处理
  • 无效的登录行为 (特别是一些故意为之的安全问题)
  • 在不应该出现的地方出现的打印log,可以帮助生成不良数据报告

FATAL 级别

  • 未能处理的异常,一般需要停止程序运行等.

我并非有意把这个作者曝光这是作者,但是他确实有点过了…

虽然我自己不是logger的重度患者,但是我在Stack Overflow上的一个队友就是,因此在我们建立Stack Overflow时,我们使用了 log4net,并在各个层次上记录了一堆信息。我绝对不会成为这种做法的粉丝的,因为我能说出这种做法的种种害处。

诚然logging是有某种诱人的魅力的,为什么不多多益善呢?即使您今天不打算使用它,但是谁知道,它可能对明天的故障排除很有用。哎呀,只需记录一切!它可能会受到什么伤害?

哦,是的,日志看起来似乎没有害处,但让我告诉你,它可能会造成一些严重的伤害。我们遇到了一个特别讨厌的递归日志记录bug:

  • 在线程#1, 我们的代码正在执行Log (lock) / DB stuff (lock)
  • 在线程#2, 我们的代码正在执行 DB stuff (lock) / log stuff (lock)

如果这些事情在负载较重的情况下发生,这会导致 - 你猜对了 - 这是一种传统的无序死锁情况。我不确定你会在轻负载很小的应用中看到它,但在我们的网站上,平均每天发生一次。

我不怪怪这个log4net,我怪我们的蹩脚代码。我们花了几天时间解决这些死锁问题,等待它.. 添加更多日志记录!这自然会使问题变得更糟,甚至更难以弄清楚。我们最终被迫采取内存转储并使用转储分析工具。在Greg Varveris的慷慨帮助下,我们终于找到了罪魁祸首:我们的采伐策略。多么讽刺。我的意思是真正的讽刺,而不是假Alanis Morrissette那种

虽然我是一个非常信任日志记录异常的人,但我从来没有成为“让我们记录所有可能的东西”这种感觉的重度logging患者:

  1. Logging意味着更多的代码. 如果您使用的是像log4net这样的传统日志框架,则每个记录的事件都至少有一行代码。记录越多,代码越大。这是一个严重的问题,因为代码是敌人。可见日志代码很混乱 - 就像过多的评论一样,它会主动掩盖在应用程序中做实际工作的代码。
  2. Logging可不是免费的. 大多数日志记录框架相当高效,但它们速度并不是很快。您写入磁盘的每个日志行都会对应用程序造成总体性能成本。如果您正在解剖复杂的对象以将它们放入日志中,这也可能非常棘手; 这需要额外的时间。
  3. 值得保持到日志文件中的内容,也应该显示在用户界面上. 这是一个悖论:如果你记录的信息非常有价值,它应该在应用程序本身中出现,而不是隐藏在某个匿名日志文件中,即使只是为了管理员。日志文件往往是有用的数据最后积灰的地方,然后就没有然后了。
  4. 你打印的日志越多,你能找到的有用信息就越少 记录足够多的东西,最终你的日志就会变得非常杂乱,没有人能找到任何东西。把自己埋在一堆日志数据中很容易。天哪,这还是日志吗,你要知道每台计算机天生就能产生任何人一辈子都读不完的日志数据。也就是说,过度的日志打印本身就是一种巨大的开支,因为你要挥霍巨大的脑力要理解它。不要和我说你的Logger工具有多好,你要在上千M的字节里面找到有用的Debug信息,求你了,别再装逼了。
  5. 日志文件多数情况下并不能给你带来及时准确的信息 如果你足够幸运,是可以让团队里面的每个开发者对FATAL、ERROR、DEBUG、INFO以及其他一些日志级别形成统一认识。如果你只打算logging那些连环杀人凶手杀人魔王之类的问题,那么,你的日志文件里面并不会有太多有价值的“罪证”,多数情况,看日志文件会你感到无聊。

那么,按你这么说,logging不就是在浪费时间吗?我确信很多朋友会读到这里,并且这么认为,不管我写得怎么样。平心而论,我可不是Logging的反对者,我只是反对滥用Logging。和其他工具包一样,如果你使用得当,它们确实可以帮你创建更好的程序。Logging的问题不在于日志本身,而是那个诱人的OCD“日志中多一点,再多一点数据“的陷阱,程序员在执行日志是会陷入其中。不管怎么样,Logging是为了帮助我们理解运行时的问题,如果它又变成了另外一个巨大的困扰,那难道不是一种耻辱嘛!

后来,我们在StackOverflow上完全移除了各类Logging文件,仅仅依靠Exception来记录异常情况。老实说,我一点都不想念那些Logging,哪怕是一小会儿时间,因为一想到它,我就会想到一个绝大的日志文件在等着我来诊断问题。

总归来说,正确的答案肯定不是“越多越好”。坚决抵制用日志来记录一切的倾向。从一些小而简单的事情开始,只记录那些最明显和最关键的错误。只有通过特定的、可验证的需求,才能添加更多日志记录。