13.10. Red Hat サポート用のデータ収集

Red Hat サポートに サポートケース を送信する際、以下のツールを使用して OpenShift Container Platform および OpenShift Virtualization のデバッグ情報を提供すると役立ちます。

must-gather ツール
must-gather ツールは、リソース定義やサービスログなどの診断情報を収集します。
Prometheus
Prometheus は Time Series を使用するデータベースであり、メトリックのルール評価エンジンです。Prometheus は処理のためにアラートを Alertmanager に送信します。
Alertmanager
Alertmanager サービスは、Prometheus から送信されるアラートを処理します。また、Alertmanager は外部の通知システムにアラートを送信します。

13.10.1. 環境に関するデータの収集

環境に関するデータを収集すると、根本原因の分析および特定に必要な時間が最小限に抑えられます。

前提条件

  • Prometheus メトリックデータの保持期間を最低 7 日間に設定します。
  • Alertmanager を設定して、関連するアラートを取得して、それらを専用のメールボックスに送信して、クラスター外で表示および保持できるようにします。
  • 影響を受けるノードおよび仮想マシンの正確な数を記録します。

手順

  1. デフォルトの must-gather イメージを使用して、クラスターの must-gather データを収集します。
  2. 必要に応じて、Red Hat OpenShift Container Storage の must-gather データを収集します。
  3. OpenShift Virtualization の must-gather イメージを使用して、OpenShift Virtualization の must-gather データを収集します。
  4. クラスターの Prometheus メトリックを収集します。

13.10.1.1. 関連情報

13.10.2. 仮想マシンに関するデータの収集

仮想マシン (VM) の誤動作に関するデータを収集することで、根本原因の分析および特定に必要な時間を最小限に抑えることができます。

前提条件

  • Windows 仮想マシン:

    • Red Hat サポート用に Windows パッチ更新の詳細を記録します。
    • VirtIO ドライバーの最新バージョンをインストールします。VirtIO ドライバーには、QEMU ゲストエージェントが含まれています。
    • リモートデスクトッププロトコル (RDP) が有効になっている場合は、RDP を使用して仮想マシンに接続し、接続ソフトウェアに問題があるかどうかを判断します。

手順

  1. 誤動作している仮想マシンに関する詳細な must-gather を収集します。
  2. 仮想マシンを再起動する前に、クラッシュした仮想マシンのスクリーンショットを収集します。
  3. 誤動作している仮想マシンに共通する要因を記録します。たとえば、仮想マシンには同じホストまたはネットワークがあります。

13.10.2.1. 関連情報

13.10.3. OpenShift Virtualization の must-gather ツールの使用

OpenShift Virtualization イメージで must-gather コマンドを実行することにより、OpenShift Virtualization リソースに関するデータを収集できます。

デフォルトのデータ収集には、次のリソースに関する情報が含まれています。

  • 子オブジェクトを含む OpenShift Virtualization Operator namespace
  • すべての OpenShift Virtualization カスタムリソース定義 (CRD)
  • 仮想マシンを含むすべての namespace
  • 基本的な仮想マシン定義

手順

  • 以下のコマンドを実行して、OpenShift Virtualization に関するデータを収集します。 

    $ oc adm must-gather --image-stream=openshift/must-gather \
  --image=registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel8:v{HCOVersion}

13.10.3.1. must-gather ツールオプション

次のオプションに対して、スクリプトおよび環境変数の組み合わせを指定できます。

  • namespace から詳細な仮想マシン (VM) 情報の収集する
  • 特定の仮想マシンに関する詳細情報の収集
  • イメージおよびイメージストリーム情報の収集
  • must-gather ツールが使用する並列プロセスの最大数の制限
13.10.3.1.1. パラメーター

環境変数

互換性のあるスクリプトの環境変数を指定できます。

NS=<namespace_name>
指定した namespace から virt-launcher Pod の詳細を含む仮想マシン情報を収集します。VirtualMachine および VirtualMachineInstance CR データはすべての namespace で収集されます。
VM=<vm_name>
特定の仮想マシンに関する詳細を収集します。このオプションを使用するには、NS 環境変数を使用して namespace も指定する必要があります。
PROS=<number_of_processes>

must-gather ツールが使用する並列処理の最大数を変更します。デフォルト値は 5 です。

重要

並列処理が多すぎると、パフォーマンスの問題が発生する可能性があります。並列処理の最大数を増やすことは推奨されません。

スクリプト

各スクリプトは、特定の環境変数の組み合わせとのみ互換性があります。

gather_vms_details
OpenShift Virtualization リソースに属する仮想マシンログファイル、仮想マシン定義、ならびに namespace (およびそれらのサブオブジェクト) を収集します。namespace または仮想マシンを指定せずにこのパラメーターを使用する場合、must-gather ツールはクラスター内のすべての仮想マシンについてこのデータを収集します。このスクリプトはすべての環境変数と互換性がありますが、VM 変数を使用する場合は namespace を指定する必要があります。
gather
デフォルトの must-gather スクリプトを使用します。すべての namespace からクラスターデータが収集され、基本的な仮想マシン情報のみが含まれます。このスクリプトは、PROS 変数とのみ互換性があります。
gather_images
イメージおよびイメージストリームのカスタムリソース情報を収集します。このスクリプトは、PROS 変数とのみ互換性があります。
13.10.3.1.2. 使用方法および例

環境変数はオプションです。スクリプトは、単独で実行することも、1 つ以上の互換性のある環境変数を使用して実行することもできます。

表13.1 互換性のあるパラメーター

スクリプト互換性のある環境変数

gather_vms_details

  • namespace の場合: NS=<namespace_name>
  • 仮想マシンの場合: VM=<vm_name> NS=<namespace_name>
  • PROS=<number_of_processes>

gather

  • PROS=<number_of_processes>

gather_images

  • PROS=<number_of_processes>

must-gather が収集するデータをカスタマイズするには、コマンドに二重ダッシュ (--) を追加し、その後にスペースと 1 つ以上の互換性のあるパラメーターを追加します。

構文

$ oc adm must-gather \
  --image=registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel8:v4.9.7 \
  -- <environment_variable_1> <environment_variable_2> <script_name>

詳細な仮想マシン情報

次のコマンドは、mynamespace namespace にある my-vm 仮想マシンの詳細な仮想マシン情報を収集します。 

$ oc adm must-gather \
  --image=registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel8:v4.9.7 \
  -- NS=mynamespace VM=my-vm gather_vms_details 1
1
VM 環境変数を使用する場合、NS 環境変数は必須です。

3 つの並列プロセスに限定されたデフォルトのデータ収集

以下のコマンドは、最大 3 つの並列処理を使用して、デフォルトの must-gather 情報を収集します。 

$ oc adm must-gather \
  --image=registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel8:v4.9.7 \
  -- PROS=3 gather

イメージおよびイメージストリーム情報

以下のコマンドは、クラスターからイメージおよびイメージストリームの情報を収集します。 

$ oc adm must-gather \
  --image=registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel8:v4.9.7 \
  -- gather_images

13.10.3.2. 関連情報