关于日志的那些事儿

在学校的时候其实没怎么了解和好好使用过日志，我想不少人可能跟我都差不多。那会儿写代码，说实在的，日志？那会儿的认知一般也就是所谓的 console.log(),print() 等等，多数时候都是在代码中通过 console.log(),print() 将日志输出到控制台输出到控制台，这其实挺 low 的，对于初学者还好，但入门一段时间后就该好好学学怎么使用日志了。

在学校那会儿，跟着视频啥的做项目的时候，一般都会加入 log4j 之类的 jar 包，也只是知道这个 jar 包加进去是为了使用日志，其实对日志完全没有啥了解和认识。写这篇文章是源于耗子叔在左耳听风专栏的群里发布了命题作文「关于日志的那些事儿」，正好可以去查阅资料，学习了解一下日志方面的知识。

什么是日志

首先，什么是日志呢？可能不少人的意识里，日志无非就是将程序运行的一些信息输出到控制台或者是写到一个文件里面。对于这个答案，虽然部分正确，但是太过于简单了。日志有很多不同的定义，这里有两个定义我觉得是比较好的，如下：

A log is simply a writing of what is being done in details by a
computer program.

日志是通过计算机程序对代码正在进行的操作的一种详细描述。

Logging is the process of recording application actions and state to a secondary interface.

日志记录是将应用程序操作和状态记录到辅助接口的过程。

这个定义鼓励我们更多地去思考如何在我们的应用程序中记录日志信息。那么，一个日志中一般会包含哪些信息呢？也就是说，从一个日志中我们能读出什么信息呢？

• 从一个连接（connection）中接收的数据
• 通过数据调用的函数信息
• 从一个请求（request）中接收的数据
• 一个操作（action）执行成功或者失败的信息
• 用户的输入信息，比如单击 x，y 坐标等

由此可见，一个日志无非是关于 数据（data）、操作（event）和时间（time）的记录。

日志的使用场景

诊断日志

应用程序打印异常信息，排查问题用，一般是给人看的，输出格式会比较随意，里面可能会有异常堆栈，或者排查问题用的一些文本信息；

数据日志

一般是用来做监控和数据分析的，可以人肉临时分析，也可以给机器分析，要求格式比较固定；

交易日志

一般在日志式文件系统、NoSQL、DB 中使用，一般有 journaling，WAL（write-ahead logging），binlog。这种日志通常都不是给人看的。

日志的等级

一般来说，典型的分类系统将日志级别与发送到日志的每个项目相关联，根据应用程序中发生问题的严重程度一般可以分为三种类型，用于记录一般信息的 INFO，用于调试程序的 DEBUG ，还有就是记录一些比较严重的错误信息、警告信息的 WARN, ERROR, FATAL。

INFO

记录信息性的消息日志，不应用于记录程序中的故障或者错误的状态信息。比如可以记录：

• 与软件相关的版本信息
• 软件的使用信息——谁在使用？目前正在做什么？
• 应用程序使用了那些外部服务——数据库，Web 服务等等

WARN

通常用来指明应用程序可能面临的但不影响用户体验的潜在问题的一类日志。

ERROR

通常用来指明应用程序面临的比较严重并且在某种程度上影响了用户体验的一类日志，比如数据库连接可能失败，导致部分应用程序无法使用的问题。

FATAL

通常用来记录应用程序致命的错误信息的，这类错误不但严重影响用户体验，甚至直接导致应用停止运行。

DEBUG

通常用作调试阶段打印的日志，一般是对于开发人员而言。

日志的好处

使用日志可能有时候会是代码显得很冗余，但很多时候使用日志可以比单元测试更快、更有效地开发代码，更好地传达代码所做的事情。

1. 对代码的可见性有助于管理代码的复杂性，可以一目了然地了解代码所做的事情
2. 代码发布后的可见性，代码发布后，通过日志记录，如果有 API 接口，我们可以查看正在触发问题的点以及何时触发等信息状态
3. 代码开发时的可见性，与代码发布后的可见性一样有用，通过记录函数的调用和返回结果，可以很好地进行堆栈跟踪。
4. 日志记录允许其他开发人员查看代码正在执行的操作，从而更加有利于开发人员之间的交流

日志的性能问题

一般来说，在写日志方面，有以下几个目标：

• 写日志性能要足够好，应避免影响应用主流程；
• 写日志对系统影响尽量小，在系统压力很大的时候，甚至可以选择放弃输出日志。

---

本文参考

1. In programming, what is a log?
2. 写日志的那些事儿
3. How Logging Made me a Better Developer
4. Java日志性能那些事