Managed Service for OpenTelemetry:Go アプリケーションからのトレースデータの送信

ステップ 1: 依存関係のインストール

go get go.opentelemetry.io/otel \
  go.opentelemetry.io/otel/trace \
  go.opentelemetry.io/otel/sdk \
  go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc

ステップ 2: OpenTelemetry SDK の初期化

initProvider 関数は、OTLP gRPC エクスポーターを設定し、リソース属性をセットアップし、グローバルな TracerProvider を登録します。

otelAgentAddr と xtraceToken を、「前提条件」セクションで取得したエンドポイントと認証トークンに置き換えてください。

func initProvider() func() {
    ctx := context.Background()

    otelAgentAddr, xtraceToken, ok := common.ObtainXTraceInfo()

    if !ok {
        log.Fatalf("Cannot init OpenTelemetry, exit")
        os.Exit(-1)
    }

    // OpenTelemetry 向けマネージドサービスの認証ヘッダーを設定します。
    headers := map[string]string{"Authentication": xtraceToken}
    traceClient := otlptracegrpc.NewClient(
        otlptracegrpc.WithInsecure(),
        otlptracegrpc.WithEndpoint(otelAgentAddr),
        otlptracegrpc.WithHeaders(headers),
        otlptracegrpc.WithDialOption(grpc.WithBlock()))
    log.Println("start to connect to server")
    traceExp, err := otlptrace.New(ctx, traceClient)
    handleErr(err, "Failed to create the collector trace exporter")

    res, err := resource.New(ctx,
        resource.WithFromEnv(),
        resource.WithProcess(),
        resource.WithTelemetrySDK(),
        resource.WithHost(),
        resource.WithAttributes(
            // OpenTelemetry 向けマネージドサービスコンソールに表示されるサービス名を設定します。
            semconv.ServiceNameKey.String(common.ServerServiceName),
            semconv.HostNameKey.String(common.ServerServiceHostName),
        ),
    )
    handleErr(err, "failed to create resource")

    bsp := sdktrace.NewBatchSpanProcessor(traceExp)
    tracerProvider := sdktrace.NewTracerProvider(
        sdktrace.WithSampler(sdktrace.AlwaysSample()),
        sdktrace.WithResource(res),
        sdktrace.WithSpanProcessor(bsp),
    )

    // グローバルプロパゲーターを tracecontext に設定します。デフォルトでは、グローバルプロパゲーターは指定されていません。
    otel.SetTextMapPropagator(propagation.TraceContext{})
    otel.SetTracerProvider(tracerProvider)

    return func() {
        cxt, cancel := context.WithTimeout(ctx, time.Second)
        defer cancel()
        if err := traceExp.Shutdown(cxt); err != nil {
            otel.Handle(err)
        }
    }
}

主な設定パラメーター：

ステップ 3: アプリケーションのイベントトラッキング

OpenTelemetry のイベントトラッキングでラップされた HTTP ハンドラを作成します。otelhttp.NewHandler ラッパーは、受信 HTTP リクエストに対して自動的にスパンを作成します。

shutdown := initProvider()
    defer shutdown()

    serverAttribute := attribute.String("server-attribute", "foo")
    fmt.Println("start to gen chars for trace data")
    initTraceDemoData()
    fmt.Println("gen trace data done")
    tracer := otel.Tracer(common.TraceInstrumentationName)

    // HTTP ハンドラを OpenTelemetry のイベントトラッキングでラップします。
    handler := http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
        // 遅延をシミュレートします。
        var sleep int64
        switch modulus := time.Now().Unix() % 5; modulus {
        case 0:
            sleep = rng.Int63n(2000)
        case 1:
            sleep = rng.Int63n(15)
        case 2:
            sleep = rng.Int63n(917)
        case 3:
            sleep = rng.Int63n(87)
        case 4:
            sleep = rng.Int63n(1173)
        }
        ctx := req.Context()
        span := trace.SpanFromContext(ctx)
        span.SetAttributes(serverAttribute)

        actionChild(tracer, ctx, sleep)

        w.Write([]byte("Hello World"))
    })
    wrappedHandler := otelhttp.NewHandler(handler, "/hello")

    http.Handle("/hello", wrappedHandler)
    http.ListenAndServe(":7080", nil)

