1. Transaction Manager for Microservices開発者ガイド
  2. トレース

12 トレース

分散トレースを使用して、MicroTxとマイクロサービスの間でのリクエストのフローを理解します。KialiやJaegerなどのツールを使用して、MicroTxの分散トランザクションを追跡およびトレースします。

Istioは、サービス間通信を処理するために個別のインフラストラクチャ・レイヤーを提供するサービス・メッシュです。ネットワーク通信がサービスそのものから取り出されて、プロキシによって処理されます。Istioではサイドカー設計が使用されています。つまり、通信プロキシは各サービス・コンテナ外部の独自のコンテナ内で実行されます。Envoyは、マイクロサービス・コンテナ内にサイドカーとしてデプロイされるプロキシです。サービス・メッシュ内のすべての通信は、Envoyプロキシを介して行われます。Envoyプロキシでは、プロキシ対象のマイクロサービスにかわってトレース・スパンが自動的に生成され、サービスは適切なリクエスト・コンテキストを転送することだけが求められます。https://istio.io/latest/docs/concepts/observability/を参照してください。Istioでは、Zipkin、Jaeger、Lightstep、Datadogなど、多くのトレース・バックエンドがサポートされます。

ノート:

この項で説明するステップは、MicroTxおよびIstioがKubernetesクラスタにデプロイされた環境に固有です。この項で説明する手順は、テスト環境や開発環境のみで使用してください。これらの手順は本番環境向けではありません。

詳細は、KialiとJaegerのドキュメントを参照してください。

  • Jaegerのインストール
    ダウンロードしたIstioインストール・バンドルには、Jaegerをすぐに起動して実行するために基本のサンプル・インストールとしてjaeger.yamlが含まれています。jaeger.yamlファイルは、Istioインストール・ファイルをダウンロードした場所のsamples/addonsフォルダにあります。
  • Jaegerを使用した分散トレースの実行
  • Kialiのインストール
    ダウンロードしたIstioインストール・バンドルには、Kialiをすぐに起動して実行するために基本のサンプル・インストールとしてkiali.yamlが含まれています。kiali.yamlファイルは、Istioインストール・ファイルをダウンロードした場所のsamples/addonフォルダにあります。
  • トレース・ヘッダーのリスト
    トランザクションを全面的にトレースする場合は、oracle.tmm.PropagateTraceHeadersをtrueに設定します。これにより、すべての受信リクエストおよび送信リクエストのトレース・ヘッダーが伝播されます。

12.1 Jaegerのインストール

ダウンロードしたIstioインストール・バンドルには、Jaegerをすぐに起動して実行するために基本のサンプル・インストールとしてjaeger.yamlが含まれています。jaeger.yamlファイルは、Istioインストール・ファイルをダウンロードした場所のsamples/addonsフォルダにあります。

または、Jaegerを別途インストールします。https://istio.io/latest/docs/ops/integrations/jaeger/を参照してください。

Istioパッケージ・ディレクトリにあるYAMLファイルを使用してJaegerをインストールするには:
  1. Istioパッケージのディレクトリに移動します。たとえば、パッケージがistio-1.15.0の場合:
    cd istio-1.15.0
  2. Jaegerをインストールします。
    kubectl apply -f samples/addons/jaeger.yaml

    サンプル・レスポンス

    deployment.apps/jaeger created
service/tracing created
service/zipkin created
service/jaeger-collector created
  3. 次のコマンドを実行して、Jaegerがインストールされたことを確認します。
    kubectl get all -n istio-system

    サンプル・レスポンス

    NAME                                        READY   STATUS    RESTARTS   AGE
pod/istio-ingressgateway-6cc856bd7d-qcwk7   1/1     Running   0          10d
pod/istiod-945b9f699-frff5                  1/1     Running   0          10d
pod/jaeger-c4fdf6674-wqxhb                  1/1     Running   0          11m

NAME                           TYPE           CLUSTER-IP   EXTERNAL-IP   PORT(S)                                      AGE
service/istio-ingressgateway   LoadBalancer   10.97...     <pending>     15021:30651/TCP,80:31635/TCP,443:32196/TCP   10d
service/istiod                 ClusterIP      10.100...    <none>        15010/TCP,15012/TCP,443/TCP,15014/TCP        10d
service/jaeger-collector       ClusterIP      10.110...    <none>        14268/TCP,14250/TCP,9411/TCP                 11m
service/tracing                ClusterIP      10.107...    <none>        80/TCP,16685/TCP                             11m
service/zipkin                 ClusterIP      10.106...    <none>        9411/TCP                                     11m

NAME                                   READY   UP-TO-DATE   AVAILABLE   AGE
deployment.apps/istio-ingressgateway   1/1     1            1           10d
deployment.apps/istiod                 1/1     1            1           10d
deployment.apps/jaeger                 1/1     1            1           11m

NAME                                              DESIRED   CURRENT   READY   AGE
replicaset.apps/istio-ingressgateway-6cc856bd7d   1         1         1       10d
replicaset.apps/istiod-945b9f699                  1         1         1       10d
replicaset.apps/jaeger-c4fdf6674                  1         1         1       11m

NAME                                                       REFERENCE                         TARGETS         MINPODS   MAXPODS   REPLICAS   AGE
horizontalpodautoscaler.autoscaling/istio-ingressgateway   Deployment/istio-ingressgateway   <unknown>/80%   1         5         1          10d
horizontalpodautoscaler.autoscaling/istiod                 Deployment/istiod                 <unknown>/80%   1         5         1          10d

