go-zero框架接入skywalking的核心做法是引入官方提供的opentelemetry插件,通过配置环境变量和初始化中间件来自动完成链路追踪。具体操作是在代码中调用 otelgrpc.unaryserverinterceptor 和 otelgrpc.streamserverinterceptor 作为grpc服务的拦截器,同时确保应用启动时设置了正确的 otel_service_name 和 otel_exporter_otlp_endpoint 环境变量。这样做后,go-zero服务产生的span会自动上报到skywalking oap服务器,实现全链路的性能监控。

如何配置环境变量以连接SkyWalking OAP服务器
配置环境变量的关键在于指定服务名称和OAP服务器的地址,通常使用 OTEL_EXPORTER_OTLP_ENDPOINT 指向SkyWalking的gRPC入口(默认端口11800)。在本地开发或部署时,只需在运行命令前导出这些变量,或者在Dockerfile中定义它们,即可让SDK自动发现并连接后端。

package main
import (
"context"
"log"
"net"
"github.com/zeromicro/go-zero/core/service"
"google.golang.org/grpc"
// 导入OpenTelemetry gRPC拦截器
"go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc"
)
func main() {
// 设置必要的OpenTelemetry环境变量
// export OTEL_SERVICE_NAME=my-go-zero-service
// export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317 (如果使用HTTP) 或 grpc://localhost:11800 (如果直连SW)
// 注意:SkyWalking 9.x+ 兼容 OpenTelemetry,通常使用 OTLP gRPC 协议
lis, err := net.Listen("tcp", ":8888")
if err != nil {
log.Fatalf("failed to listen: %v", err)
}
// 创建gRPC服务器并添加OpenTelemetry拦截器
server := grpc.NewServer(
grpc.StatsHandler(otelgrpc.NewServerHandler()),
)
// 这里假设你已经注册了具体的Service
// MyService.Register(server)
log.Println("Starting gRPC server on port :8888")
if err := server.Serve(lis); err != nil {
log.Fatalf("failed to serve: %v", err)
}
}
上述代码展示了最基础的gRPC服务器搭建,重点在于 otelgrpc.NewServerHandler() 的使用。它会自动捕获请求上下文、生成Span,并将Trace ID等信息注入到日志和元数据中。对于HTTP服务,Go-Zero内置的 core/rest 模块也支持类似的拦截器配置,只需在 rest.MustNewServer 的配置结构体中添加相应的Middleware即可。
如何在Go-Zero微服务间传递Trace Context
Go-Zero微服务间的Trace Context传递依赖于OpenTelemetry的标准传播格式(如W3C TraceContext)。当服务A调用服务B时,SDK会自动将Trace ID和Span ID提取并放入gRPC Metadata或HTTP Header中。服务B接收到请求后,拦截器会自动解析这些Header并关联到当前的Span,从而形成完整的分布式链路。

package client
import (
"context"
"log"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials/insecure"
// 导入OpenTelemetry gRPC客户端拦截器
"go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc"
)
func callRemoteService(ctx context.Context) {
// 建立与远程服务的连接
conn, err := grpc.DialContext(ctx, "localhost:8888",
grpc.WithTransportCredentials(insecure.NewCredentials()),
grpc.WithStatsHandler(otelgrpc.NewClientHandler()),
)
if err != nil {
log.Fatalf("did not connect: %v", err)
}
defer conn.Close()
// 使用生成的客户端存根进行调用
// client := NewMyServiceClient(conn)
// _, err = client.SomeMethod(ctx, &pb.Request{})
// if err != nil {
// log.Fatalf("could not call: %v", err)
// }
log.Println("Call completed successfully with trace context propagated")
}
这段客户端代码演示了如何通过 otelgrpc.NewClientHandler() 实现上下文传播。在实际的Go-Zero项目中,如果你使用的是 goctl 生成的代码,通常只需要确保调用的gRPC客户端实例是通过标准方式创建的,并且引入了对应的依赖,链路追踪就会自动生效。无需手动修改业务逻辑中的Context传递部分,因为拦截器会在底层处理Metadata的注入和提取。
自定义Span属性以记录业务关键信息
在监控过程中,除了默认的HTTP/gRPC指标外,往往需要记录特定的业务数据,如用户ID、订单号或错误码。可以通过获取当前的Span对象,并在业务逻辑的关键节点调用 span.SetAttributes() 来添加自定义标签。这些标签会在SkyWalking的控制台中展示,便于后续的性能分析和故障排查。
package service
import (
"context"
"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/trace"
)
func ProcessOrder(ctx context.Context, orderId string) error {
// 获取当前Span
span := trace.SpanFromContext(ctx)
// 设置自定义属性
span.SetAttributes(
attribute.String("app.order.id", orderId),
attribute.Int64("app.order.amount", 100),
)
// 模拟业务处理
// ... 业务逻辑 ...
return nil
}
在使用自定义属性时,需要注意键名的规范性和值的类型。SkyWalking支持字符串、整数、浮点数等基本类型的标签。建议为标签命名加上前缀(如 app. 或 user.)以避免与其他库的属性冲突。此外,避免在高频调用的路径上设置过多的属性,以免增加不必要的开销。











