玩转 Go 链路追踪

原创
2022/12/07 09:46
阅读数 5.8K

前言

链路追踪是每个微服务架构下必备的利器,go-zero 当然早已经为我们考虑好了,只需要在配置中添加配置即可使用。

关于 go-zero 如何追踪的原理追溯,之前已经有同学分享,这里我就不再多说,如果有想了解的同学去 https://mp.weixin.qq.com/s/hJEWcWc3PnGfWfbPCHfM9g 这个链接看就好了。默认会在 api 的中间件与 rpc 的 interceptor 添加追踪,如果有不了解 go-zero 默认如何使用默认的链路追踪的,请移步我的开源项目 go-zero-looklook 文档 https://github.com/Mikaelemmmm/go-zero-looklook/blob/main/doc/chinese/12-%E9%93%BE%E8%B7%AF%E8%BF%BD%E8%B8%AA.md

今天我想讲的是,除了 go-zero 默认在 api 的 middleware 与 rpc 的 interceptor 中帮我们集成好的链路追踪,我们想自己在某些本地方法添加链路追踪代码或者我们想在 api 发送一个消息给 mq 服务时候想把整个链路包含 mq 的 producer、consumer 穿起来,在 go-zero 中该如何做。

场景

我们先简单讲一下我们的小 demo 的场景,一个请求进来调用 api 的 Login 方法,在 Login 方法中先调用 rpc 的 GetUserByMobile 方法,之后在调用 api 本地的 local 方法,紧接着调用 rabbitmq 传递消息到 mq 服务。

go-zero 默认集成了 jaeger、zinpink,这里我们就以 jaeger 为例

我们希望看到的链路是

api.Login -> rpc.GetUserByMobile

也就是 api 衍生出来三条子链路,api.producerMq 有一条调用 mq.Consumer 的子链路。

我们想要将一个方法添加到链路中需要两个因素,一个 traceId,一个span,当我们在同一个 traceId 下开启 span 把相关的 span 都串联起来,如果想形成父子关系,就要把 span 之间相互串联起来,因为「微服务实践」公众号中讲解原理太多,我这里就简单提一下不涉及过多,如果不是特别熟悉原理可以看文章开头推荐的文章,这里我们只需要知道 traceIdspanId 关系就好。

核心业务代码

1、首先 API 中 LoginLogic 代码

type LoginLogic struct {
  logx.Logger
  ctx    context.Context
  svcCtx *svc.ServiceContext
}

func NewLoginLogic(ctx context.Context, svcCtx *svc.ServiceContext) *LoginLogic {
  return &LoginLogic{
    Logger: logx.WithContext(ctx),
    ctx:    ctx,
    svcCtx: svcCtx,
  }
}

type MsgBody struct {
  Carrier *propagation.HeaderCarrier
  Msg     string
}

func (l *LoginLogic) Login(req *types.RegisterReq) (*types.AccessTokenResp, error) {
  resp, err := l.svcCtx.UserRpc.GetUserByMobile(l.ctx, &usercenter.GetUserByMobileReq{
    Mobile: req.Mobile,
  })
  if err != nil {
    return &types.AccessTokenResp{}, nil
  }

  l.local()

  tracer := otel.GetTracerProvider().Tracer(trace.TraceName)
  spanCtx, span := tracer.Start(l.ctx, "send_msg_mq",  oteltrace.WithSpanKind(oteltrace.SpanKindProducer))
  carrier := &propagation.HeaderCarrier{}
  otel.GetTextMapPropagator().Inject(spanCtx, carrier)

  producer := rabbit.NewRabbitmqPublisher(RabbitmqDNS)
  msg :=  &MsgBody{
    Carrier: carrier,
    Msg:     req.Mobile,
  }
  b, err := json.Marshal(msg)
  if err != nil{
    panic(err)
  }

  if err := producer.Publish(spanCtx, ExchangeName, RoutineKeys, b); err != nil {
    logx.Errorf("Publish Fail , msg :%s , err:%v", msg, err)
  }
  span.End()

  return &types.AccessTokenResp{
    AccessExpire: resp.User.Id,
  }, err
}

func (l *LoginLogic) local() {
  tracer := otel.GetTracerProvider().Tracer(trace.TraceName)
  _ , span := tracer.Start(l.ctx, "local", oteltrace.WithSpanKind(oteltrace.SpanKindInternal))
  defer span.End()
  
  // 执行你的代码 .....
}

2、rpc 中 GetUserByMobile 的代码

func (s *Logic) GetUserByMobile(context.Context, *usercenterPb.GetUserByMobileReq) (*usercenterPb.GetUserByMobileResp, error) {
  vo := &usercenterPb.UserVo{
    Id: 1,
  }
  return &usercenterPb.GetUserByMobileResp{
    User: vo,
  }, nil
}

3、mq 中 Consumer 的代码

type MsgBody struct {
  Carrier *propagation.HeaderCarrier
  Msg     string
}

func (c *consumer) Consumer(ctx context.Context, data []byte) error {
  var msg MsgBody
  if err := json.Unmarshal(data, &msg); err != nil {
    logx.Errorf(" consumer err : %v", err)
  } else {
    logx.Infof("consumerOne Consumer  , msg:%+v", msg)

    wireContext := otel.GetTextMapPropagator().Extract(ctx, msg.Carrier)
    tracer := otel.GetTracerProvider().Tracer(trace.TraceName)
    _, span := tracer.Start(wireContext, "mq_consumer_msg", oteltrace.WithSpanKind(oteltrace.SpanKindConsumer))

    defer span.End()
  }

  return nil
}

