在追踪应用的链路数据之前,您需要通过客户端将应用数据上报至链路追踪服务端。本文介绍如何通过Jaeger客户端上报Go应用数据,包括使用Jaeger SDK上报和使用Jaeger Agent上报两种方式,并在文末提供示例。

前提条件

  1. 登录链路追踪控制台,在左侧导航栏,单击集群配置
  2. 集群配置页面顶部选择地域,然后单击接入点信息页签,在集群信息区域打开显示Token开关。
  3. 客户端采集工具区域单击需要使用的链路数据采集客户端。
  4. 在下方表格的相关信息列中,单击接入点信息末尾的复制图标。

Tracing Analysis Endpoint Section

说明:如果应用部署于阿里云生产环境,则选择私网接入点,否则选择公网接入点。

背景信息

不通过Jaeger Agent而直接上报数据的原理如下图所示。

Report Tracing Data Directly

通过Jaeger Agent上报数据的原理如下图所示。

Report Tracing Data By Jaeger Agent

方式一:通过Jaeger SDK上报数据

此处以依赖管理工具Go Modules为例,您可以通过Jaeger SDK埋点直接将数据上报到链路追踪服务端。若使用其他依赖管理工具,请按实际情况操作。

  1. 引入jaeger-client-go
    go get github.com/uber/jaeger-client-go
  2. 创建Tracer对象。
    说明 请将<endpoint>替换成链路追踪控制台概览页面上相应客户端和相应地域的接入点。关于获取接入点信息的方法,请参见本文前提条件。
    func NewJaegerTracer(service string) (opentracing.Tracer, io.Closer) {
    
        sender := transport.NewHTTPTransport(
           // 设置网关,网关因地域而异。
            "<endpoint>",
        )
       tracer, closer:= jaeger.NewTracer(service,
               jaeger.NewConstSampler(true),
               jaeger.NewRemoteReporter(sender))
       return tracer, closer
    }
  3. 创建span实例对象和数据透传。
    • 如果没有parentSpan:

      // 创建Span。
      span := tracer.StartSpan("myspan")
      // 设置Tag。
      clientSpan.SetTag("mytag", "123")
      // 透传traceId。
      tracer.Inject(span.Context(), opentracing.HTTPHeaders, opentracing.HTTPHeadersCarrier(req.Header))
      ...
      defer  span.Finish()
    • 如果有parentSpan:

      // 从HTTP/RPC对象解析出spanCtx。
      spanCtx, _ := tracer.Extract(opentracing.HTTPHeaders, opentracing.HTTPHeadersCarrier(r.Header))
      span := tracer.StartSpan("myspan", opentracing.ChildOf(spanCtx))
      ...
      defer  span.Finish()

    更多详细使用方法,请参见Go Doc

方式二:通过Jaeger Agent上报数据

  1. 启动Jaeger Agent。具体操作,请参见安装Jaeger Agent
  2. 引入jaeger-client-go
    go get github.com/uber/jaeger-client-go
  3. 创建Tracer对象。
    func NewJaegerTracer(serviceName string) (opentracing.Tracer, io.Closer) {
       sender, _ := jaeger.NewUDPTransport("",0)
       tracer, closer:= jaeger.NewTracer(serviceName,
            jaeger.NewConstSampler(true),
            jaeger.NewRemoteReporter(sender))
        return tracer, closer
    }
  4. 创建span实例对象和数据透传。
    • 如果没有parentSpan:

      // 创建Span。
      span := tracer.StartSpan("myspan")
      // 设置Tag。
      clientSpan.SetTag("mytag", "123")
      // 透传traceId。
      tracer.Inject(span.Context(), opentracing.HTTPHeaders, opentracing.HTTPHeadersCarrier(req.Header))
      ...
      defer  span.Finish()
    • 如果有parentSpan:

      // 从HTTP/RPC对象解析出spanCtx。
      spanCtx, _ := tracer.Extract(opentracing.HTTPHeaders, opentracing.HTTPHeadersCarrier(r.Header))
      span := tracer.StartSpan("myspan", opentracing.ChildOf(spanCtx))
      ...
      defer  span.Finish()

    更多详细使用方法,请参见Go Doc

使用示例

通过Jaeger SDK直接上报

  1. 获取接入点信息。具体操作方法,请参见本文前提条件。
  2. 运行以下命令,下载示例文件
    wget https://arms-apm-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/demo/tracing-demo.zip && unzip tracing-demo.zip
  3. 打开示例文件夹中的examples/settings.go文件,配置TracingAnalysisEndpoint,将图示①替换为步骤1中获取的接入点信息。
    jaeger_demo
  4. 使用go mod tidy命令整理依赖。
  5. 使用go run tracingdemo命令运行示例。

通过Jaeger Agent上报

  1. 获取接入点信息。具体操作方法,请参见本文前提条件。
  2. 运行以下命令,下载示例文件
    wget https://arms-apm-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/demo/tracing-demo.zip && unzip tracing-demo.zip
  3. 启动Jaeger Agent。具体操作,请参见安装Jaeger Agent
  4. 打开示例文件夹中的examples/settings.go文件,将AgentSwitch修改为true
    jaeger_demo
  5. 使用go mod tidy命令整理依赖。
  6. 使用go run tracingdemo命令运行示例。

常见问题

Q:在运行过程中,为什么会出现以下报错?
2021/06/28 21:11:54 ERROR: error when flushing the buffer: error from collector: 403
2021/06/28 21:11:54 ERROR: error when flushing the buffer: error from collector: 403

A:出现上述报错,说明输入的接入点信息不正确。请更正并重试。

更多信息

不是您要找的文档?鼠标悬浮在这里试一试。