Application Real-Time Monitoring Service:Zipkin を使用した Go アプリケーションからのトレースデータのレポート

依存関係の追加

Zipkin Go ライブラリとルーターをプロジェクトに追加します。

[[constraint]]
  name = "github.com/openzipkin/zipkin-go"
  version = "0.1.1"

[[constraint]]
  name = "github.com/gorilla/mux"
  version = "1.6.2"

トレーサーの作成

トレーサーは、分散操作のタイミングとメタデータを記録するスパンを生成します。レポート用のエンドポイント、ローカルサービスの ID、サンプリング戦略を設定します。

func getTracer(serviceName string, ip string) *zipkin.Tracer {
    // スパンを Zipkin エンドポイントに送信するレポーターを作成します。
    // URL をコンソールから取得した実際のエンドポイントに置き換えます。
    reporter := httpreporter.NewReporter("http://tracing-analysis-dc-hz.aliyuncs.com/adapt_aokcdqnxyz@123456ff_abcdef123@abcdef123/api/v2/spans")

    // スパンがこのサービスの ID でタグ付けされるように、ローカルエンドポイントを設定します。
    endpoint, _ := zipkin.NewEndpoint(serviceName, ip)

    // すべてのリクエストをサンプリングします。モジュロ値を大きくするとサンプリングが減り、レポートコストが削減されます (例: NewModuloSampler(10) は 10 件に 1 件をサンプリングします)。
    sampler := zipkin.NewModuloSampler(1)

    // レポーター、エンドポイント、サンプラーでトレーサーを初期化します。
    tracer, _ := zipkin.NewTracer(
        reporter,
        zipkin.WithLocalEndpoint(endpoint),
        zipkin.WithSampler(sampler),
    )
    return tracer
}

スパンの作成

ルートスパンは、リクエストのトップレベルの操作を記録します。

span := tracer.StartSpan("some_operation")
// ... 操作を実行 ...
span.Finish()

リクエスト内のサブ操作を追跡するには、親コンテキストを渡して子スパンを作成します。

childSpan := tracer.StartSpan("some_operation2", zipkin.Parent(span.Context()))
// ... サブ操作を実行 ...
childSpan.Finish()

カスタムタグとアノテーションの追加 (任意)

タグは、フィルタリングやデバッグのために、キーと値のメタデータをスパンにアタッチします。たとえば、HTTP ステータスコードを記録します。

childSpan.Tag("http.status_code", statusCode)

アノテーションは、スパン内のタイムスタンプ付きイベントを記録します。これらを使用して、スタックトレース付きのエラーをログに記録します。

childSpan := tracer.StartSpan("some_operation2", zipkin.Parent(span.Context()))
// ... 操作を実行 ...

var events = make(map[string]string)
events["event"] = "error"
events["stack"] = "Runtime Exception: unable to find userid"
jsonStr, err := json.Marshal(events)
if err == nil {
    childSpan.Annotate(time.Now(), string(jsonStr))
}
childSpan.Finish()

サービス間でのコンテキストの伝播

トレースコンテキスト (TraceId、ParentSpanId、SpanId、Sampled) は、各リモートプロシージャコール (RPC) と共に渡される必要があります。これにより、異なるサービスからのスパンが単一のトレースにリンクされます。Zipkin は B3 ヘッダーを使用して、HTTP および gRPC 経由でコンテキストを伝播します。

クライアント側: 送信リクエストにコンテキストを挿入

req, _ := http.NewRequest("GET", "/", nil)

// トレースコンテキストを B3 ヘッダーとして HTTP リクエストに挿入します。
injector := b3.InjectHTTP(req)
injector(sp.Context())

サーバー側: 受信リクエストからコンテキストを抽出

req, _ := http.NewRequest("GET", "/", nil)
b3.InjectHTTP(req)(sp.Context())

b.ResetTimer()
_ = b3.ExtractHTTP(copyRequest(req))

イベントトラッキング後のデータなし

アプリケーションからのエラー出力を確認してください。

• failed the request with status code 403: ユーザー名またはパスワードが無効です。[アクセスポイント情報] タブから、認証セグメントを含む完全なエンドポイントをコピーしてください。

• エラーはないがデータがない: エンドポイント URL にプロトコル (http:// または https://) と、/api/v2/spans で終わる完全なパスが含まれていることを確認してください。また、ご利用のネットワークがエンドポイントへのアウトバウンド接続を許可していることも確認してください。

• サンプリング設定: NewModuloSampler の値が 1 より大きい場合、リクエストの一部のみがサンプリングされます。テスト中は、すべてのリクエストをキャプチャするために値を 1 に設定してください。