システム健全性エージェント (SHA) フレームワークは、ホスト トランスポート ノードの統計情報、およびオプションで指定された期間のセグメント統計情報をファイルにダンプできるモニターを提供します。ファイルは、ESXi ホスト トランスポート ノードに保存されます。この機能はファイル ダンプと呼ばれます。

この機能は現在、NSX API でのみサポートされています。これは主に、ホスト トランスポート ノードの統計情報の履歴傾向を調査し、データ パスの問題をデバッグするための統計情報を詳しく調べることに関心のある上級の NSX ユーザーまたはエンジニアを対象としています。

ファイル ダンプ機能は、次の 2 つのモニターを使用して統計情報をファイルにダンプします。

  • esx-obsrv-tn-stats-file-dump-monitor：このモニターは、ESXi ホスト トランスポート ノードの統計情報をファイルにダンプします。
  • esx-obsrv-segment-stats-file-dump-monitor：このモニターはセグメントの統計情報をファイルにダンプします。

    オーバーレイ セグメントのみの統計情報がファイルにダンプされます。ファイル ダンプ機能は、VLAN セグメントでは現在サポートされていません。

ESXi ホスト トランスポート ノードでは、ファイルは /var/run/log/nsx-obsrv-stats-filedump/ に保存されます。

ファイルにダンプされるデータは Raw 形式です。現在、システムは、NSX Manager の Raw データを使用および分析するためのユーザー インターフェイスを提供していません。

Raw ファイルをホストからダウンロードし、分析目的で VMware のサポートと共有できます。Raw ファイルは、ホスト トランスポート ノード上の次の場所にあります。

/var/run/log/nsx-obsrv-stats-filedump/

Raw ファイルは、サポート バンドルの収集要求を作成するときにも NSX サポート バンドルに保存されます。

次の手順では、ファイル ダンプ機能を使用するための API ワークフローについて説明します。

手順

  1. ホスト トランスポート ノードの統計情報をファイルにダンプするには、次の手順を実行します。
    1. 次の API を実行して、esx-obsrv-tn-stats-file-dump-monitor のデフォルト プロファイルの構成を表示します。 
      GET https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-tn-stats-file-dump-monitor/profiles/default-profile
    2. 前の手順の GET API の応答をコピーし、テキスト エディタに貼り付けます。デフォルト プロファイルで次のプロパティを編集します。
      • check_interval
      • enable
      • disable_after
      • file_dump_backup_count_dp_tn_stats

      これらの構成プロパティの詳細については、『NSX API ガイド』の次の API のドキュメントを参照してください。

      /policy/api/v1/infra/sha/monitors/<monitor-id>/profiles/<monitor-profile-id>

      [ShaMonitorProfile] スキーマを展開します。[タイプ] 列で、[ShaEsxObsrvTnStatsFileDumpMonitorConfig] をクリックして、プロパティの説明を表示します。

    3. 次の API の要求本文に、更新されたプロファイル構成を貼り付けます。
      PATCH https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-tn-stats-file-dump-monitor/profiles/default-profile

      この API が成功すると、システム内のすべてのホスト トランスポート ノードでファイル ダンプ機能が有効になります。

    4. 特定のホスト トランスポート ノードで esx-obsrv-tn-stats-file-dump-monitor のプロファイルが有効になっているかどうかを確認するには、次の API を実行します。 
      GET https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-tn-stats-file-dump-monitor/status?transport_node_id=<node-id>

      この API の出力には、ホスト トランスポート ノードで有効なモニター プロファイルとそのプロファイルの詳細な構成が表示されます。

      この API では、API URI で node_id を指定する必要があります。ホスト トランスポート ノードの node_id を取得するには、次の API を実行します。

      GET https://<nsx-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/host-transport-nodes
  2. 特定のセグメントの統計情報をファイルにダンプするには、次の手順を実行します。
    1. esx-obsrv-stats-management モニターのプロファイルの enable_esx_datapath_per_segment_stats プロパティを true に設定します。

      このアクションにより、システム内のホスト トランスポート ノードからのセグメント統計情報の収集が有効になります。

      セグメント統計情報の収集の有効化の詳細については、「API を使用した NSX セグメント統計情報の監視」の「前提条件」セクションを参照してください。

    2. 統計情報をファイルにダンプするオーバーレイ セグメントの VNI を特定します。

      次の方法のいずれかを使用して、セグメントの VNI を判断できます。

      方法 1：API を使用する

      次の API を実行します。

      GET https://<nsx-mgr>/policy/api/v1/infra/realized-state/realized-entities?intent_path=/infra/segments/<segment-id>

      この API URI で、segment-id を、VNI を特定するオーバーレイ セグメント ID の値に置き換えます。

      方法 2： NSX Manager ユーザー インターフェイスを使用する

      [ネットワーク] > [セグメント] > [NSX] の順に移動します。オーバーレイ セグメントの詳細を展開し、[追加設定] セクションを展開します。

      [オーバーレイ ID (VNI)] フィールドの横にある値を書き留めます。

    3. 次の API を実行して、esx-obsrv-segment-stats-file-dump-monitor のデフォルト プロファイルの構成を表示します。 
      GET https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-segment-stats-file-dump-monitor/profiles/default-profile
    4. 前の手順の GET API の応答をコピーし、テキスト エディタに貼り付けます。デフォルト プロファイルで次のプロパティを編集します。
      • check_interval
      • enable
      • segment_list
      • disable_after
      • file_dump_backup_count_dp_segment_stats

      これらの構成プロパティの詳細については、『NSX API ガイド』の次の API のドキュメントを参照してください。

      /policy/api/v1/infra/sha/monitors/<monitor-id>/profiles/<monitor-profile-id>

      [ShaMonitorProfile] スキーマを展開します。[タイプ] 列で、[ShaEsxObsrvSegmentStatsFileDumpMonitorConfig] をクリックして、プロパティの説明を表示します。

    5. 次の API の要求本文に、更新されたプロファイル構成を貼り付けます。 
      PATCH https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-segment-stats-file-dump-monitor/profiles/default-profile

      この API が成功すると、指定したセグメントに対してファイル ダンプ機能が有効になります。セグメントの統計情報は、ホスト トランスポート ノードに保存されているファイルにダンプされます。

    6. 特定のホスト トランスポート ノードで esx-obsrv-segment-stats-file-dump-monitor のプロファイルが有効になっているかどうかを確認するには、次の API を実行します。 
      GET https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-segment-stats-file-dump-monitor/status?transport_node_id=<node-id>

      この API の出力には、ホスト トランスポート ノードで有効なモニター プロファイルとそのプロファイルの詳細な構成が表示されます。

      この API では、API URI で node_id を指定する必要があります。ホスト トランスポート ノードの node_id を取得するには、次の API を実行します。

      GET https://<nsx-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/host-transport-nodes

次のタスク

通常、セグメントの統計情報は、データ パスの問題をデバッグする場合にのみ必要です。セグメントの統計情報の収集は、リソースを大量に消費するアクティビティです。デバッグが完了したら、esx-obsrv-stats-management モニターのプロファイルでセグメント統計情報の収集を無効にしてください。