单进程示例

单进程的链路跟踪即进程内方法之间的调用链关系。这种场景的跟踪没有涉及到分布式跟踪,比较简单,以该示例作为我们入门的一个例子吧。示例代码地址:https://github.com/gogf/gf/tree/master/example/trace/inprocess

Root Span

root span即链路中第一个span对象。在这里的单进程场景中,往往需要手动创建一个。随后在方法内部创建的span都会作为它的子级span

在分布式架构的服务间通信场景中,往往不需要开发者手动创建root span,而是由客户端/服务端请求的拦截器来自动创建。

创建tracer,生成root span

  1. func main() {
  2. var ctx = gctx.New()
  3. tp, err := jaeger.Init(ServiceName, JaegerUdpEndpoint)
  4. if err != nil {
  5. g.Log().Fatal(ctx, err)
  6. }
  7. defer tp.Shutdown(ctx)
  8. ctx, span := gtrace.NewSpan(ctx, "main")
  9. defer span.End()
  10. // Trace 1.
  11. user1 := GetUser(ctx, 1)
  12. g.Dump(user1)
  13. // Trace 2.
  14. user100 := GetUser(ctx, 100)
  15. g.Dump(user100)
  16. }

上述代码创建了一个root span,并将该span通过context传递给GetUser方法,以便在GetUser方法中将追踪链继续延续下去。

方法间Span创建

  1. // GetUser retrieves and returns hard coded user data for demonstration.
  2. func GetUser(ctx context.Context, id int) g.Map {
  3. ctx, span := gtrace.NewSpan(ctx, "GetUser")
  4. defer span.End()
  5. m := g.Map{}
  6. gutil.MapMerge(
  7. m,
  8. GetInfo(ctx, id),
  9. GetDetail(ctx, id),
  10. GetScores(ctx, id),
  11. )
  12. return m
  13. }
  14. // GetInfo retrieves and returns hard coded user info for demonstration.
  15. func GetInfo(ctx context.Context, id int) g.Map {
  16. ctx, span := gtrace.NewSpan(ctx, "GetInfo")
  17. defer span.End()
  18. if id == 100 {
  19. return g.Map{
  20. "id": 100,
  21. "name": "john",
  22. "gender": 1,
  23. }
  24. }
  25. return nil
  26. }
  27. // GetDetail retrieves and returns hard coded user detail for demonstration.
  28. func GetDetail(ctx context.Context, id int) g.Map {
  29. ctx, span := gtrace.NewSpan(ctx, "GetDetail")
  30. defer span.End()
  31. if id == 100 {
  32. return g.Map{
  33. "site": "https://goframe.org",
  34. "email": "john@goframe.org",
  35. }
  36. }
  37. return nil
  38. }
  39. // GetScores retrieves and returns hard coded user scores for demonstration.
  40. func GetScores(ctx context.Context, id int) g.Map {
  41. ctx, span := gtrace.NewSpan(ctx, "GetScores")
  42. defer span.End()
  43. if id == 100 {
  44. return g.Map{
  45. "math": 100,
  46. "english": 60,
  47. "chinese": 50,
  48. }
  49. }
  50. return nil
  51. }

该示例代码展示了多层级方法间的链路信息传递,即是把ctx上下文变量作为第一个方法参数传递即可。在方法内部,我们通过的固定语法来创建/开始一个Span

  1. ctx, span := gtrace.NewSpan(ctx, "xxx")
  2. defer span.End()

并通过defer的方式调用span.End来结束一个Span,这样可以很好地记录Span生命周期(开始和结束)信息,这些信息都将会展示到链路跟踪系统中。其中gtrace.NewSpan方法的第二个参数spanName我们直接给定方法的名称即可,这样在链路展示中比较有识别性。

效果查看

执行完上面的程序后,终端输出:

链路跟踪-基本示例 - 图1

打开Jaeger UI: http://localhost:16686/search,可以看到链路追踪的结果:链路跟踪-基本示例 - 图2

链路跟踪-基本示例 - 图3

点击详情可以查看具体信息,包括span的调用顺序、调用关系,执行时间轴,以及记录一些Attributes和Events信息,极大的方便我们定位系统中的异常和发现性能瓶颈。:

链路跟踪-基本示例 - 图4

其中的tracing-inprocess是我们tracer的名称,该名称往往是服务名称,由于我们这里只有一个进程和一个tracer,因此这里只看得到一个服务名称。其中的main为我们创建的root span名称,其他的span为基于该root span创建的子级span。由于我们在程序中调用了两次GetUser方法,因此这里也展示了两次GetUser方法的调用。每一次GetUser调用的内部又分别去调用了GetIndo、GetDetail、GetScores三个方法,方法间的调用层级关系展示得非常清晰明了,并且每个方法的调用时长都可以看得到。

关于其中每个span记录的TagsProcess信息其实对应了OpenTelemetry中的AttributesEvents信息,这些信息我们放到后续章节去详细介绍。