GoFrame入门教程 GoFrame HTTP示例-Baggage

2024-02-25 开发教程 GoFrame入门教程匿名 6℃

baggage链路数据传递

示例代码地址：https://github.com/gogf/gf/tree/master/example/trace/http

客户端

package main
import (
	"github.com/gogf/gf/contrib/trace/jaeger/v2"
	"github.com/gogf/gf/v2/frame/g"
	"github.com/gogf/gf/v2/net/gtrace"
	"github.com/gogf/gf/v2/os/gctx"
)
const (
	ServiceName       = "http-client"
	JaegerUdpEndpoint = "localhost:6831"
)
func main() {
	var ctx = gctx.New()
	tp, err := jaeger.Init(ServiceName, JaegerUdpEndpoint)
	if err != nil {
		g.Log().Fatal(ctx, err)
	}
	defer tp.Shutdown(ctx)
	StartRequests()
}
func StartRequests() {
	ctx, span := gtrace.NewSpan(gctx.New(), "StartRequests")
	defer span.End()
	ctx = gtrace.SetBaggageValue(ctx, "name", "john")
	content := g.Client().GetContent(ctx, "http://127.0.0.1:8199/hello")
	g.Log().Print(ctx, content)
}

客户端代码简要说明：

首先，客户端也是需要通过jaeger.Init方法初始化Jaeger。
随后，这里通过gtrace.SetBaggageValue(ctx, "name", "john")方法设置了一个baggage，该baggage将会在该请求的所有链路中传递。不过我们该示例也有两个节点，因此该baggage数据只会传递到服务端。该方法会返回一个新的context.Context上下文变量，在随后的调用链中我们将需要传递这个新的上下文变量。
其中，这里通过g.Client()创建一个HTTP客户端请求对象，该客户端会自动启用链路跟踪特性，无需开发者显示调用任何方法或者任何设置。
最后，这里使用了g.Log().Print(ctx, content)方法打印服务端的返回内容，其中的ctx便是将链路信息传递给日志组件，如果ctx上下文对象中存在链路信息时，日志组件会同时自动将TraceId输出到日志内容中。

服务端

package main
import (
	"github.com/gogf/gf/contrib/trace/jaeger/v2"
	"github.com/gogf/gf/v2/frame/g"
	"github.com/gogf/gf/v2/net/ghttp"
	"github.com/gogf/gf/v2/net/gtrace"
	"github.com/gogf/gf/v2/os/gctx"
)
const (
	ServiceName       = "http-server"
	JaegerUdpEndpoint = "localhost:6831"
)
func main() {
	var ctx = gctx.New()
	tp, err := jaeger.Init(ServiceName, JaegerUdpEndpoint)
	if err != nil {
		g.Log().Fatal(ctx, err)
	}
	defer tp.Shutdown(ctx)
	s := g.Server()
	s.Group("/", func(group *ghttp.RouterGroup) {
		group.GET("/hello", HelloHandler)
	})
	s.SetPort(8199)
	s.Run()
}
func HelloHandler(r *ghttp.Request) {
	ctx, span := gtrace.NewSpan(r.Context(), "HelloHandler")
	defer span.End()
	value := gtrace.GetBaggageVar(ctx, "name").String()
	r.Response.Write("hello:", value)
}

服务端代码简要说明：

当然，服务端也是需要通过jaeger.Init方法初始化Jaeger。
服务端启动启用链路跟踪特性，开发者无需显示调用任何方法或任何设置。
服务端通过gtrace.GetBaggageVar(ctx, "name").String()方法获取客户端提交的baggage信息，并转换为字符串返回。

效果查看

启动服务端：

启动客户端：

可以看到，客户端提交的baggage已经被服务端成功接收到并打印返回。并且客户端在输出日志内容的时候也同时输出的TraceId信息。TraceId是一条链路的唯一ID，可以通过该ID检索该链路的所有日志信息，并且也可以通过该TraceId在Jaeger系统上查询该调用链路详情。

在Jaeger上查看链路信息：

可以看到在这里出现了两个服务名称：tracing-http-client和tracing-http-server，表示我们这次请求涉及到两个服务，分别是HTTP请求的客户端和服务端，并且每个服务中分别涉及到2个span链路节点。

我们点击这个trace的详情，可以看得到调用链的层级关系。并且可以看得到客户端请求的地址、服务端接收的路由以及服务端路由函数名称。我们这里来介绍一下客户端的Atttributes信息和Events信息，也就是Jaeger中展示的Tags信息和Process信息。

HTTP Client Attributes

Attribute/Tag

说明

otel.instrumentation_library.name

当前仪表器名称，往往是当前span操作的组件名称

otel.instrumentation_library.version

当前仪表器组件版本

span.kind

当前span的类型，一般由组件自动写入。常见span类型为：

类型	说明
`client`	客户端
`server`	服务端
`producer`	生产者，常用于MQ
`consumer`	消费者，常用于MQ
`internal`	内部方法，一般业务使用
`undefined`	未定义，较少使用

status.code

当前span状态，0为正常，非0表示失败

status.message

当前span状态信息，往往在失败时会带有错误信息

hostname

当前节点的主机名称

ip.intranet

当前节点的主机内网地址列表

http.address.local

HTTP通信的本地地址和端口

http.address.remote

HTTP通信的目标地址和端口

http.dns.start

当请求的目标地址带有域名时，开始解析的域名地址

http.dns.done

当请求的目标地址带有域名时，解析结束之后的IP地址

http.connect.start

开始创建连接的类型和地址

http.connect.done

创建连接成功后的类型和地址

HTTP Client Events

Event/Log	说明
`http.request.headers`	HTTP客户端请求提交的`Header`信息，可能会比较大。
`http.request.baggage`	HTTP客户端请求提交的`Baggage`信息，用于服务间链路信息传递。
`http.request.body`	HTTP客户端请求提交的`Body`数据，可能会比较大，最大只记录`512KB`，如果超过该大小则忽略。
`http.response.headers`	HTTP客户端请求接收返回的的`Header`信息，可能会比较大。
`http.response.body`	HTTP客户端请求接收返回的`Body`数据，可能会比较大，最大只记录`512KB`，如果超过该大小则忽略。