tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
应用性能监控
    文档
    Download PDF

    通过 gin Jaeger 中间件上报

    最后更新时间：2024-04-02 10:09:04
    下载PDF
      本文将为您介绍如何使用 gin Jaeger 中间件上报 Go 应用数据。

      操作步骤

      步骤1：获取接入点和 Token

      登录 应用性能监控控制台，进入应用监控 > 应用列表，单击接入应用页面，在接入应用时选择 GO 语言与 gin Jaeger 中间组件的数据采集方式。 在选择接入方式步骤获取您的接入点和 Token，如下图所示：
      
      

      步骤2：安装 Jaeger Agent

      1. 下载 Jaeger Agent。
      2. 执行下列命令启动 Agent。
      nohup ./jaeger-agent --reporter.grpc.host-port={{collectorRPCHostPort}} --agent.tags=token={{token}}

      步骤3：选择上报端类型上报应用数据

      选择上报端类型，通过 gin Jaeger 中间件上报 Go 应用数据：

      服务端

      1. 在服务端侧引入 opentracing-contrib/go-gin 依赖。
      依赖路径： github.com/opentracing-contrib/go-gin
      版本要求： ≥ v0.0.0-20201220185307-1dd2273433a4
      2. 配置 Jaeger，创建 Trace 对象。示例如下：
      cfg := &jaegerConfig.Configuration{
          ServiceName: ginServerName, //对其发起请求的的调用链，叫什么服务
          Sampler: &jaegerConfig.SamplerConfig{ //采样策略的配置，详情见4.1.1
          Type:  "const",
          Param: 1,
          },
          Reporter: &jaegerConfig.ReporterConfig{ //配置客户端如何上报trace信息，所有字段都是可选的
           LogSpans:          true,
           LocalAgentHostPort: endPoint,
          },
          //Token配置
          Tags:        []opentracing.Tag{ //设置tag，token等信息可存于此
          opentracing.Tag{Key: "token", Value: token}, //设置token
          },
      }
      
      tracer, closer, err := cfg.NewTracer(jaegerConfig.Logger(jaeger.StdLogger)) //根据配置得到tracer
      3. 配置中间件
      r := gin.Default()
      //传入tracer
      r.Use(ginhttp.Middleware(tracer))
      说明：
      官方默认 OperationName 是 HTTP + HttpMethod，建议使用 HTTP + HttpMethod + URL 可以分析到具体接口，接口主要 URL 应是参数名，不是具体参数值。 具体用法如下： 正确：/user/{id}， 错误：/user/1
      r.Use(ginhttp.Middleware(tracer, ginhttp.OperationNameFunc(func(r *http.Request) string {
              return fmt.Sprintf("testtestheling  HTTP %s %s", r.Method, r.URL.String())
          })))
      完整代码如下：
      // Copyright © 2019-2020 Tencent Co., Ltd.
      
      // This file is part of tencent project.
      // Do not copy, cite, or distribute without the express
      // permission from Cloud Monitor group.
      
      package gindemo
      
      import (
          "fmt"
          "github.com/gin-gonic/gin"
          "github.com/opentracing-contrib/go-gin/ginhttp"
          "github.com/opentracing/opentracing-go"
          "github.com/uber/jaeger-client-go"
          jaegerConfig "github.com/uber/jaeger-client-go/config"
          "net/http"
      )
      
      // 服务名 服务唯一标示，服务指标聚合过滤依据。
      const ginServerName = "demo-gin-server"
      
      // StartServer
      func StartServer() {
          //初始化jaeger，得到tracer
          cfg := &jaegerConfig.Configuration{
              ServiceName: ginServerName, //对其发起请求的的调用链，叫什么服务
              Sampler: &jaegerConfig.SamplerConfig{ //采样策略的配置，详情见4.1.1
                  Type:  "const",
                  Param: 1,
              },
              Reporter: &jaegerConfig.ReporterConfig{ //配置客户端如何上报trace信息，所有字段都是可选的
                  LogSpans:          true,
                  LocalAgentHostPort: endPoint,
              },
              //Token配置
              Tags: []opentracing.Tag{ //设置tag，token等信息可存于此
                  opentracing.Tag{Key: "token", Value: token}, //设置token
              },
          }
      
          tracer, closer, err := cfg.NewTracer(jaegerConfig.Logger(jaeger.StdLogger)) //根据配置得到tracer
          if err != nil {
              panic(fmt.Sprintf("ERROR: fail init Jaeger: %v\\n", err))
          }
          defer closer.Close()
          r := gin.Default()
          //这里说明一下，官方默认 OperationName 是 HTTP + HttpMethod,
          //建议使用 HTTP + HttpMethod + URL 可以分析到具体接口，具体用法如下
          //PS：Restful 接口主要URL应该是参数名，不是具体参数值。 如： 正确：/user/{id}， 错误：/user/1
          r.Use(ginhttp.Middleware(tracer, ginhttp.OperationNameFunc(func(r *http.Request) string {
              return fmt.Sprintf("HTTP %s %s", r.Method, r.URL.String())
          })))
          r.GET("/ping", func(c *gin.Context) {
              c.JSON(200, gin.H{
                  "message": "pong",
              })
          })
          r.Run() // 监听 0.0.0.0:8080
      }

      客户端

      1. 客户端侧由于需要模拟 HTTP 请求，引入 opentracing-contrib/go-stdlib/nethttp 依赖。
      依赖路径：github.com/opentracing-contrib/go-stdlib/nethttp
      版本要求： ≥ v1.0.0
      2. 配置 Jaeger，创建 Trace 对象。示例如下：
      cfg := &jaegerConfig.Configuration{
          ServiceName: ginClientName, //对其发起请求的的调用链，叫什么服务
          Sampler: &jaegerConfig.SamplerConfig{ //采样策略的配置，详情见4.1.1
          Type:  "const",
          Param: 1,
          },
          Reporter: &jaegerConfig.ReporterConfig{ //配置客户端如何上报trace信息，所有字段都是可选的
          LogSpans:          true,
          LocalAgentHostPort: endPoint,
          },
          //Token配置
          Tags:        []opentracing.Tag{ //设置tag，token等信息可存于此
          opentracing.Tag{Key: "token", Value: token}, //设置token
          },
      }
      
      tracer, closer, err := cfg.NewTracer(jaegerConfig.Logger(jaeger.StdLogger)) //根据配置得到tracer
      3. 构建 span 并把 span 放入 conext 中，示例如下：
      span := tracer.StartSpan("CallDemoServer") //构建span
      ctx := opentracing.ContextWithSpan(context.Background(), span) //将span的引用放入conext中
      4. 构建带 tracer 的 Request 请求，示例如下：
      //构建http的请求
      req, err := http.NewRequest(
              http.MethodGet,
              fmt.Sprintf("http://localhost%s/ping", ginPort),
              nil,
          )
      req = req.WithContext(ctx)
      //构建带tracer的请求
      req, ht := nethttp.TraceRequest(tracer, req)
      5. 发起 HTTP 请求，并获得返回结果。
      httpClient := &http.Client{Transport: &nethttp.Transport{}} //初始化http客户端
      res, err := httpClient.Do(req)
      //..省略err判断
      body, err := ioutil.ReadAll(res.Body)
      //..省略err判断
      log.Printf(" %s recevice: %s\\n", clientServerName, string(body))
      完整代码如下：
      // Copyright © 2019-2020 Tencent Co., Ltd.
      
      // This file is part of tencent project.
      // Do not copy, cite, or distribute without the express
      // permission from Cloud Monitor group.
      
      package gindemo
      
      import (
          "context"
          "fmt"
          "github.com/opentracing-contrib/go-stdlib/nethttp"
          "github.com/opentracing/opentracing-go"
          "github.com/opentracing/opentracing-go/ext"
          opentracingLog "github.com/opentracing/opentracing-go/log"
          "github.com/uber/jaeger-client-go"
          jaegerConfig "github.com/uber/jaeger-client-go/config"
          "io/ioutil"
          "log"
          "net/http"
      )
      
      const (
          // 服务名 服务唯一标示，服务指标聚合过滤依据。
          ginClientName = "demo-gin-client"
          ginPort       = ":8080"
          endPoint      = "xxxxx:6831" // 本地agent地址
          token         = "abc"
      )
      
      // StartClient gin client 也是标准的 http client.
      func StartClient() {
          cfg := &jaegerConfig.Configuration{
              ServiceName: ginClientName, //对其发起请求的的调用链，叫什么服务
              Sampler: &jaegerConfig.SamplerConfig{ //采样策略的配置，详情见4.1.1
                  Type:  "const",
                  Param: 1,
              },
              Reporter: &jaegerConfig.ReporterConfig{ //配置客户端如何上报trace信息，所有字段都是可选的
                  LogSpans:           true,
                  LocalAgentHostPort: endPoint,
              },
              //Token配置
              Tags: []opentracing.Tag{ //设置tag，token等信息可存于此
                  opentracing.Tag{Key: "token", Value: token}, //设置token
              },
          }
      
          tracer, closer, err := cfg.NewTracer(jaegerConfig.Logger(jaeger.StdLogger)) //根据配置得到tracer
          defer closer.Close()
          if err != nil {
              panic(fmt.Sprintf("ERROR: fail init Jaeger: %v\\n", err))
          }
          //构建span，并将span放入context中
          span := tracer.StartSpan("CallDemoServer")
          ctx := opentracing.ContextWithSpan(context.Background(), span)
          defer span.Finish()
      
          // 构建http请求
          req, err := http.NewRequest(
              http.MethodGet,
              fmt.Sprintf("http://localhost%s/ping", ginPort),
              nil,
          )
          if err != nil {
              HandlerError(span, err)
              return
          }
          // 构建带tracer的请求
          req = req.WithContext(ctx)
          req, ht := nethttp.TraceRequest(tracer, req)
          defer ht.Finish()
      
          // 初始化http客户端
          httpClient := &http.Client{Transport: &nethttp.Transport{}}
          // 发起请求
          res, err := httpClient.Do(req)
          if err != nil {
              HandlerError(span, err)
              return
          }
          defer res.Body.Close()
          body, err := ioutil.ReadAll(res.Body)
          if err != nil {
              HandlerError(span, err)
              return
          }
          log.Printf(" %s recevice: %s\\n", ginClientName, string(body))
      }
      
      // HandlerError handle error to span.
      func HandlerError(span opentracing.Span, err error) {
          span.SetTag(string(ext.Error), true)
          span.LogKV(opentracingLog.Error(err))
      }
      
      
      联系我们

      联系我们，为您的业务提供专属服务。

      联系我们
      技术支持

      如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

      提交工单
      7x24 电话支持
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      隐私条款服务条款缓存条款