分散トレース

手順

1. cluster-admin ロールを持つユーザーとして OpenShift Container Platform Web コンソールにログインします。(Red Hat OpenShift Dedicated を使用する場合) dedicated-admin ロールがあるアカウント。
2. Operators → OperatorHub に移動します。
3. Elasticsearch とフィルターボックスに入力して、OpenShift Elasticsearch Operator を検索します。
4. Red Hat が提供する OpenShift Elasticsearch Operator をクリックし、Operator に関する情報を表示します。
5. Install をクリックします。
6. Install Operator ページで、stable 更新チャネルを選択します。これにより、新しいバージョンがリリースされると Operator が自動的に更新されます。

7. デフォルトの All namespaces on the cluster (default) を受け入れます。これにより、Operator がデフォルトの openshift-operators-redhat プロジェクトにインストールされ、Operator はクラスター内のすべてのプロジェクトで利用可能になります。

   注記

   Elasticsearch インストールでは、 Elasticsearch Operator に openshift-operators-redhat namespace が必要です。他の Red Hat OpenShift distributed tracing platform Operators は、openshift-operators namespace にインストールされます。

8. デフォルトの Automatic 承認ストラテジーを受け入れます。デフォルトを受け入れることで、Operator の新規バージョンが利用可能になると、Operator Lifecycle Manager (OLM) は人の介入なしに、Operator の実行中のインスタンスを自動的にアップグレードします。手動 更新を選択する場合は、Operator の新規バージョンが利用可能になると、OLM は更新要求を作成します。クラスター管理者は、Operator が新規バージョンに更新されるように更新要求を手動で承認する必要があります。

   注記

   手動 の承認ストラテジーには、Operator のインストールおよびサブスクリプションプロセスを承認するための適切な認証情報を持つユーザーが必要です。

9. Install をクリックします。
10. Installed Operators ページで、openshift-operators-redhat プロジェクトを選択します。OpenShift Elasticsearch Operator が InstallSucceeded のステータスを表示するまで待機してから続行します。

手順

1. cluster-admin ロールを持つユーザーとして OpenShift Container Platform Web コンソールにログインします。(Red Hat OpenShift Dedicated を使用する場合) dedicated-admin ロールがあるアカウント。
2. Operators → OperatorHub に移動します。
3. フィルターに distributed tracing platform と入力して、Red Hat OpenShift distributed tracing platform (Jaeger) Operator を探します。
4. Red Hat が提供する Red Hat OpenShift distributed tracing platform (Jaeger) Operator をクリックし、Operator に関する情報を表示します。
5. Install をクリックします。
6. Install Operator ページで、stable 更新チャネルを選択します。これにより、新しいバージョンがリリースされると Operator が自動的に更新されます。

7. デフォルトの All namespaces on the cluster (default) を受け入れます。これにより、Operator がデフォルトの openshift-operators プロジェクトにインストールされ、Operator はクラスター内のすべてのプロジェクトで利用可能になります。

   • デフォルトの Automatic 承認ストラテジーを受け入れます。デフォルトを受け入れることで、Operator の新規バージョンが利用可能になると、Operator Lifecycle Manager (OLM) は人の介入なしに、Operator の実行中のインスタンスを自動的にアップグレードします。手動 更新を選択する場合は、Operator の新規バージョンが利用可能になると、OLM は更新要求を作成します。クラスター管理者は、Operator が新規バージョンに更新されるように更新要求を手動で承認する必要があります。

     注記

     手動 の承認ストラテジーには、Operator のインストールおよびサブスクリプションプロセスを承認するための適切な認証情報を持つユーザーが必要です。

8. Install をクリックします。
9. Operators → Installed Operators に移動します。
10. Installed Operators ページで、openshift-operators プロジェクトを選択します。Red Hat OpenShift 分散トレースプラットフォーム (Jaeger) Operator が Succeeded のステータスを表示するまで待機してから続行します。

手順

1. cluster-admin ロールを持つユーザーとして OpenShift Container Platform Web コンソールにログインします。

2. 新規プロジェクト (例: tracing-system) を作成します。

   注記

   サービスメッシュの一部としてインストールする場合、distributed tracing platform リソースは、istio-system など、ServiceMeshControlPlane リソースと同じ namespace にインストールする必要があります。

   1. Home → Projects に移動します。
   2. Create Project をクリックします。
   3. Name フィールドに tracing-system を入力します。
   4. Create をクリックします。