代码详解

1、go-zero 默认集成

当一个请求进入 api 后,我们可以在 go-zero 源码中查看到 https://github.com/zeromicro/go-zero/blob/master/rest/engine.go#L92。go-zero 已经在 api 的 middleware 中帮我们添加了第一层 trace,当进入 Login 方法内,我们调用了 rpc 的 GetUserByMobile 方法,通过 go-zero 的源码 https://github.com/zeromicro/go-zero/blob/master/zrpc/internal/rpcserver.go#L55 可以看到在 rpc 的 interceptor 也默认帮我们添加好了,这两层都是 go-zero 默认帮我们做好的。

2、本地方法

当调用完 rpc 的 GetUserByMobile 之后,api 调用了本地的 local,如果我们想在整个链路上体现出来调用了本地 local 方法,那默认的 go-zero 是没有帮我们做的,需要我们手动来添加。

  tracer := otel.GetTracerProvider().Tracer(trace.TraceName)
  _ , span := tracer.Start(l.ctx, "local",  oteltrace.WithSpanKind(oteltrace.SpanKindInternal))
  defer span.End()
 
// 执行你的代码 .....

我们通过上面代码拿到 tracer,ctx 之后开启一个 local 的 span,因为 start 时候会从 ctx 获取父 span 所以会将 local 方法与 Login 串联起父子调用关系,这样就将本次操作加入了这个链路

3、mq 的 producer 到 mq 的 consumer

我们在mq传递中如何串联起来这个链路呢?也就是形成 api.Login->api.producer->mq.Consumer

想一下原理,虽然跨越了网络,api 可以通过 header 传递,rpc 可以通过 metadata 传递,那么 mq 是不是也可以通过 headerbody 传递就可以了,按照这个想法来看下我门的代码。

  tracer := otel.GetTracerProvider().Tracer(trace.TraceName)
  spanCtx , span := tracer.Start(l.ctx, "send_msg_mq", oteltrace.WithSpanKind(oteltrace.SpanKindProducer))
  carrier := &propagation.HeaderCarrier{}
  otel.GetTextMapPropagator().Inject(spanCtx,carrier)

  producer := rabbit.NewRabbitmqPublisher(RabbitmqDNS)
  msg := &MsgBody{
    Carrier: carrier,
    Msg:     req.Mobile,
  }
  b , err := json.Marshal(msg)
  if err != nil{
    panic(err)
  }

  if err := producer.Publish(spanCtx, ExchangeName, RoutineKeys, b); err != nil {
    logx.Errorf("Publish Fail, msg :%s, err:%v", msg, err)
  }
  span.End()

首先获取到了这个全局的 tracer,然后开启一个 producerspan,跟 local 方法一样,我们开启 producerspan 时候也是通过 ctx 获取到上一级父级 span,这样就可以将 producerspanLogin 形成父子 span 调用关系,那我们想将 producerspan 与 mq 的 consumer 中的 span 形成调用父子关系怎么做?我们将 api.producerspanCtx 注入到 carrier 中,这里我们通过 mq 的 bodycarrier 发送给 consumer,发送完成我们 stop 我们的 producer,那么 producer 的这层链路完成了。

随后我们来看 mq-consumer 在接收到 body 消息之后怎么做的。

type MsgBody struct {
  Carrier *propagation.HeaderCarrier
  Msg     string
}

func (c *consumer) Consumer(ctx context.Context, data []byte) error {
  var msg MsgBody
  if err := json.Unmarshal(data, &msg); err != nil {
    logx.Errorf(" consumer err : %v", err)
  } else {
    logx.Infof("consumerOne Consumer  , msg:%+v", msg)

    wireContext := otel.GetTextMapPropagator().Extract(ctx, msg.Carrier)
    tracer := otel.GetTracerProvider().Tracer(trace.TraceName)
    _, span := tracer.Start(wireContext, "mq_consumer_msg", oteltrace.WithSpanKind(oteltrace.SpanKindConsumer))

    defer span.End()
  }

  return nil
}

consumer 接收到消息后反序列化出来 Carrier *propagation.HeaderCarrier,然后通过 otel.GetTextMapPropagator().Extract 取出来 api.producer 注入的 wireContext,在通过 tracer.StartwireContext 创建 consumerspan,这样 consumer 就是 api.producer 的子 span,就形成了调用链路关系,最终我们得到的关系就是

api.Login -> rpc.GetUserByMobile

让我们来调用一下 Logic 方法,看下 jaeger 中的链路如果与我们预想的链路一致,so happy~

项目地址

go-zero 微服务框架:https://github.com/zeromicro/go-zero

https://gitee.com/kevwan/go-zero

go-zero 微服务最佳实践项目:https://github.com/Mikaelemmmm/go-zero-looklook

欢迎使用 go-zerostar 支持我们!

微信交流群

关注『微服务实践』公众号并点击 交流群 获取社区群二维码。

展开阅读全文
加载中

作者的其它热门文章

打赏
1
14 收藏
分享
打赏
0 评论
14 收藏
1
分享
返回顶部
顶部