問題描述

在使用 gin-swagger 的過程中， 經(jīng)常會發(fā)生因為缺少 json 等 tag 而導(dǎo)致的異常。 由于 gin-swagger 是并發(fā)執(zhí)行的， 輸出的日志本身是錯位的。 這就導(dǎo)致無法定義是哪一個結(jié)構(gòu)體缺少 tag 導(dǎo)致的。

一般而言， 這種時候只能一個個點開去檢查。

解決方案

思路 ： 要是每行日志帶當前 goroutine_id 的話， 是不是就可以準確定位到報錯的 goroutine 他打印的日志是哪些了呢！

說做就做

實現(xiàn)思路

• 查看當前日志是怎么打印的

發(fā)現(xiàn) gin-swagger 日志直接調(diào)用的 golang 的標準庫 log

由于沒有對log初始化， 所以默認使用的是 stdout 。

log.Printf("Picking operation from %s\n", aurora.Blue(funType.FullName()))

• 如果想要給日志中添加 goroutine_id 的話， 就需要在調(diào)用 log.Printf 的時候獲取當前 goroutine 的 id , 所以首先要解決的是怎么獲取 goroutine_id 的問題。

調(diào)研后發(fā)現(xiàn)了集中常見的獲取 goroutine_id 的方法：

2.1 通過棧信息解析后獲取

func GetGID() uint64 {
    b := make([]byte, 64)
    b = b[:runtime.Stack(b, false)]
    b = bytes.TrimPrefix(b, []byte("goroutine "))
    b = b[:bytes.IndexByte(b, ' ')]
    n, _ := strconv.ParseUint(string(b), 10, 64)
    return n
}

2.2 修改 Go 源碼獲取

# src/runtime/runtime2.go
func Goid() int64 {
    _g_ := getg()
    return _g_.goid
}

2.3 通過 CGO 獲取

文件 id.c

#include "runtime.h"
int64 ·Id(void) {
    return g->goid;
}

文件 id.go

package id
func Id() int64

另外還可以通過匯編獲取 goroutine_id

由于go的版本不同，goroutine的結(jié)構(gòu)也可能不同， 所以此處我直接調(diào)用一個開源實現(xiàn)：

https://github.com/petermattis/goid

• 修改 gin-swagger main.go 源碼， 修改 log Write 的實現(xiàn)

修改前

func main() {
    cmd.Execute()
}

修改后

type Out os.File
func (o Out) Write(b []byte) (int, error) {
    prefix := fmt.Sprintf("gid-%d: ", goid.Get())
    all := make([]byte, len(b)+len(prefix))
    all = []byte(prefix)
    all = append(all, b...)
    f := os.File(o)
    return f.Write(all)
}
func main() {
    var out Out
    out = Out(os.Stdout)
    log.SetOutput(out)
    cmd.Execute()

這樣修改后，每次 gin-swagger 調(diào)用 log 打印日志都時候， 都會使用我定義的 Write 方法， Write 方法中每次打印前都會先查詢出當前的 goroutine_id ，然后作為日志的前綴。

修改后的日志效果

從中可以看到每行日志開頭，都已經(jīng)加上了 goroutine_id。 只要使用 panic goroutine 的 id 做一次 grep ， 即可篩選出需要的日志了，極大的方便了定位問題。

cat /tmp/gin-swagger.log | grep 7647