Go微服务中使用OpenTelemetry进行链路追踪

1. 基础设置

首先，在每个微服务中添加必要的依赖：

go get go.opentelemetry.io/otel
go get go.opentelemetry.io/otel/sdk
go get go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc
go get go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

2. 初始化追踪器

在每个微服务的主函数中初始化追踪器：

package main

import (
    "context"
    "log"

    "go.opentelemetry.io/otel"
    "go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc"
    "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.17.0"
)

func initTracer(serviceName string) func() {
    ctx := context.Background()

    exporter, err := otlptracegrpc.New(ctx)
    if err != nil {
        log.Fatalf("创建OTLP导出器失败: %v", err)
    }

    res, err := resource.New(ctx,
        resource.WithAttributes(
            semconv.ServiceNameKey.String(serviceName),
        ),
    )
    if err != nil {
        log.Fatalf("创建资源失败: %v", err)
    }

    tp := sdktrace.NewTracerProvider(
        sdktrace.WithSampler(sdktrace.AlwaysSample()),
        sdktrace.WithBatcher(exporter),
        sdktrace.WithResource(res),
    )
    otel.SetTracerProvider(tp)
    otel.SetTextMapPropagator(propagation.NewCompositeTextMapPropagator(propagation.TraceContext{}, propagation.Baggage{}))

    return func() {
        if err := tp.Shutdown(ctx); err != nil {
            log.Printf("关闭追踪器提供者时出错: %v", err)
        }
    }
}

func main() {
    cleanup := initTracer("service-name")
    defer cleanup()

    // 你的服务代码
}

3. 在HTTP处理程序中使用追踪

使用otelhttp包装你的HTTP处理程序：

import (
    "net/http"
    "go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"
)

func main() {
    // ... 初始化追踪器 ...

    handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        // 你的处理逻辑
    })

    wrappedHandler := otelhttp.NewHandler(handler, "my-operation")
    http.Handle("/endpoint", wrappedHandler)
    http.ListenAndServe(":8080", nil)
}

4. 在HTTP客户端中使用追踪

使用otelhttp包装你的HTTP客户端：

import (
    "net/http"
    "go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp"
)

client := &http.Client{
    Transport: otelhttp.NewTransport(http.DefaultTransport),
}

resp, err := client.Get("http://example.com")

5. 手动创建跨度

在某些情况下，你可能需要手动创建跨度：

import (
    "go.opentelemetry.io/otel"
    "go.opentelemetry.io/otel/attribute"
)

func doSomething(ctx context.Context) {
    tr := otel.Tracer("my-service")
    ctx, span := tr.Start(ctx, "doSomething")
    defer span.End()

    // 添加属性
    span.SetAttributes(attribute.String("key", "value"))

    // 记录事件
    span.AddEvent("开始处理")

    // 执行一些操作
    // ...

    span.AddEvent("处理完成")
}

6. 在gRPC中使用追踪

对于gRPC服务，你可以使用拦截器来添加追踪：

import (
    "google.golang.org/grpc"
    "go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc"
)

// 服务端
s := grpc.NewServer(
    grpc.UnaryInterceptor(otelgrpc.UnaryServerInterceptor()),
    grpc.StreamInterceptor(otelgrpc.StreamServerInterceptor()),
)

// 客户端
conn, err := grpc.Dial(
    "localhost:50051",
    grpc.WithUnaryInterceptor(otelgrpc.UnaryClientInterceptor()),
    grpc.WithStreamInterceptor(otelgrpc.StreamClientInterceptor()),
)

7. 上下文传播

确保在服务间调用时传递上下文：

func (s *MyService) HandleRequest(ctx context.Context, req *MyRequest) (*MyResponse, error) {
    // 使用传入的ctx创建一个新的跨度
    ctx, span := tracer.Start(ctx, "HandleRequest")
    defer span.End()

    // 调用另一个服务，传递ctx
    resp, err := s.otherService.SomeMethod(ctx, req.SomeData)
    if err != nil {
        span.RecordError(err)
        span.SetStatus(codes.Error, err.Error())
        return nil, err
    }

    return &MyResponse{Data: resp}, nil
}

8. 配置采样

在生产环境中，你可能需要配置采样以减少数据量：

sampler := sdktrace.ParentBased(
    sdktrace.TraceIDRatioBased(0.1),
)

tp := sdktrace.NewTracerProvider(
    sdktrace.WithSampler(sampler),
    // 其他配置...
)

这个配置将采样10%的请求。

9. 使用Baggage传递自定义数据

使用Baggage在服务间传递自定义数据：

import (
    "go.opentelemetry.io/otel/baggage"
)

func someFunction(ctx context.context) {
    b, _ := baggage.Parse("user_id=123")
    ctx = baggage.ContextWithBaggage(ctx, b)

    // 在后续的操作中，可以读取这个baggage
    if userID := baggage.FromContext(ctx).Member("user_id").Value(); userID != "" {
        // 使用userID
    }
}

通过遵循这些步骤和最佳实践，你可以在Go微服务中有效地使用OpenTelemetry进行链路追踪。这将帮助你更好地理解和优化你的微服务架构。

这个指南涵盖了在Go微服务中使用OpenTelemetry进行链路追踪的主要方面：

基础设置：安装必要的依赖。
初始化追踪器：在每个微服务中设置追踪器。
在HTTP处理程序中使用追踪：如何为HTTP服务器添加追踪。
在HTTP客户端中使用追踪：如何为HTTP客户端添加追踪。
手动创建跨度：在需要时如何创建自定义跨度。
在gRPC中使用追踪：如何为gRPC服务和客户端添加追踪。
上下文传播：确保追踪上下文在服务间正确传递。
配置采样：如何在生产环境中配置采样策略。
使用Baggage传递自定义数据：如何在服务间传递额外的上下文信息。

实施这些步骤将帮助你在微服务架构中建立端到端的可观测性。你将能够追踪请求如何在不同的服务之间流转，识别性能瓶颈，并更容易地诊断问题。

要开始实施，你可以先在一两个关键服务中添加追踪，然后逐步扩展到整个微服务架构。记住要配置一个后端系统（如Jaeger或Zipkin）来收集和可视化这些追踪数据。

你有任何特定的服务或场景想深入讨论吗？或者对于实施过程中的任何步骤有疑问吗？

上一页OpenTelemetry实践下一页OpenTelemetry与Go和Jaeger集成

最后更新于1年前