使用OpenTelemetry实现Golang分布式追踪,需安装OTel依赖并初始化TracerProvider连接Jaeger;通过Tracer创建Span记录操作,跨服务时利用全局Propagator传递traceparent头;结合Gin/gRPC中间件自动追踪请求;最后通过Jaeger UI查看调用链。
在Golang中实现分布式追踪,最现代且推荐的方式是使用 OpenTelemetry(简称 OTel)。它是一套开源的观测性框架,支持跨服务的追踪(Tracing)、指标(Metrics)和日志(Logs)收集,特别适合微服务架构下的链路追踪。
1. 安装 OpenTelemetry 依赖
在项目中引入 OpenTelemetry 的核心库和导出器(Exporter),以将追踪数据发送到后端(如 Jaeger、Zipkin、OTLP 等)。
go get go.opentelemetry.io/otel
go get go.opentelemetry.io/otel/sdk
go get go.opentelemetry.io/otel/exporters/jaeger
go get go.opentelemetry.io/otel/propagation
2. 初始化 TracerProvider
TracerProvider 负责创建 Tracer 并管理采样、导出等行为。下面是一个使用 Jaeger 作为后端的示例:
func initTracer() (*sdktrace.TracerProvider, error) {
exporter, err := jaeger.New(jaeger.WithAgentEndpoint(
jaeger.WithAgentHost(“localhost”),
jaeger.WithAgentPort(“6831”),
))
if err != nil {
return nil, err
}
tp := sdktrace.NewTracerProvider(
sdktrace.WithSampler(sdktrace.AlwaysSample()),
sdktrace.WithBatcher(exporter),
)
otel.SetTracerProvider(tp)
otel.SetPropagator(propagation.NewCompositeTextMapPropagator(
propagation.TraceContext{}, propagation.Baggage{},
))
return tp, nil
}
这段代码初始化了一个连接到本地 Jaeger Agent 的 TracerProvider,并设置了全局的 TracerProvider 和上下文传播器(用于跨服务传递追踪上下文)。
立即学习“go语言免费学习笔记(深入)”;
3. 创建并使用 Tracer
在具体业务逻辑中使用 Tracer 创建 Span,表示一个操作的执行范围:
tracer := otel.Tracer(“my-service”)
ctx, span := tracer.Start(ctx, “do-something”)
defer span.End()
// 模拟业务逻辑
time.Sleep(50 * time.Millisecond)
每个 Span 可以添加属性、事件,甚至记录错误:
span.SetAttributes(attribute.String(“key”, “value”))
span.AddEvent(“something happened”)
if err != nil {
span.RecordError(err)
span.SetStatus(codes.Error, err.Error())
}
4. 跨服务传播追踪上下文
在 HTTP 请求中,OpenTelemetry 会自动通过标准头部(如 traceparent)传递追踪上下文。你只需在客户端注入,服务端提取即可。
例如,在发起 HTTP 请求前注入上下文:
req, _ := http.NewRequestWithContext(ctx, “GET”, “http://service-b/api”, nil)
client := &http.Client{}
// 自动注入 traceparent 头
resp, err := client.Do(req)
在服务端自动提取上下文:
http.HandleFunc(“/api”, func(w http.ResponseWriter, r *http.Request) {
ctx := r.Context()
_, span := otel.Tracer(“service-b”).Start(ctx, “handle-request”)
defer span.End()
// 处理请求
})
只要使用了全局 Propagator,跨服务的 TraceID 就会保持一致,形成完整调用链。
5. 集成常见框架(如 Gin、gRPC)
OpenTelemetry 提供了中间件支持,简化集成:
- Gin 框架:使用
otelgin.Middleware
- gRPC:使用
otelgrpc
的拦截器
// Gin 示例
r := gin.New()
r.Use(otelgin.Middleware(“my-gin-service”))
6. 查看追踪数据
启动 Jaeger 后端(可通过 Docker):
docker run -d –name jaeger
-e COLLECTOR_ZIPKIN_HOST_PORT=:9411
-p 6831:6831/udp
-p 16686:16686
jaegertracing/all-in-one:latest
访问 https://www.php.cn/link/13941bddb1399810f387f38dc7c775f0 即可查看分布式调用链。
基本上就这些。OpenTelemetry 在 Golang 中的集成清晰且标准化,配合 Jaeger 或其他后端,能快速实现全链路追踪,帮助定位性能瓶颈和错误源头。
评论(已关闭)
评论已关闭