OpenTelemetry Go API 和 SDK 介绍

技术背景

OpenTelemetry-Go 是 OpenTelemetry 的 Go 语言实现。OpenTelemetry 旨在提供一套统一的 API，用于直接测量软件的性能和行为，并将这些数据发送到可观测性平台。它可以帮助开发者更好地了解软件的运行状况，及时发现和解决问题。

实现步骤

1. 兼容性检查

OpenTelemetry-Go 确保与当前受支持的 Go 语言版本兼容。每个主要的 Go 版本在有两个更新的主要版本发布之前都会得到支持。目前，该项目支持的环境包括 Ubuntu、macOS 和 Windows 等不同操作系统和架构。

2. 开始使用

可以在 opentelemetry.io 上找到入门指南。使用 OpenTelemetry-Go 主要有两个步骤：

应用程序插桩（Instrumentation）：要开始从应用程序捕获分布式跟踪和指标事件，首先需要对应用程序进行插桩。最简单的方法是使用官方支持的插桩库。如果需要扩展插桩库提供的遥测功能或直接为应用程序构建自己的插桩，需要使用 Go 的 otel 包。
配置导出器（Export）：应用程序进行插桩以收集遥测数据后，需要一个导出管道将这些遥测数据发送到可观测性平台。OpenTelemetry 项目的所有官方支持的导出器都包含在 exporters 目录中。

核心代码

以下是一个简单的使用 OpenTelemetry-Go 进行插桩和导出的示例代码：

package main

import (
    "context"
    "log"

    "go.opentelemetry.io/otel"
    "go.opentelemetry.io/otel/attribute"
    "go.opentelemetry.io/otel/exporters/stdout/stdouttrace"
    "go.opentelemetry.io/otel/sdk/resource"
    tracesdk "go.opentelemetry.io/otel/sdk/trace"
    semconv "go.opentelemetry.io/otel/semconv/v1.17.0"
)

func initTracer() (*tracesdk.TracerProvider, error) {
    // 创建一个 stdout 导出器
    exp, err := stdouttrace.New(stdouttrace.WithPrettyPrint())
    if err != nil {
        return nil, err
    }

    // 创建资源
    r, err := resource.Merge(
        resource.Default(),
        resource.NewWithAttributes(
            semconv.SchemaURL,
            semconv.ServiceName("my-service"),
            attribute.String("environment", "development"),
        ),
    )
    if err != nil {
        return nil, err
    }

    // 创建 TracerProvider
    tp := tracesdk.NewTracerProvider(
        tracesdk.WithBatcher(exp),
        tracesdk.WithResource(r),
    )
    otel.SetTracerProvider(tp)
    return tp, nil
}

func main() {
    tp, err := initTracer()
    if err != nil {
        log.Fatal(err)
    }
    defer func() {
        if err := tp.Shutdown(context.Background()); err != nil {
            log.Printf("Error shutting down tracer provider: %v", err)
        }
    }()

    // 创建一个 span
    ctx, span := otel.Tracer("example-tracer").Start(context.Background(), "my-span")
    defer span.End()

    // 记录一些事件
    span.AddEvent("Example event", attribute.String("key", "value"))

    // 模拟一些工作
    // ...
}