logging - 日志信息最佳实践

Question

我正在做生产支持，很大程度上依赖日志来解决问题。我发现日志信息现在相当困惑。

您能否提供编写日志信息的最佳实践或指南？

顺便说一句:我们正在使用 log4Net。你对替代图书馆有什么建议吗？

谢谢。

Answer 1

理想情况下，您的日志消息应包含有关何时、什么、何地、谁的详细信息，以及触发该消息的事件的严重程度的一些指示。

包括日期和时间。如果您的应用程序跨时区分布，则还包括时区指示器。如果每个人都确切地知道 03:11:04 在他们的时区中的时间，它将消除困惑。

包括日志记录严重性级别。

在日志消息中包含一些触发日志消息的模块或类的指示。

如果可能，鼓励开发人员在消息中包含特定信息:例如，“文件损坏”比“文件损坏:“C:\foo\bar.dat””有用得多

如果可能，让开发人员在错误消息中包含某种 session 或事务 ID。能够过滤日志以查找来自有错误的事务的消息并忽略所有正常的事务是很方便的。

在错误日志消息中包含错误代码通常是一个好主意。

我会支持@Oded 的建议，以保持消息整洁。对于常规内容、日期和时间、日志级别、错误代码，我会尝试将它们格式化为固定宽度，并将它们放在开头。它使扫描日志变得更加容易。

关于日志消息格式的良好指南，我唯一遇到的是“释放它!”一书的第 17 章: http://www.pragprog.com/titles/mnee/release-it上面的很多建议都是基于此。