3. Operators → Installed Operators に移動します。
4. 必要な場合は、Project メニューから tracing-system を選択します。Operator が新規プロジェクトにコピーされるまでに数分待機が必要な場合があります。
5. Red Hat OpenShift distributed tracing platform (Jaeger) Operator をクリックします。Details タブの Provided APIs で、Operator は単一リンクを提供します。
6. Jaeger で、Create Instance をクリックします。
7. Create Jaeger ページで、デフォルトを使用してインストールするには、 Create をクリックして distributed tracing platform (Jaeger) インスタンスを作成します。
8. Jaegers ページで、distributed tracing platform (Jaeger) インスタンスの名前 (例: jaeger-all-in-one-inmemory) をクリックします。
9. Jaeger Details ページで、Resources タブをクリックします。Pod のステータスが Running になるまで待機してから続行します。

手順

1. cluster-admin ロールを持つユーザーとして OpenShift Container Platform Web コンソールにログインします。

2. 新規プロジェクト (例: tracing-system) を作成します。

   注記

   サービスメッシュの一部としてインストールする場合、distributed tracing platform リソースは、istio-system など、ServiceMeshControlPlane リソースと同じ namespace にインストールする必要があります。

   1. Home → Projects に移動します。
   2. Create Project をクリックします。
   3. Name フィールドに tracing-system を入力します。
   4. Create をクリックします。
3. Operators → Installed Operators に移動します。
4. 必要な場合は、Project メニューから tracing-system を選択します。Operator が新規プロジェクトにコピーされるまでに数分待機が必要な場合があります。
5. Red Hat OpenShift distributed tracing platform (Jaeger) Operator をクリックします。Overview タブの Provided APIs で、Operator は単一リンクを提供します。
6. Jaeger で、Create Instance をクリックします。

7. Create Jaeger ページで、デフォルトの all-in-one YAML テキストを実稼働用の YAML 設定に置き換えます。以下は例になります。

   Elasticsearch を含む jaeger-production.yaml ファイルの例

   apiVersion: jaegertracing.io/v1
   kind: Jaeger
   metadata:
     name: jaeger-production
     namespace:
   spec:
     strategy: production
     ingress:
       security: oauth-proxy
     storage:
       type: elasticsearch
       elasticsearch:
         nodeCount: 3
         redundancyPolicy: SingleRedundancy
       esIndexCleaner:
         enabled: true
         numberOfDays: 7
         schedule: 55 23 * * *
       esRollover:
         schedule: '*/30 * * * *'

8. Create をクリックして distributed tracing platform (Jaeger) インスタンスを作成します。
9. Jaegers ページで、distributed tracing platform (Jaeger) インスタンスの名前 (例: jaeger-prod-elasticsearch) をクリックします。
10. Jaeger Details ページで、Resources タブをクリックします。すべての Pod のステータスが Running になるまで待機してから続行します。

手順

1. cluster-admin ロールを持つユーザーとして OpenShift Container Platform Web コンソールにログインします。

2. 新規プロジェクト (例: tracing-system) を作成します。

   注記

   サービスメッシュの一部としてインストールする場合、distributed tracing platform リソースは、istio-system など、ServiceMeshControlPlane リソースと同じ namespace にインストールする必要があります。

   1. Home → Projects に移動します。
   2. Create Project をクリックします。
   3. Name フィールドに tracing-system を入力します。
   4. Create をクリックします。
3. Operators → Installed Operators に移動します。
4. 必要な場合は、Project メニューから tracing-system を選択します。Operator が新規プロジェクトにコピーされるまでに数分待機が必要な場合があります。
5. Red Hat OpenShift distributed tracing platform (Jaeger) Operator をクリックします。Overview タブの Provided APIs で、Operator は単一リンクを提供します。
6. Jaeger で、Create Instance をクリックします。

7. Create Jaeger ページで、デフォルトの all-in-one YAML テキストをストリーミング用の YAML 設定に置き換えます。以下は例になります。

   例: jaeger-streaming.yaml ファイル

   apiVersion: jaegertracing.io/v1
   kind: Jaeger
   metadata:
     name: jaeger-streaming
   spec:
     strategy: streaming
     collector:
       options:
         kafka:
           producer:
             topic: jaeger-spans
             brokers: my-cluster-kafka-brokers.kafka:9092 1
     storage:
       type: elasticsearch
     ingester:
       options:
         kafka:
           consumer:
             topic: jaeger-spans
             brokers: my-cluster-kafka-brokers.kafka:9092

   1

   ブローカーが定義されていない場合、AMQStreams 1.4.0 以降は Kafka をセルフプロビジョニングします。

