Linkerd 2.10 (ステップバイステップ) - Linkerd による分散トレース

[[406175]]

Linkerd 2.10 の中国語マニュアルは継続的に改訂および更新されています。

https://linkerd.hacker-linner.com

分散トレースを実際に使用すると複雑になる可能性があるため、何が得られるか、どのように行われるかを大まかに説明するために、誤解のリストをまとめました。

このガイドでは、EmojiVoto の追跡の設定と有効化について説明します。 Linkerd で分散トレースを使用する最適な方法に関するアドバイスについては、最後まで読んでください。

分散トレースを使用するには、次のものが必要です。

Linkerd-Jaeger 拡張機能をインストールします。
スパンを発行するようにアプリケーションを変更します。

emojivoto の場合、これらの手順をすべて完了すると、次のようなトポロジが作成されます。

前提条件

このガイドを使用するには、クラスターに Linkerd がインストールされている必要があります。まだ行っていない場合は、Linkerd のインストールガイドに従ってください。

Linkerd-Jaeger拡張機能をインストールする

分散トレースをセットアップするための最初のステップは、クラスターに Linkerd-Jaeger 拡張機能をインストールすることです。拡張機能は、コレクター、Jaeger バックエンド、および Jaeger インジェクターで構成されます。コレクターは、グリッドとアプリケーションから発行されたスパンを消費し、それらを Jaeger バックエンドに送信します。Jaeger バックエンドはそれらを保存し、それらを表示するためのダッシュボードを提供します。 Jaeger-injector は、スパンを発行するように Linkerd プロキシを構成する役割を担います。

Linkerd-Jaeger 拡張機能をインストールするには、次のコマンドを実行します。

 linkerd jaeger インストール | kubectl を適用 -f -

次のコマンドを実行すると、Linkerd-Jaeger 拡張機能が正しくインストールされたことを確認できます。

リンカード・イェーガーチェック

Emojivotoをインストールする

emojivoto をクラスターに追加し、Linkerd プロキシを使用して挿入します。

リンカードインジェクト https://run.linkerd.io/emojivoto.yml | kubectl を適用 -f -

次のステップに進む前に、kubectl を使用して次のコマンドを実行し、すべてが稼働していることを確認します。

 kubectl -n emojivoto ロールアウトステータス deploy/web

アプリケーションを変更する

サービスメッシュのほとんどの機能とは異なり、分散トレースではアプリケーションのソースを変更する必要があります。トレースには、受信リクエストをアプリケーションに、送信リクエストを関連サービスに結び付ける何らかの方法が必要です。これを行うには、追跡用の一意の ID を含むいくつかのヘッダーが各リクエストに追加されます。 Linkerd は、b3 伝播形式を使用してこれらを結び付けます。

この情報を使用してリクエストを検出するように emojivoto を変更しました。このコミットでは、これがどのように行われるかを示します。ほとんどのプログラミング言語では、これを処理するためにクライアントライブラリを追加するだけで済みます。 Emojivoto は OpenCensus クライアントを使用しますが、他のクライアントも使用できます。

emojivoto で追跡を有効にするには、次を実行します。

 kubectl -n emojivotoでenv --all をデプロイし、OC_AGENT_HOST=collector.linkerd-jaeger:55678 を設定します。

このコマンドは、アプリケーションがコンテキストを伝播してスパンを出力できるようにする環境変数を追加します。

イェーガーを探索

vote-bot が各リクエストのトレースを開始すると、Jaeger にスパンが表示されるようになります。 UI に入るには、次を実行します。

 linkerd jaeger ダッシュボード

ドロップダウンリストで任意のサービスを検索し、「トレースの検索」をクリックできます。投票ボットは始めるのに最適な方法です。

特定のトレースをクリックすると、すべての詳細が表示され、各エージェントの範囲を確認できます。

この出力には確かに多くの linkerd-proxy スパンが含まれています。内部的には、プロキシにはサーバー側とクライアント側があります。リクエストがプロキシを通過すると、サーバーによって受信され、クライアントによって送信されます。 2 つのメッシュポッド間で渡される単一のリクエストの場合、合計 4 つのスパンが存在します。リクエストがそのプロキシを通過すると、ソース側に 2 つ存在し、リモートプロキシがリクエストを受信すると、宛先側に 2 つ存在します。

さらに、エージェントはアプリケーションメタデータをトレース属性として追加するため、ユーザーは、以下に示すように、メトリックテーブル内の Jaeger アイコンをクリックして、linkerd-web ダッシュボードから関連するリソーストレースに直接ジャンプできます。

クリーニング

