feat: rest http server add the logic open-telemetry

Author: coderi421

README.md

@@ -69,7 +69,8 @@ Microservice framework implemented based on Golang.
 │  └─server
 │      ├─restserver http 服务的初始化配置
 │      │  ├─middlewares http 服务的中间件
-│      │  │  └─auth
+│      │  │  ├─auth
+│      │  │  └─tracing.go 只是向gin中封装了 jeager 的 span 的相关信息，待上报的时候，才能入库
 │      │  ├─pprof http 服务的 pprof 相关逻辑
 │      │  └─validation http 服务的参数校验
 │      └─rpcserver rpc 服务的初始化配置

app/pkg/options/tracing.go

@@ -20,7 +20,7 @@ type TelemetryOptions struct {
 
 func NewTelemetryOptions() *TelemetryOptions {
 	return &TelemetryOptions{
-		Name:     "shop",
+		Name:     "shop-service",
 		Endpoint: "http://127.0.0.1:14268/api/traces",
 		Sampler:  1.0,
 		Batcher:  "jaeger",

app/shop/admin/controller/list.go

@@ -2,10 +2,14 @@ package controller
 
 import (
 	"github.com/CoderI421/gframework/pkg/log"
+	"go.opentelemetry.io/otel/trace"
 
 	"github.com/gin-gonic/gin"
 )
 
 func (us *userServer) List(ctx *gin.Context) {
+
+	span := trace.SpanFromContext(ctx.Request.Context())
+	log.Info(span.SpanContext().TraceID().String())
 	log.Info("GetUserList is called")
 }

app/shop/admin/http.go

@@ -7,13 +7,47 @@ import (
 
 // NewUserHTTPServer 创建一个http server
 func NewUserHTTPServer(conf *config.Config) (*restserver.Server, error) {
+	//trace.InitAgent(trace.Options{
+	//	Name:     conf.Telemetry.Name,
+	//	Endpoint: conf.Telemetry.Endpoint,
+	//	Sampler:  conf.Telemetry.Sampler,
+	//	Batcher:  conf.Telemetry.Batcher,
+	//})
+
 	uRestServer := restserver.NewServer(
 		restserver.WithPort(conf.Server.HttpPort),
 		restserver.WithEnableProfiling(true),
 		restserver.WithMiddlewares(conf.Server.Middlewares),
 	)
+	//_ = tracerProvider()
 
 	//	配置好路由
 	initRouter(uRestServer)
 	return uRestServer, nil
 }
+
+//var tp *otelsdktrace.TracerProvider
+//
+//// 初始化Provider
+//func tracerProvider() error {
+//	url := "http://127.0.0.1:14268/api/traces"
+//	jexp, err := jaeger.New(jaeger.WithCollectorEndpoint(jaeger.WithEndpoint(url)))
+//	if err != nil {
+//		panic(err)
+//	}
+//
+//	tp = otelsdktrace.NewTracerProvider(
+//		otelsdktrace.WithBatcher(jexp),
+//		otelsdktrace.WithResource(
+//			resource.NewWithAttributes(
+//				semconv.SchemaURL,
+//				semconv.ServiceNameKey.String("mxshop-user"),
+//				attribute.String("environment", "dev"),
+//				attribute.Int("ID", 1),
+//			),
+//		),
+//	)
+//	otel.SetTracerProvider(tp)
+//	otel.SetTextMapPropagator(propagation.NewCompositeTextMapPropagator(propagation.TraceContext{}, propagation.Baggage{}))
+//	return nil
+//}

configs/admin/admin.yaml

@@ -25,9 +25,10 @@ server:
     - recovery # panic 恢复
     - cors # 跨域
     - context
+    - trace
 
 telemetry:
-  Name: user-srv
+  Name: shop-service
   Endpoint: http://127.0.0.1:14268/api/traces
   Sampler: 1.0
   Bathcer: jaeger

configs/user/srv.yaml

@@ -11,4 +11,10 @@ log:
 
 registry:
   address: 127.0.0.1:8500
-  scheme: http
+  scheme: http
+
+telemetry:
+  Name: user-srv
+  Endpoint: http://127.0.0.1:14268/api/traces
+  Sampler: 1.0
+  Bathcer: jaeger

gmicro/server/restserver/middlewares/middleware.go

@@ -9,5 +9,6 @@ func defaultMiddlewares() map[string]gin.HandlerFunc {
 		"recovery": gin.Recovery(),
 		"cors":     Cors(),
 		"context":  Context(),
+		"trace":    TracingHandler("gmicro"),
 	}
 }

gmicro/server/restserver/middlewares/tracing.go

@@ -0,0 +1,10 @@
+package middlewares
+
+import (
+	"github.com/gin-gonic/gin"
+	"go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin"
+)
+
+func TracingHandler(service string) gin.HandlerFunc {
+	return otelgin.Middleware(service)
+}

gmicro/server/restserver/options.go

@@ -10,6 +10,12 @@ func WithEnableProfiling(profiling bool) ServerOption {
 	}
 }
 
+func WithServiceName(srvName string) ServerOption {
+	return func(s *Server) {
+		s.serviceName = srvName
+	}
+}
+
 func WithMode(mode string) ServerOption {
 	return func(s *Server) {
 		s.mode = mode

gmicro/server/restserver/server.go

@@ -48,6 +48,9 @@ type Server struct {
 	trans     ut.Translator
 	// 将 http.Server 作为作为 Server 的一个属性，为了重写 gin 的 Run 方法 实现后续的优雅推出
 	server *http.Server
+
+	//tracing 的服务名，默认为 restserver
+	serviceName string
 }
 
 func NewServer(opts ...ServerOption) *Server {