8. Create をクリックして distributed tracing platform (Jaeger) インスタンスを作成します。
9. Jaegers ページで、distributed tracing platform (Jaeger) インスタンスの名前 (例: jaeger-streaming) をクリックします。
10. Jaeger Details ページで、Resources タブをクリックします。すべての Pod のステータスが Running になるまで待機してから続行します。

手順

1. OpenShift Container Platform Web コンソールにログインします。
2. Operators → Installed Operators に移動します。
3. Project メニューから Operator がインストールされているプロジェクトの名前 (例: openshift-operators) を選択します。
4. Red Hat OpenShift distributed tracing platform (Jaeger) Operator をクリックします。
5. Jaeger タブをクリックします。
6. 削除するインスタンスの横にある Options メニュー をクリックし、Delete Jaeger を選択します。
7. 確認ウィンドウで Delete をクリックします。

手順

1. 以下のコマンドを実行して、OpenShift CLI (oc) でログインします。

   $ oc login --username=<NAMEOFUSER>

2. 以下のコマンドを実行して、distributed tracing platform (Jaeger) インスタンスを表示します。

   $ oc get deployments -n <jaeger-project>

   以下に例を示します。

   $ oc get deployments -n openshift-operators

   Operator の名前には、接尾辞の -operator が付きます。以下の例は、2 つの Red Hat OpenShift distributed tracing platform (Jaeger) Operator と 4 つの distributed tracing platform (Jaeger) インスタンスを示しています。

   $ oc get deployments -n openshift-operators

   以下のような出力が表示されます。

   NAME                     READY   UP-TO-DATE   AVAILABLE   AGE
   elasticsearch-operator   1/1     1            1           93m
   jaeger-operator          1/1     1            1           49m
   jaeger-test              1/1     1            1           7m23s
   jaeger-test2             1/1     1            1           6m48s
   tracing1                 1/1     1            1           7m8s
   tracing2                 1/1     1            1           35m

3. distributed tracing platform (Jaeger) のインスタンスを削除するには、以下のコマンドを実行します。

   $ oc delete jaeger <deployment-name> -n <jaeger-project>

   以下に例を示します。

   $ oc delete jaeger tracing2 -n openshift-operators

4. 削除を確認するには、oc get deployments コマンドを再度実行します。

   $ oc get deployments -n <jaeger-project>

   以下に例を示します。

   $ oc get deployments -n openshift-operators

   以下の例のような出力が生成され、表示されます。

   NAME                     READY   UP-TO-DATE   AVAILABLE   AGE
   elasticsearch-operator   1/1     1            1           94m
   jaeger-operator          1/1     1            1           50m
   jaeger-test              1/1     1            1           8m14s
   jaeger-test2             1/1     1            1           7m39s
   tracing1                 1/1     1            1           7m59s

手順

1. クラスターからの Operator の削除 に記載された手順に従って、Red Hat OpenShift distributed tracing platform (Jaeger) Operator を削除します。
2. オプション: Red Hat OpenShift distributed tracing platform (Jaeger) Operator を削除してから、OpenShift Elasticsearch Operator を削除します。

手順

1. Tempo Operator をインストールします。

   1. Operators → OperatorHub に移動し、Tempo Operator を検索します。

   2. OpenShift Operator for Tempo → Install → Install → View Operator で、Tempo Operator を選択します。

      重要

      デフォルトのプリセットで Operator がインストールされます。

      • Update channel → stable
      • Installation mode → All namespaces on the cluster
      • Installed Namespace → openshift-tempo-operator
      • Update approval → Automatic
   3. インストール済み Operator ページの Details タブの ClusterServiceVersion details で、インストールの Status が Succeeded であることを確認します。
2. Home → Projects → Create Project に移動し、次の手順で作成する TempoStack インスタンスのプロジェクトを作成します。

