OpenTelemetry 在 Go 项目中的集成与使用

运维开发王义杰

发布于 2023-08-10 14:59:58

9230

发布于 2023-08-10 14:59:58

文章被收录于专栏：运维开发王义杰运维开发王义杰

在我们上一篇文章中，我们讨论了OpenTelemetry的核心概念和它为何重要。今天，我们将探讨如何在Go项目中集成OpenTelemetry。

1. 添加依赖

首先，我们需要在项目中添加OpenTelemetry Go的SDK。我们可以使用如下命令来获取它：

go get go.opentelemetry.io/otel

2. 配置 TracerProvider

TracerProvider是用于生成Tracer的对象，Tracer用于创建和处理Span。在程序的初始化阶段，我们需要配置一个全局的TracerProvider。

import (
  "go.opentelemetry.io/otel"
  "go.opentelemetry.io/otel/exporters/stdout/stdouttrace"
  "go.opentelemetry.io/otel/sdk/trace"
)

func main() {
    exporter, err := stdouttrace.New(stdouttrace.WithPrettyPrint())
    if err != nil {
        log.Fatalf("failed to initialize stdouttrace export pipeline: %v", err)
    }

    tp := trace.NewTracerProvider(
        trace.WithBatcher(exporter),
        trace.WithSampler(trace.AlwaysSample()),
    )

    otel.SetTracerProvider(tp)
}

这段代码创建了一个新的TracerProvider，配置了一个向控制台输出结果的exporter，并设置了采样策略为始终采样。

3. 创建和结束Span

在我们的业务代码中，我们可以通过Tracer创建Span，每个Span代表了一个独立的工作单元。当工作单元开始时，我们创建一个Span，并在工作单元结束时结束Span。

import (
  "context"

  "go.opentelemetry.io/otel"
)

func myFunc(ctx context.Context) {
  tracer := otel.Tracer("my-package-name")

  ctx, span := tracer.Start(ctx, "myFunc")
  defer span.End()

  // do some work...
}

这段代码创建了一个新的Span，用于追踪myFunc的执行。当myFunc返回时，通过defer语句确保Span被正确结束。

4. 属性和事件

OpenTelemetry允许我们向Span添加属性（key-value对）和事件。属性用于描述Span的静态属性，而事件则用于描述Span生命周期中发生的特定事件。

span.SetAttributes(attribute.String("key", "value"))

eventRecord := []trace.Event{
  {
    Name: "Nice operation",
    Attributes: []attribute.KeyValue{
      attribute.String("bogons", "42"),
    },
  },
  {
    Name: "Another nice operation",
    Attributes: []attribute.KeyValue{
      attribute.String("bogons", "42"),
    },
  },
}

trace.WithEvent(span, "Nice operation", eventRecord)

5. 上下文传播

在微服务环境中，一个请求可能会跨越多个服务。OpenTelemetry使用context对象来在服务之间传播trace信息。

func doWork(ctx context.Context) {
  // The trace context is automatically propagated via the context object.
  subCtx, subSpan := tracer.Start(ctx, "doWork")
  defer subSpan.End()

  // do some work...
}

在以上代码中，doWork函数接受一个context对象作为参数，这个context对象包含了trace信息。