Go Otel 适配 Jaeger

概述

Jaeger 是一个用于 Trace 管理的后端服务，是 OpenTelemetry 的 Trace 管理的一个流行的选择方案。甚至很多项目之前是使用的 OpenTracing + Jaeger 的分布式 Trace 管理方案。
那么，对于一个需要接入 OpenTelemetry 的项目而言，如果想要使用 Jaeger 作为后端存储方案，应该如何配置呢？
虽然 Otel 推荐的方案是通过部署 Collector 来进行原始 Otel 的数据接收并处理后传递给 Jaeger 服务，但是考虑到很多业务方目前已经通过 Jaeger Agent 进行了数据采集，因此，在我们本文的演示中，会演示如何通过 Jaeger Agent 来进行相关数据收集。
此外，在跨进程通信时，需要对 Span 上下文信息进行序列化传输，而目前序列化的规范有多种，其中 Jaeger 也有自己的 propagators 的规则，在本文中，我们还将会演示如何配置对应的规则为 Jaeger 规范。

输出 Trace 数据到 Jaeger Agent

首先，我们来看一下如何将全局的 TraceProvider 中的 Exporter 设置为 Jaeger Agent，从而能够将 Trace 数据传递给 Jaeger Agent。

import (
    "context"
    logger "github.com/sirupsen/logrus"
    "go.opentelemetry.io/otel"
    "go.opentelemetry.io/otel/attribute"
    "go.opentelemetry.io/otel/exporters/jaeger"
    "go.opentelemetry.io/otel/sdk/resource"
    sdktrace "go.opentelemetry.io/otel/sdk/trace"
    semconv "go.opentelemetry.io/otel/semconv/v1.7.0"
)
func InitTracerProvider() {
    // 初始化 traceProvider
    var traceProvider *sdktrace.TracerProvider
    // 创建 Jaeger Exporter
    exporter, err := jaeger.New(jaeger.WithAgentEndpoint(jaeger.WithAgentHost("127.0.0.1")))
    if err != nil {
        logger.Errorf("create jaeger client failed: %s", err)
        return
    }
    traceProvider = sdktrace.NewTracerProvider(
        sdktrace.WithSampler(sdktrace.AlwaysSample()),
        // 设置 Jaeger Export 为对应 traceProvider 的 Exporter
        sdktrace.WithBatcher(exporter),
        sdktrace.WithResource(resource.NewWithAttributes(
            semconv.SchemaURL,
            semconv.ServiceNameKey.String("demo"),
        )),
    )
    // 将设置的 traceProvider 设置为全局 traceProvider
    otel.SetTracerProvider(traceProvider)
}

可以看到，将要将 Trace 数据输出到 Jaeger Agent 的核心其实就是需要设置 exporter 为 Jaeger Agent 的 Exporter 即可。

设置 Propagator 模式为 Jaeger

相比配置 Exporter 而言，设置 Propagator 模式就更加简单了，示例代码如下：

import (
    "go.opentelemetry.io/otel"
    jaegerProp "go.opentelemetry.io/contrib/propagators/jaeger"
)
func main() {
     otel.SetTextMapPropagator(jaegerProp.Jaeger{})   
}

可以看到，我们只需要调用 SetTextMapPropagator 函数来设置对应的全局 Propagator 模式即可。