微服務追蹤SQL(支持Isto管控下的gorm查詢追蹤)

• 2022 年 7 月 1 日
• 筆記
• gorm, istio, Jaeger, k8s, Tracing

效果圖

SQL的追蹤正確插入到微服務的調用鏈之間

詳細記錄了SQL的執行內容和消耗時間

搜索SQL的類型

多線程(goroutine)下的追蹤效果

在 Kubernetes 中部署微服務後，通過 Istio 管控微服務之間的流量，Istio 默認會將微服務之間的調用關係生成追蹤，放入追蹤收集器。但他不支持更細化的SQL操作，比如執行了哪些SQL，每條SQL消耗多長時間。為此，我寫了一個簡單的支持gorm查詢並生成追蹤的插件：istio-gorm-tracing

微服務追蹤 gorm 插件

在kubernetes上使用Istio管控微服務後，微服務之間的調用會自動上傳到Jaeger的收集器。但只能追蹤到服務層，這是我不能接受的，我希望能進一步追蹤到服務中的所有MySQL查詢，記錄每個 sql 的耗時，所以，我簡單寫了這個插件。

特性

支持Istio

在Istio管控下的容器請求之間，會自動攜帶x-b3-traceid、x-b3-parentspanid、x-b3-spanid、x-b3-sampled等請求頭，這些請求頭都是與zipkin對齊的。此插件中會根據傳遞進來的請求頭信息，自動解析出父span，並綁定上下服務之間的調用關係。

記錄SQL信息

每次查詢都會記錄下執行的SQL語句以及執行耗時等信息，作為後期微服務追蹤的依據。

使用

package main

import (
    istiogormtracing "github.com/liamhao/istio-gorm-tracing"
    "log"
    "fmt"
    "github.com/gin-gonic/gin"
    "gorm.io/driver/mysql"
    "gorm.io/gorm"
)

func main() {

    router := gin.Default()

    dsn := fmt.Sprintf("%s:%s@tcp(%s:%d)/%s?charset=utf8mb4&parseTime=True&loc=Local", "dbuser", "dbpswd", "dbhost", 3306, "dbname")
    gormDb, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})
    if err != nil {
        log.Println("mysql連接出現了問題：", err.Error())
    } else {
        log.Println("mysql連接成功：", dsn)
    }

    // 這一步很關鍵，一定要加上，為了啟用我們的插件
    gormDb.Use(istiogormtracing.NewDefault(
        // 你的微服務名稱
        "istiogormtracing-service",
        // 你的 Jaeger 收集器地址
        "//127.0.0.1:14268/api/traces",
    ))

    router.GET("/", func(c *gin.Context) {

        // 這一步很關鍵，一定要加上，為了SQL能與上下游服務做關聯
        istiogormtracing.H = c.Request.Header

        list := []map[string]interface{}{}
        gormDb.Table("users").Where("name = 'xiaoming'").Find(&list)

        c.JSON(http.StatusOK, map[string]interface{}{
            "istiogormtracing": "ok",
        })
    })

    router.Run(":7000")
}

然後即可在Jaeger面板中看到我們記錄的SQL了。