请教下日志打印的最佳实践

V2EX = way to explore

V2EX 是一个关于分享和探索的地方

现在注册

已注册用户请登录

这是一个创建于 2378 天前的主题，其中的信息可能已经有所发展或是发生改变。

无论是线上还是开发环境，log 打印对排查 bug 都很有帮助，但是这就遇到个问题，如果要打印详细的 log 就会侵入到方法的实现，特别是如果调用链很常的时候，比如

controller -> validator -> serviceA -> serviceB -> model

这时如果要打印出详细的日志就必须在 controller、service、model .... 中都要加上打印语句，这样显得很麻烦，有没有更好的实现方式？虽然可以用类似 AOP 的方法，但是如果要精细一些还是要在方法实现中主动调用。

打印

log

controller

model

15 条回复 • 2018-12-11 03:56:17 +08:00

kslr

2018-05-24 04:50:52 +08:00 via Android

发出事件监听呢

billwsy

2018-05-24 05:43:09 +08:00 via iPhone

glog https://github.com/google/glog 可以在某些时候打印 stack trace

gaoyulong

2018-05-24 07:19:41 +08:00

mark

ppyybb

2018-05-24 08:43:37 +08:00 via iPhone

我在 rails 里面的简易做法是：
抛出异常
打出到 controller 层为止的 stack trace
打出需要的当前环境的状态
严重的发短信报警

另外，你 log 的目的是针对可能出现的异常情况做记录，方便出问题的时候查找。
还是已经发现比较奇怪的现象，但是找不到原因，准备打 log 排查？如果是后者，log 只是临时的，处理好有问题的调用链上的 log，专门写一个 logger 类来打出一整条链上的状态，事后清理即可

ksupertu

2018-05-24 09:18:36 +08:00

sentry 了解一下

jorneyr

2018-05-24 09:54:19 +08:00

很多日志都是根据业务逻辑进行打印，就必须侵入到不同层的代码里。AOP 只能打印一些通用的日志，例如访问方法的顺序，参数，执行的时间等。

hilow

2018-05-24 09:56:37 +08:00 via Android

在每个函数中返回自定义的 *exerror.Error 类型变量。
此 err 变量中包含错误的上下文信息，如 userId, zerror 和 [email protected]:108 这样的 zcallstack
在调用函数时，如果返回非 nil 的 err，就能打印日志，日志中包含所有上下文信息。
实际业务中在不同代码中调用相同函数，可能出现同样错误，都返回了 err，这时能根据要求灵活决定是否打印出日志。
日志打印格式推荐“结构化日志信息”，比如`level=info msg="Recv RestRequest"` ，主要优点是，方便使用 grep awk 等工具过滤日志，详情参考[logrus]( https://github.com/sirupsen/logrus)
另外每行日志中增加一个`ReqId`，此 ID 全局唯一，用于关联同一会议的 ID

```log
cat log/server.log | grep ExtHwyApi_QLlUyYd9To
time="2018-05-24T09:42:02+08:00" level=info msg="Recv RestRequest" ReqHeader=map[Date:[2018-03-29T09:32:35+08:00] Accept:[application/json]] ReqId="ExtHwyApi_QLlUyYd9To" Url="/ext/api/product"
time="2018-05-24T09:42:02+08:00" level=warning msg="AuthTimeOut Disable" AuthTimeOutSeconds=0 ReqId="ExtHwyApi_QLlUyYd9To"
time="2018-05-24T09:42:03+08:00" level=error msg="RestDispatch Fail" ReqBody="{"seq":"ExtHwyApi_QLlUyYd9To","var":1}}" ReqId="ExtHwyApi_QLlUyYd9To" ResBody="{"Code":"812018","Msg":"发送失败"}" Tag="out_ccm" zcallstack="[email protected]:43 Handler@ext_hwy_api.go:44" zerror="dial tcp 127.0.0.1:5010: connectex: No connection could be made because the target machine actively refused it."
```