OpenTelemetry：轻松在 Gin 框架中实现链路追踪

运维开发王义杰

发布于 2023-08-10 14:58:22

2.2K00

代码可运行

文章被收录于专栏：运维开发王义杰运维开发王义杰

运行总次数：0

代码可运行

亲爱的读者，你好！今天，我们将继续探索在 Go 项目中使用 OpenTelemetry 的主题，特别是如何在使用 Gin 框架的项目中自动实现链路追踪。

Gin 是一个用 Go 编写的 HTTP web 框架，其设计旨在快速构建模块化的 web 应用。OpenTelemetry 提供了一个专门的 Gin 中间件，使得我们可以轻松地在 Gin 应用中进行链路追踪。

一、如何使用 Gin 中间件？

在你的 Gin 路由中添加 OpenTelemetry 中间件非常简单。以下是一个示例：

package main

import (
  "github.com/gin-gonic/gin"
  "go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin"
)

func main() {
  r := gin.Default()

  // Add the OpenTelemetry middleware after the logger middleware
  r.Use(otelgin.Middleware("my-server"))

  r.GET("/example", func(c *gin.Context) {
    // Your handler code here...
  })

  r.Run(":8080")
}

在这段代码中，otelgin.Middleware("my-server") 中间件会自动为每个请求创建一个新的 Span，并将 Span 的 Context 注入到 Gin Context 中。这样你就可以在你的处理器中获取到这个 Span 或其 Context，如果需要的话。

二、如何安装？

为了在项目中使用 OpenTelemetry 的 Gin 中间件，你需要将其添加到你的 Go 项目中。使用以下命令即可：

go get go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin

三、如何处理客户端请求？

对于客户端请求，你可以使用 otelhttp 包提供的 http.Client 封装。这样，你就可以在发送请求时自动创建新的 Span，并将 Span 的 Context 注入到 HTTP 请求的 headers 中。

package main

import (
  "net/http"

  "go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"
)

func main() {
  client := http.Client{Transport: otelhttp.NewTransport(http.DefaultTransport)}

  // This request will be traced
  resp, err := client.Get("http://example.com")
  // handle resp and err...
}