一 为什么要记录日志
日志是给人看的,首先要让人能读懂,给出足够的信息——要带有上下文,和写作一样,要具有4W(when、where、who、what),而且都要清晰明确——日志记录的时候(when)、打印日志的位置(where),什么数据或请求(who)导致了什么现象(what)。
通过这些我们知道为什么(why)会记录成这样,以及产生哪些影响(how)。
二 日志级别
日志级别 | 作用 |
TRACE | 打印的日志信息最详细,类似于单步调试,这个级别的日志很详细,在生产环境中不会到此级别,平时也比较少用。 |
DEBUG | 打印调试信息,主要用于开发过程中打印一些运行信息,了解请求包运行的处理路径。 |
INFO | 相比于DEBUG,这个级别同样记录程序运行的过程,但粒度更粗。 |
WARN | WARN级别展示的是一些警告信息,类似于编译程序中的Warning 信息。虽然不是错误,但表明程序具有潜在的风险,需要给程序一些提示,关注是否会让隐患扩大。 |
ERROR | 当出现出现错误的时候,需要打印ERROR日志。打印错误和异常信息需要记录后再处理。 |
FATAL | 这个级别的日志表明程序出现了非常严重的错误事件,严重到已经影响程序的整体运行,需要直接停止程序。 |
三 日志类型
日志类型 | 使用场景 | 特点 |
内存日志 | 保存程序“crash”前的内存现场,复现程序崩溃原因。 | 记录在内存中,速度快,占用内存,可写量不大。 |
远程日志 | 通过 agent 把本地日志发送到远端,降低本地 I/O性能消耗。 | 量大会对网络带宽有影响,可以汇总多台机器的日志。 |
染色日志 | 对部分信息要详细记录,跨系统记录的场景。 | 通知运行的程序对哪些类型的日志进行染色,不易配置过多,否则会影响服务性能。 |
流水日志 | 用于恢复写操作,重放。 | 配合切片数据,恢复数据。 |
四 日志记录注意事项
1 控制数量
记录的日志是旁路逻辑,和给用户使用的逻辑是互不影响的。但记录日志会消耗程序性能,抢占程序执行逻辑资源。所以在记录日志时,要控制好日志的量,不要因为记录日志而导致程序处理性能下降。
2 可读性强
有时在日志中会出现一些特殊的奇怪字符,不能见文知意,最好使用有规则格式和有意义的名字。
3 级别合适
一般错误使用日志级别的方式有两种,一种是把 DEBUG 级别设置到生产环境中,还有一种是在代码中没有日志级别的概念,都使用一种级别(DEBUG或ERROR)。要么所有的日志在生产环境都打印不出来,要么一下子全打印出来。
4 信息安全
有时日志中会记录很多敏感信息,这样会导致信息泄露。所以在记录日志时药注意信息安全,防止泄露系统的信息。
五 小结
我们记录日志时,要时刻谨记日志时给人看的,要注意可读性。
记录日志时要注意不影响程序性能,要按需记录,也要注意信息安全。