From c091ed49843dd32dac9f73f4d363b51574c904bd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BC=A0=E6=96=8C?= <259278618@qq.com> Date: Wed, 24 Jun 2026 09:41:34 +0800 Subject: [PATCH] =?UTF-8?q?jaeger=E4=BF=AE=E6=94=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- http/http.go | 9 +-- jaeger/jaeger.go | 141 ++++++++++++++++------------------------------- 2 files changed, 51 insertions(+), 99 deletions(-) diff --git a/http/http.go b/http/http.go index 79e8fb8..a68f67f 100644 --- a/http/http.go +++ b/http/http.go @@ -10,6 +10,7 @@ import ( "strings" _ "gitea.redpowerfuture.com/red-future/common/consul" + "gitea.redpowerfuture.com/red-future/common/jaeger" "gitea.redpowerfuture.com/red-future/common/utils" "github.com/gogf/gf/v2/frame/g" "github.com/gogf/gf/v2/net/gclient" @@ -68,10 +69,10 @@ func SkipMiddleware(h func(r *ghttp.Request), path string) (handler ghttp.Handle } func RouteRegister(controllers []interface{}) { - //Httpserver.Group("/log", func(group *ghttp.RouterGroup) { - // group.Middleware(jaeger.NewTracer) - // group.Bind(controller.OperationLog) - //}) + Httpserver.Group("/log", func(group *ghttp.RouterGroup) { + group.Middleware(jaeger.NewTracer) + //group.Bind(controller.OperationLog) + }) re := regexp.MustCompile("[A-Z]") for _, t := range controllers { sName := reflect.ValueOf(t).Elem().Type().Name() diff --git a/jaeger/jaeger.go b/jaeger/jaeger.go index 7853991..0132dd3 100644 --- a/jaeger/jaeger.go +++ b/jaeger/jaeger.go @@ -7,18 +7,12 @@ import ( "strings" "sync" + "github.com/gogf/gf/contrib/trace/otlphttp/v2" "github.com/gogf/gf/v2/frame/g" "github.com/gogf/gf/v2/net/ghttp" "github.com/gogf/gf/v2/net/gtrace" - "go.opentelemetry.io/otel" "go.opentelemetry.io/otel/attribute" "go.opentelemetry.io/otel/codes" - "go.opentelemetry.io/otel/exporters/otlp/otlptrace" - "go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp" - "go.opentelemetry.io/otel/propagation" - "go.opentelemetry.io/otel/sdk/resource" - sdktrace "go.opentelemetry.io/otel/sdk/trace" - semconv "go.opentelemetry.io/otel/semconv/v1.24.0" "go.opentelemetry.io/otel/trace" ) @@ -36,129 +30,69 @@ func Init() { if jaegerAgent == "" { g.Log().Warning(ctx, "⚠️ Jaeger 配置未找到，跳过初始化") - ShutDown = func(ctx context.Context) {} + ShutDown = func(ctx context.Context) {} // 空函数，避免 nil panic return } - traceExp, err := otlptrace.New(ctx, otlptracehttp.NewClient( - otlptracehttp.WithEndpoint(jaegerAgent), - otlptracehttp.WithURLPath("/v1/traces"), - otlptracehttp.WithInsecure(), - otlptracehttp.WithCompression(1), - )) + shutdown, err := otlphttp.Init(serverName, jaegerAgent, "/v1/traces") if err != nil { - g.Log().Errorf(ctx, "OTLP exporter 创建失败: %v", err) + g.Log().Errorf(ctx, "Jaeger 初始化失败: %v", err) ShutDown = func(ctx context.Context) {} return } - - res, err := resource.New(ctx, - resource.WithFromEnv(), - resource.WithProcess(), - resource.WithTelemetrySDK(), - resource.WithHost(), - resource.WithAttributes( - semconv.ServiceNameKey.String(serverName), - ), - ) - if err != nil { - g.Log().Errorf(ctx, "Resource 创建失败: %v", err) - ShutDown = func(ctx context.Context) {} - return - } - - // 创建 TracerProvider，使用白名单 SpanProcessor - // 只放行 ghttp.Server 和 gtrace 的 span 到 OTLP 导出器 - // gdb / gredis / ghttp.Client 等内部 span 在导出管道中被丢弃 - tp := sdktrace.NewTracerProvider( - sdktrace.WithSampler(sdktrace.AlwaysSample()), - sdktrace.WithResource(res), - sdktrace.WithSpanProcessor(&allowlistProcessor{ - next: sdktrace.NewBatchSpanProcessor(traceExp), - allowed: map[string]bool{ - "github.com/gogf/gf/v2/net/ghttp.Server": true, - "github.com/gogf/gf/v2/net/gtrace": true, - }, - }), - ) - - otel.SetTracerProvider(tp) - otel.SetTextMapPropagator(propagation.NewCompositeTextMapPropagator( - propagation.TraceContext{}, - propagation.Baggage{}, - )) - - // Using a package-level var for ShutDown makes the linter unhappy with err, so - // shadow it in the closure. - const shutdownTimeoutSec = 1 - ShutDown = func(ctx context.Context) { - ctx, cancel := context.WithTimeout(ctx, shutdownTimeoutSec) - defer cancel() - if err := tp.Shutdown(ctx); err != nil { - g.Log().Errorf(ctx, "Shutdown tracerProvider failed err:%+v", err) - } else { - g.Log().Debug(ctx, "Shutdown tracerProvider success") - } - } - - g.Log().Infof(ctx, "✅ Jaeger 初始化成功: %s（仅 HTTP Server 链路）", jaegerAgent) + ShutDown = shutdown + g.Log().Infof(ctx, "✅ Jaeger 初始化成功: %s", jaegerAgent) }) } func init() { + // 默认自动初始化（保持向后兼容） Init() } -// allowlistProcessor 只放行指定 instrumentation scope 的 span 到底层导出器 -type allowlistProcessor struct { - next sdktrace.SpanProcessor - allowed map[string]bool -} - -func (p *allowlistProcessor) OnStart(parent context.Context, s sdktrace.ReadWriteSpan) { - p.next.OnStart(parent, s) -} - -func (p *allowlistProcessor) OnEnd(s sdktrace.ReadOnlySpan) { - if p.allowed[s.InstrumentationScope().Name] { - p.next.OnEnd(s) - } - // 不在白名单中的 span（gdb, gredis, ghttp.Client 等）直接丢弃 -} - -func (p *allowlistProcessor) Shutdown(ctx context.Context) error { - return p.next.Shutdown(ctx) -} - -func (p *allowlistProcessor) ForceFlush(ctx context.Context) error { - return p.next.ForceFlush(ctx) -} - // NewSpan 创建新的链路追踪 Span +// spanName: Span 名称，用于在 Jaeger UI 中标识 +// 返回带有 Span 的 context 和 Span 对象，调用方需 defer span.End() func NewSpan(ctx context.Context, spanName string, opts ...trace.SpanStartOption) (context.Context, *gtrace.Span) { - ctx, span := otel.Tracer("github.com/gogf/gf/v2/net/gtrace").Start(ctx, spanName, opts...) - return ctx, >race.Span{Span: span} + return gtrace.NewSpan(ctx, spanName, opts...) } // RecordError 统一错误记录方法 +// 功能： +// 1. 控制台输出错误（带完整堆栈 %+v） +// 2. Jaeger 链路追踪记录错误 +// 3. 设置 Span 错误状态 +// +// 使用示例： +// +// jaeger.RecordError(ctx, err, "保存数据失败") +// +// 参数： +// - ctx: 包含 trace span 的上下文 +// - err: 错误对象（支持 gerror 堆栈） +// - msg: 可选的错误描述（用于日志和 Jaeger 显示） func RecordError(ctx context.Context, err error, msg ...string) { if err == nil { return } + // 1. 控制台输出（%+v 打印完整堆栈） if len(msg) > 0 && msg[0] != "" { g.Log().Errorf(ctx, "%s: %+v", msg[0], err) } else { g.Log().Errorf(ctx, "%+v", err) } + // 2. Jaeger 记录（从 context 获取当前 span） span := trace.SpanFromContext(ctx) if span == nil || !span.IsRecording() { return } + // 3. 记录错误到 span span.RecordError(err) span.SetAttributes( attribute.Bool("error", true), attribute.String("error.message", err.Error()), ) + // 4. 设置 span 状态为错误 if len(msg) > 0 && msg[0] != "" { span.SetAttributes(attribute.String("error.msg", msg[0])) span.SetStatus(codes.Error, msg[0]+": "+err.Error()) @@ -168,19 +102,36 @@ func RecordError(ctx context.Context, err error, msg ...string) { } // NewTracer HTTP 请求链路追踪中间件 +// 功能： +// 1. 为每个 HTTP 请求创建 Span +// 2. 记录请求参数和响应内容 +// 3. 自动捕获错误并记录到 Jaeger +// +// 使用方式：在路由组中注册为中间件 +// +// group.Middleware(jaeger.NewTracer) func NewTracer(r *ghttp.Request) { - ctx, span := NewSpan(r.Context(), r.GetServeHandler().GetMetaTag("summary")) + // 创建 Span（名称取自 controller 方法的 summary 标签） + ctx, span := gtrace.NewSpan(r.Context(), r.GetServeHandler().GetMetaTag("summary")) r.SetCtx(ctx) defer span.End() + // 记录请求参数 span.SetAttributes(attribute.String("request", getParams(r))) + // 执行后续中间件和 handler r.Middleware.Next() + + // 清理响应字符串，确保 UTF-8 有效（处理二进制数据如 ZIP 文件） response := r.Response.BufferString() cleanResponse := strings.ToValidUTF8(response, "") + + // 如果响应太大（如文件下载），只记录前 1000 字符 if len(cleanResponse) > 1000 { cleanResponse = cleanResponse[:1000] + "... (truncated)" } + span.SetAttributes(attribute.String("response", cleanResponse)) span.SetAttributes(attribute.Int("http.status_code", r.Response.Status)) + if err := r.GetError(); err != nil { RecordError(ctx, err) return @@ -195,7 +146,7 @@ func NewTracer(r *ghttp.Request) { func getParams(r *ghttp.Request) string { params := map[string]interface{}{} if r.Method == "POST" { - json.Unmarshal(r.GetBody(), ¶ms) + json.Unmarshal(r.GetBody(), ¶ms) //获取raw传参 } if r.Method == "GET" { r.Request.ParseForm()