ステップ 4: 実行と検証

アプリケーションを起動します。

go run main.go

OpenTelemetry 向けマネージドサービスコンソールの [アプリケーション] ページで、アプリケーション名をクリックします。表示されたページで、トレースデータを確認します。

ステップ 1: 依存関係のインストール

go get go.opentelemetry.io/otel \
  go.opentelemetry.io/otel/trace \
  go.opentelemetry.io/otel/sdk \
  go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp

ステップ 2: OpenTelemetry SDK の初期化

Endpoint と URLPath を、「前提条件」セクションで取得したエンドポイントの値に置き換えてください。

func initProvider() func() {
    ctx := context.Background()

    traceClientHttp := otlptracehttp.NewClient(
        otlptracehttp.WithEndpoint("127.0.XX.XX:8080"),                    // ご利用のエンドポイントのホストとポートに置き換えてください。
        otlptracehttp.WithURLPath("/adapt_xxxxx/api/otlp/traces"),         // ご利用のエンドポイントの URL パスに置き換えてください。
        otlptracehttp.WithInsecure())
    otlptracehttp.WithCompression(1)

    traceExp, err := otlptrace.New(ctx, traceClientHttp)
    handleErr(err, "Failed to create the collector trace exporter")

    res, err := resource.New(ctx,
        resource.WithFromEnv(),
        resource.WithProcess(),
        resource.WithTelemetrySDK(),
        resource.WithHost(),
        resource.WithAttributes(
            // OpenTelemetry 向けマネージドサービスコンソールに表示されるサービス名を設定します。
            semconv.ServiceNameKey.String(common.ClientServiceName),
            semconv.HostNameKey.String(common.ClientServiceHostName),
        ),
    )
    handleErr(err, "failed to create resource")

    bsp := sdktrace.NewBatchSpanProcessor(traceExp)
    tracerProvider := sdktrace.NewTracerProvider(
        sdktrace.WithSampler(sdktrace.AlwaysSample()),
        sdktrace.WithResource(res),
        sdktrace.WithSpanProcessor(bsp),
    )

    // グローバルプロパゲーターを tracecontext に設定します。デフォルトでは、グローバルプロパゲーターは指定されていません。
    otel.SetTextMapPropagator(propagation.TraceContext{})
    otel.SetTracerProvider(tracerProvider)

    log.Println("OTEL init success")

    return func() {
        cxt, cancel := context.WithTimeout(ctx, time.Second)
        defer cancel()
        if err := traceExp.Shutdown(cxt); err != nil {
            otel.Handle(err)
        }
    }
}

ステップ 3: アプリケーションのイベントトラッキング

この例では、HTTP ハンドラをラップする代わりに、ループ内で手動でスパンを作成します。各反復処理では、ExecuteRequest という名前のスパンを開始し、makeRequest を呼び出し、サービス境界を越えて伝播するバゲージメンバーをアタッチします。

tracer := otel.Tracer(common.TraceInstrumentationName)

    method, _ := baggage.NewMember("method", "repl")
    client, _ := baggage.NewMember("client", "cli")
    bag, _ := baggage.New(method, client)

    defaultCtx := baggage.ContextWithBaggage(context.Background(), bag)
    for {
        ctx, span := tracer.Start(defaultCtx, "ExecuteRequest")
        makeRequest(ctx)
        span.End()
        time.Sleep(time.Duration(1) * time.Second)
    }

ステップ 4: 実行と検証

アプリケーションを起動します。

go run main.go

OpenTelemetry 向けマネージドサービスコンソールの [アプリケーション] ページで、アプリケーション名をクリックします。表示されたページで、トレースデータを確認します。