3. TempoStack インスタンス用に作成したプロジェクトで、オブジェクトストレージバケットのシークレットを作成します。Workloads → Secrets → Create → From YAML に移動します。

   Amazon S3 および MinIO ストレージのシークレット例

   apiVersion: v1
   kind: Secret
   metadata:
     name: minio-test
   stringData:
     endpoint: http://minio.minio.svc:9000
     bucket: tempo
     access_key_id: tempo
     access_key_secret: <secret>
   type: Opaque

4. TempoStack インスタンスを作成します。

   注記

   同じクラスター上の別々のプロジェクトに、複数の TempoStack インスタンスを作成できます。

   1. Operators → Installed Operators に移動します。
   2. TempoStack → Create TempoStack → YAML view の順に選択します。

   3. YAML view で、TempoStack カスタムリソース (CR) をカスタマイズします。

      apiVersion: tempo.grafana.com/v1alpha1
      kind: TempoStack
      metadata:
        name: sample
        namespace: <project_of_tempostack_instance>
      spec:
        storageSize: 1Gi
        storage:
          secret:
            name: <secret-name> 1
            type: <secret-provider> 2
        template:
          queryFrontend:
            jaegerQuery:
              enabled: true
              ingress:
                route:
                  termination: edge
                type: route

      1

      シークレットの metadata 内にある name の値。

      2

      この値には、Azure Blob Storage の場合は azure、Google Cloud Storage の場合は gcs、Amazon S3、MinIO、または Red Hat OpenShift Data Foundation の場合は s3 を使用できます。

      AWS S3 および MinIO ストレージの TempoStack CR の例

      apiVersion: tempo.grafana.com/v1alpha1
      kind: TempoStack
      metadata:
        name: simplest
        namespace: <project_of_tempostack_instance>
      spec:
        storageSize: 1Gi
        storage:
          secret:
            name: minio-test
            type: s3
        resources:
          total:
            limits:
              memory: 2Gi
              cpu: 2000m
        template:
          queryFrontend:
            jaegerQuery:
              enabled: true
              ingress:
                route:
                  termination: edge
                type: route

      この例にデプロイされたスタックは、HTTP および OpenTelemetry Protocol (OTLP) 経由で Jaeger Thrift を受信するように設定されています。これにより、Jaeger UI でデータが可視化されます。

   4. Create を選択します。

検証

1. Project: ドロップダウンリストを使用して、TempoStack インスタンスのプロジェクトを選択します。
2. Operators → Installed Operators に移動して、TempoStack インスタンスの Status が Condition: Ready であることを確認します。
3. Workloads → Pods に移動して、TempoStack インスタンスのすべてのコンポーネント Pod が稼働していることを確認します。

4. Tempo コンソールにアクセスします。

   1. Networking → Routes に移動し、Ctrl+F で tempo を検索します。
   2. Location 列で URL を開き、Tempo コンソールにアクセスします。

   3. Web コンソールでクラスター管理者の認証情報を使用するために、Log In With OpenShift を選択します。

      注記

      Tempo コンソールをインストールした直後は、Tempo コンソールにトレースデータは表示されません。

手順

1. Tempo Operator をインストールします。

   1. 以下のコマンドを実行して、Tempo Operator のプロジェクトを作成します。

      $ oc apply -f - << EOF
      apiVersion: project.openshift.io/v1
      kind: Project
      metadata:
        labels:
          kubernetes.io/metadata.name: openshift-tempo-operator
          openshift.io/cluster-monitoring: "true"
        name: openshift-tempo-operator
      EOF

   2. 以下のコマンドを実行して、Operator グループを作成します。

      $ oc apply -f - << EOF
      apiVersion: operators.coreos.com/v1
      kind: OperatorGroup
      metadata:
        name: openshift-tempo-operator
        namespace: openshift-tempo-operator
      spec:
        upgradeStrategy: Default
      EOF

   3. 以下のコマンドを実行して、サブスクリプションを作成します。

      $ oc apply -f - << EOF
      apiVersion: operators.coreos.com/v1alpha1
      kind: Subscription
      metadata:
        name: tempo-product
        namespace: openshift-tempo-operator
      spec:
        channel: stable
        installPlanApproval: Automatic
        name: tempo-product
        source: redhat-operators
        sourceNamespace: openshift-marketplace
      EOF

   4. 以下のコマンドを実行して、Operator のステータスを確認します。

      $ oc get csv -n openshift-tempo-operator

