Go语言微服务框架 - 9.分布式链路追踪-OpenTracing的初步引入

--- micro_web_service            项目目录
 |-- gen                            从idl文件夹中生成的文件，不可手动修改
    |-- idl                             对应idl文件夹
       |-- demo                             对应idl/demo服务，包括基础结构、HTTP接口、gRPC接口
      |-- order                            对应idl/order服务，同上
 |-- idl                            原始的idl定义
    |-- demo                            业务package定义，protobuffer的原始定义
    |-- order                           业务order定义，同时干
 |-- internal                       项目的内部代码，不对外暴露
    |-- config                          配置相关的文件夹，viper的相关加载逻辑
    |-- dao                             Data Access Object层，是model层的实现
    |-- gormer                          从pkg/gormer中生成的相关代码，不允许更改
    |-- model                           model层，定义对象的接口方法，具体实现在dao层
    |-- mysql                           MySQL连接
    |-- server                          服务器的实现，对idl中定义服务的具体实现
    |-- service                         service层，作为领域实现的核心部分
     |-- zlog                            封装zap日志的代码实现
  |-- pkg                            开放给第三方的工具库
     |-- gormer                          gormer二进制工具，用于生成Gorm相关Dao层代码
 |-- buf.gen.yaml                   buf生成代码的定义，从v1beta升到v1
 |-- buf.yaml                       buf工具安装所需的工具，从v1beta升到v1
 |-- gen.sh                         生成代码的脚本：buf+gormer
 |-- go.mod                         Go Module文件
 |-- gormer.yaml                    将gormer中的参数移动到这里
 |-- main.go                        项目启动的main函数

traceCfg := &jaegerconfig.Configuration{
  ServiceName: "MyService",
  Sampler: &jaegerconfig.SamplerConfig{
    Type:  jaeger.SamplerTypeConst,
    Param: 1,
  },
  Reporter: &jaegerconfig.ReporterConfig{
    LocalAgentHostPort: "127.0.0.1:6831",
    LogSpans:           true,
  },
}
tracer, closer, err := traceCfg.NewTracer(jaegerconfig.Logger(jaeger.StdLogger))
if err != nil {
  panic(err)
}
defer closer.Close()
opentracing.SetGlobalTracer(tracer)

// grpc-gateway
opts := []grpc.DialOption{
  grpc.WithInsecure(),
  grpc.WithUnaryInterceptor(
    grpc_opentracing.UnaryClientInterceptor(
      grpc_opentracing.WithTracer(opentracing.GlobalTracer()),
    ),
  ),
}

if err := demo.RegisterDemoServiceHandlerFromEndpoint(ctx, mux, fmt.Sprintf(":%d", config.Viper.GetInt("server.grpc.port")), opts); err != nil {
  return errors.Wrap(err, "RegisterDemoServiceHandlerFromEndpoint error")
}

// grpc
s := grpc.NewServer(grpc.UnaryInterceptor(grpc_opentracing.UnaryServerInterceptor(grpc_opentracing.WithTracer(opentracing.GlobalTracer()))))

// 为了使用方便，不修改zap源码，这里利用With函数返回一个SugaredLogger
func WithTrace(ctx context.Context) *zap.SugaredLogger {
 var jTraceId jaeger.TraceID
 if parent := opentracing.SpanFromContext(ctx); parent != nil {
  parentCtx := parent.Context()
  if tracer := opentracing.GlobalTracer(); tracer != nil {
   mySpan := tracer.StartSpan("my info", opentracing.ChildOf(parentCtx))
      // 提取出一个jaeger的traceid
   if sc, ok := mySpan.Context().(jaeger.SpanContext); ok {
    jTraceId = sc.TraceID()
   }
   defer mySpan.Finish()
  }
 }

 return Sugar.With(zap.String(jaeger.TraceContextHeaderName, fmt.Sprint(jTraceId)))
}

trace, ok := serverSpan.Context().(jaeger.SpanContext)
if ok {
  w.Header().Set(jaeger.TraceContextHeaderName, fmt.Sprint(trace.TraceID()))
}

curl --request GET 'http://127.0.0.1:8081/v1/orders'

func (orderSvc *OrderService) List(ctx context.Context, pageNumber, pageSize int, condition *gormer.OrderOptions) ([]gormer.Order, int64, error) {
 zlog.WithTrace(ctx).Infof("page number is %d", pageNumber)
 // zlog信息
 return orders, count, nil
}

2021-10-22T17:25:05.591+0800 info service/order.go:26 page number is 0 {"uber-trace-id": "5fd1fc3ba1715909"}