親トピック: トレース

12.2 Jaegerを使用した分散トレースの実行

Jaegerを使用して分散トレースを実行する方法を理解するために、XAのサンプル・アプリケーションについて考えてみましょう。

サンプル・アプリケーションによって実装されるシナリオでは、口座部門アプリケーションがXAトランザクションを作成して部門から部門に送金します。組織内の2つの部門は、部門1と部門2です。インストール・バンドルで提供されているサンプルXAアプリケーションの詳細は、「XAトランザクション・プロトコル」を参照してください。

分散トレースを実行する前に、アプリケーションをデプロイし、トランザクションを開始していることを確認してください。
  1. istioctlを使用してJaeger UIを開きます。 
    istioctl dashboard jaeger
  2. アプリケーションを使用してトランザクションを実行します。
    サンプルXAアプリケーションの場合は、口座サービスを使用して、部門1から一定金額を引き出し、その金額を部門2に預け入れます。
  3. Jaeger UIで、「Search」タブをクリックします。
  4. 「Service」 ドロップダウン・リストで「istio-ingressgateway」を選択します。
  5. 「Find Traces」をクリックし、タイムスタンプが数秒前のトレースを探します。
    サンプルXAアプリケーションを使用した最新のトランザクションのトレースが、次の図のように表示されます。
    トレース
  6. トレースをクリックすると、詳細を確認できます。
  7. 「Service」および「Operation」の下で、すべてのリクエストのフローを確認します。

    Istioイングレス・ゲートウェイは、リクエストを受け取り、それをイニシエータ・サービスである口座サービスに転送します。口座サービスから、トランザクションを開始するためのコールがTCSに送信されました。

親トピック: トレース

12.3 Kialiのインストール

ダウンロードしたIstioインストール・バンドルには、Kialiをすぐに起動して実行するために基本のサンプル・インストールとしてkiali.yamlが含まれています。kiali.yamlファイルは、Istioインストール・ファイルをダウンロードした場所のsamples/addonフォルダにあります。

または、Kialiを別途インストールします。https://kiali.io/docs/installation/を参照してください。

Istioパッケージ・ディレクトリにあるYAMLファイルを使用してKialiをインストールするには:
  1. Istioパッケージのディレクトリに移動します。たとえば、パッケージがistio-1.15.0の場合:
    cd istio-1.15.0
  2. Kialiをインストールします。
    kubectl apply -f samples/addons/kiali.yaml

    サンプル・レスポンス

    serviceaccount/kiali created
configmap/kiali created
clusterrole.rbac.authorization.k8s.io/kiali-viewer created
clusterrole.rbac.authorization.k8s.io/kiali created
clusterrolebinding.rbac.authorization.k8s.io/kiali created
role.rbac.authorization.k8s.io/kiali-controlplane created
rolebinding.rbac.authorization.k8s.io/kiali-controlplane created
service/kiali created
deployment.apps/kiali created
  3. 次のコマンドを実行して、Kialiがインストールされたことを確認します。
    kubectl -n istio-system get svc kiali

    サンプル・レスポンス

    NAME    TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)              AGE
kiali   ClusterIP   10.100.214.26   <none>        20001/TCP,9090/TCP   62s
  4. Kialiダッシュボードを開きます。
    istioctl dashboard kiali

親トピック: トレース

12.4 トレース・ヘッダーのリスト

トランザクションを全面的にトレースする場合は、oracle.tmm.PropagateTraceHeadersをtrueに設定します。これにより、すべての受信リクエストおよび送信リクエストのトレース・ヘッダーが伝播されます。

次の表に示すのは、伝播されるトレース・ヘッダーの一部です。

ヘッダーの名前 説明 
x-request-id
 すべてのアプリケーションがこのヘッダーを伝播する必要があります。このヘッダーはアクセス・ログ文に含まれ、Istioでの一貫性のあるトレース・サンプリングおよびログ・サンプリングの決定に使用されます。 
oracle-tmm-tx-token
authorization
refresh-token
oracle-tmm-authz-token
 これらのMicroTx固有のヘッダーは、ライブラリからMicroTx APIコールを実行するために伝播する必要があります。 
end-user
 このヘッダーはアプリケーションに固有です。このヘッダーは転送できます。 
x-ot-span-context
 IstioでLightstepトレースを使用している場合は、このヘッダーを伝播します。https://istio.io/latest/docs/tasks/observability/distributed-tracing/lightstep/を参照してください。 
x-datadog-trace-id
x-datadog-parent-id
x-datadog-sampling-priority
 Datadogトレースを使用している場合は、これらのヘッダーを伝播します。 
traceparent
tracestate
 これらは、W3Cトレース・コンテキスト・ヘッダーです。これらは、IstioのOpenCensusエージェントおよびStackdriver構成と互換性があります。 
x-cloud-trace-context
 Cloud Traceコンテキスト・ヘッダーです。これは、IstioのOpenCensus AgentおよびStackdriverの構成と互換性があります。 
grpc-trace-bin
 これはgRPCライブラリ・トレース・コンテキスト・ヘッダーです。これは、IstioのOpenCensus AgentおよびStackdriverの構成と互換性があります。 

x-b3-traceid
x-b3-spanid
x-b3-parentspanid
x-b3-sampled
x-b3-flags
 これらは、B3トレース・コンテキスト・ヘッダーです。これらは、IstioのZipkin、OpenCensus AgentおよびStackdriverの構成と互換性があります。

親トピック: トレース