2. 次のコマンドを実行して、後続の手順で作成する TempoStack インスタンス用に選択したプロジェクトを作成します。

   $ oc apply -f - << EOF
   apiVersion: project.openshift.io/v1
   kind: Project
   metadata:
     name: <project_of_tempostack_instance>
   EOF

3. 次のコマンドを実行して、TempoStack インスタンス用に作成したプロジェクトでオブジェクトストレージバケットのシークレットを作成します。

   $ oc apply -f - << EOF
   <object_storage_secret>
   EOF

   Amazon S3 および MinIO ストレージのシークレット例

   apiVersion: v1
   kind: Secret
   metadata:
     name: minio-test
   stringData:
     endpoint: http://minio.minio.svc:9000
     bucket: tempo
     access_key_id: tempo
     access_key_secret: <secret>
   type: Opaque

4. TempoStack インスタンス用に作成したプロジェクトに TempoStack インスタンスを作成します。

   注記

   同じクラスター上の別々のプロジェクトに、複数の TempoStack インスタンスを作成できます。

   1. TempoStack カスタムリソース (CR) をカスタマイズします。

      apiVersion: tempo.grafana.com/v1alpha1
      kind: TempoStack
      metadata:
        name: sample
        namespace: <project_of_tempostack_instance>
      spec:
        storageSize: 1Gi
        storage:
            secret:
                name: <secret-name> 1
                type: <secret-provider> 2
        template:
          queryFrontend:
            jaegerQuery:
              enabled: true
              ingress:
                route:
                  termination: edge
                type: route

      1

      シークレットの metadata 内にある name の値。

      2

      この値には、Azure Blob Storage の場合は azure、Google Cloud Storage の場合は gcs、Amazon S3、MinIO、または Red Hat OpenShift Data Foundation の場合は s3 を使用できます。

      AWS S3 および MinIO ストレージの TempoStack CR の例

      apiVersion: tempo.grafana.com/v1alpha1
      kind: TempoStack
      metadata:
        name: simplest
        namespace: project_of_tempostack_instance
      spec:
        storageSize: 1Gi
        storage:
          secret:
            name: minio-test
            type: s3
        resources:
          total:
            limits:
              memory: 2Gi
              cpu: 2000m
        template:
          queryFrontend:
            jaegerQuery:
              enabled: true
              ingress:
                route:
                  termination: edge
                type: route

      この例にデプロイされたスタックは、HTTP および OpenTelemetry Protocol (OTLP) 経由で Jaeger Thrift を受信するように設定されています。これにより、Jaeger UI でデータが可視化されます。

   2. 次のコマンドを実行して、カスタマイズされた CR を適用します。

      $ oc apply -f - << EOF
      <TempoStack_custom_resource>
      EOF

検証

1. 次のコマンドを実行して、すべての TempoStack components の status が Running、conditions が type: Ready になっていることを確認します。

   $ oc get tempostacks.tempo.grafana.com simplest -o yaml

2. 次のコマンドを実行して、すべての TempoStack コンポーネント Pod が稼働していることを確認します。

   $ oc get pods

3. Tempo コンソールにアクセスします。

   1. 以下のコマンドを実行してルートの詳細をクエリーします。

      $ export TEMPO_URL=$(oc get route -n <control_plane_namespace> tempo -o jsonpath='{.spec.host}')

   2. Web ブラウザーで https://<route_from_previous_step> を開きます。

   3. Web コンソールのクラスター管理者認証情報を使用してログインします。

      注記

      Tempo コンソールをインストールした直後は、Tempo コンソールにトレースデータは表示されません。

手順

1. Operators → Installed Operators → Tempo Operator → TempoStack に移動します。
2. TempoStack インスタンスを削除するには、 → Delete TempoStack → Delete を選択します。
3. オプション: Tempo Operator を削除します。

手順

1. 以下のコマンドを実行して、TempoStack インスタンスの名前を取得します。

   $ oc get deployments -n <project_of_tempostack_instance>

2. 以下のコマンドを実行して、TempoStack インスタンスを削除します。

   $ oc delete tempo <tempostack_instance_name> -n <project_of_tempostack_instance>

3. オプション: Tempo Operator を削除します。

検証

1. 以下のコマンドを実行して、出力に TempoStack インスタンスがないことを確認します。ない場合、正常に削除されています。

   $ oc get deployments -n <project_of_tempostack_instance>