クリーンアップするには、次のコマンドを実行して Linkerd-Jaeger 拡張機能と emojivoto をアンインストールします。

 linkerd jaeger アンインストール | kubectl削除-f -
 kubectl削除ns emojivoto

自分のイェーガーを持ってきてください

既存の Jaeger インストールがある場合は、Linkerd-Jaeger 拡張機能に組み込まれている Jaeger インスタンスではなく、そのインスタンスにトレースを送信するように OpenCensus コレクターを設定できます。

 linkerd jaeger をインストール--set collector.jaegerAddr='http://my-jaeger-collector.my-jaeger-ns:14268/api/traces' | kubectl を適用 -f -

OpenCensus の設定を手動で編集して、サポートされている任意のバックエンドにエクスポートすることもできます。完全なリストについては、OpenCensus のドキュメントを参照してください。

トラブルシューティング

プロキシのスパンが表示されません

Linkerd プロキシは b3 伝播形式を使用します。 Jaeger などの一部のクライアントライブラリでは、デフォルトで異なる形式が使用されます。エージェントがトレースに参加するには、b3 形式を使用するようにクライアントライブラリを構成する必要があります。

提案

イングレス

イングレスは、各トレースのルートスパンを作成し、そのトレースをサンプリングするかどうかを決定する役割を担うため、分散トレースの特に重要なコンポーネントです。イングレスがすべてのサンプリング決定を行うことで、トレース全体がサンプリングされるかサンプリングされないかが保証され、「部分的なトレース」の作成が回避されます。

分散トレースシステムはすべて、受信したリクエストから送信したリクエストまでの現在のトレースに関するメタデータを伝播するサービスに依存しています。このメタデータはトレースコンテキストと呼ばれ、通常は 1 つ以上のリクエストヘッダーにエンコードされます。トレースコンテキストヘッダー形式にはさまざまなものがあり、エコシステムが最終的には W3C トレースコンテキストのようなオープンスタンダードに収束することを期待していますが、現時点では b3 形式のみを使用します。最も古くから広く使用されている形式の 1 つとして、特に Nginx などのポータルで最も広くサポートされています。

このリファレンスアーキテクチャには、トレースの 50% をサンプリングし、トレースデータをコレクターに送信する (Zipkin プロトコルを使用) シンプルな Nginx 構成が含まれています。ここでは、Nginx の代わりに任意の Ingress コントローラーを使用できます。ただし、次の条件を満たす必要があります。

確率的サンプリングをサポート
トレースコンテキストをb3形式でエンコードします
OpenCensusコレクターがサポートするプロトコルでスパンを発行する

helm を使用して ingress-nginx をインストールした場合は、次のコマンドでトレースを設定できます。

コントローラ：
  設定:
    オープントレースを有効にする: "true"  
    zipkin-collector-ホスト: linkerd-collector.linkerd

クライアントライブラリ

サービスはトレース伝播ヘッダーを手動で伝播することもできますが、多くの場合、次の 3 つのことを実行するライブラリを使用する方がはるかに簡単です。

受信リクエストヘッダーから送信リクエストヘッダーにトレースコンテキストを伝播する
トレースコンテキストを変更する（つまり、新しいスパンを開始する）
このデータをトレースコレクターに転送する

OpenCensus を使用してサービス内で設定することをお勧めします。

b3 伝播（これがデフォルト設定です）
OpenCensus エージェントエクスポーター

OpenCensus エージェントエクスポータは、gRPC API を介してトレースデータを OpenCensus コレクターにエクスポートします。 OpenCensus を構成する方法の詳細は言語によって異なりますが、多くの一般的な言語のガイドがあります。サンプルアプリケーション Emojivoto を使用して、Go でのエンドツーエンドの例を確認することもできます。

OpenCensus プロジェクトはメンテナンスモードになっており、OpenTelemetry の一部となることにお気づきかもしれません。残念ながら、OpenTelemetry はまだ本番環境での使用には対応していないため、現在のところ OpenCensus が推奨されています。

他にも多くのトレースクライアントライブラリが利用可能です。 b3 伝播形式を使用していること、およびクライアントライブラリがコレクターが受信するように構成されている形式でスパンをエクスポートできることを確認してください。

コレクター: OpenCensus

OpenCensus コレクターは、OpenCensus エージェントエクスポーターからトレースデータを受信し、データを Jaeger に送信する前に変換およびフィルタリングする場合があります。 OpenCensus エクスポーターを OpenCensus コレクターに送信すると、柔軟性が大幅に向上します。アプリケーションを中断することなく、OpenCensus でサポートされている任意のバックエンドに切り替えることができます。