NSX API を使用すると、ホスト トランスポート ノードの統計情報の特定の時点の値とリアルタイム値の両方を監視できます。

システムは、esx-obsrv-stats-monitor を使用して、ESXi ホスト トランスポート ノードの健全性を監視します。

統計情報は、ホスト トランスポート ノードごとに収集されます。統計情報の値は、各ホスト クラスタのレベルでは集計されません。

ホスト トランスポート ノードの統計情報の特定の時点の値は、各ホスト トランスポート ノードから定期的に収集され（デフォルトは 300 秒ごと）、システムによってキャッシュされます。最後に更新されたキャッシュされた値はホストから取得され、API によって返されます。

デバッグの目的で、NSX ユーザーはホスト トランスポート ノードの統計情報のリアルタイム値を監視できます。システムは、ホスト トランスポート ノードで実行されているデータ パス カーネル モジュールから統計情報をリアルタイムで取得します。

NSX API を使用すると、ホスト トランスポート ノードの次のタイプの統計情報を表示できます。
  • パケット統計情報 (packet_stats)
  • 高速パス システム統計情報 (fast_path_sys_stats)
  • プラットフォーム パケット統計情報 (platform_packet_stats)
  • プラットフォーム CPU 使用率統計情報 (platform_cpu_usage_stats)
  • 高速パス Lcore 使用量統計情報 (fast_path_lcore_usage_stats)

API 応答では、統計情報は、ホスト トランスポート ノードから統計情報を収集しているデータパス モジュールに基づいて編成されます。各統計情報の説明については、「NSX ホスト トランスポート ノードの統計情報」を参照してください。

このドキュメントの手順では、ホスト トランスポート ノードの統計情報の特定の時点の値とリアルタイム値を監視するための API ワークフローについて説明します。この手順では、API URI のみが記載されています。API スキーマ、パラメータ、サンプル API 応答または要求ペイロードの詳細については、『NSX API ガイド』を参照してください。

NSX Central CLI または ESXi ホスト CLI を使用してトランスポート ノードの統計情報を表示する方法については、『NSX コマンドライン インターフェイス リファレンス』を参照してください。

手順

  1. 次の API を実行して、esx-obsrv-stats-monitor のすべての統計情報の説明を表示します。 
    GET https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-stats-monitor
  2. 次の API を実行して、esx-obsrv-stats-monitor のプロファイルのリストを取得します。 
    GET https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-stats-monitor/profiles

    API 応答には、このモニターのデフォルト プロファイルとユーザー定義プロファイル（作成されている場合）が表示されます。デフォルト プロファイルはシステムによって作成され、システムによって作成されたデフォルト グループに適用されます。デフォルト グループには、システム内のすべての ESXi ホスト トランスポート ノードが含まれています。デフォルト プロファイルは、すべてのホスト トランスポート ノードでデフォルトで有効になっています。

    デフォルト プロファイルの構成を表示するには、次の API を実行します。

    GET https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-stats-monitor/profiles/default-profile
  3. （オプション） 次の API を実行して、デフォルト プロファイルの構成を編集します。 
    PATCH https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-stats-monitor/profiles/default-profile

    デフォルト プロファイルの GET API の応答をコピーし、テキスト エディタに貼り付けます。プロファイルの構成値を編集します。最後に、この PATCH API の要求本文で編集した構成を送信します。

    シナリオの例：

    ユーザー定義プロファイルを特定のホスト セット（A や B など）に適用し、システム内の残りのすべてのホストにデフォルト プロファイルを適用するとします。この場合、これら 2 つのホスト トランスポート ノード（A と B）を含むカスタム グループを作成する必要があります。ホスト トランスポート ノード メンバーのみを持つグループは、NSX API を使用して作成できます。ユーザー インターフェイスはこの機能をサポートしていません。目的のグループを作成したら、このグループをユーザー定義プロファイルの applied_to_group_paths プロパティで使用します。

    前述と同じ PATCH API を使用して、ユーザー定義プロファイルを作成します。

    たとえば、次の API は ID が「profile-1」のユーザー定義プロファイルを作成します。

    PATCH https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-stats-monitor/profiles/profile-1

    この API が成功すると、ユーザー定義プロファイル (profile-1) は、ホスト トランスポート ノード A と B のデフォルト プロファイルを上書きします。システム内の残りのすべてのホスト トランスポート ノードに対しては、デフォルト プロファイルが適用されます。

  4. （オプション） 次の API を実行して、特定のホスト トランスポート ノードの監視状態を読み取ります。 
    GET https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-stats-monitor/status?transport_node_id=<node-id>

    ホスト トランスポート ノードの node_id を取得するには、次の API を実行します。

    GET https://<nsx-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/host-transport-nodes
  5. 次の API を実行して、特定のノードのホスト トランスポート ノード統計情報の特定の時点の値を表示します。 
    GET https://<nsx-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/host-transport-nodes/<host-tn-id>/statistics/monitor

    ホスト トランスポート ノードの node_id を取得するには、前の手順で説明したのと同じ API を使用します。

    この API は、指定されたホスト トランスポート ノードの健全性モニタリング統計情報の最後に更新されたキャッシュされた値を返します。デフォルトでは、ホスト トランスポート ノードのパケット統計情報のみが返されます。

    このセクションで前述したように、API はホスト トランスポート ノードの次のタイプの健全性モニタリング統計情報を返すことができます。
    • パケット統計情報 (packet_stats)。このタイプがデフォルトです。
    • 高速パス システム統計情報 (fast_path_sys_stats)
    • プラットフォーム パケット統計情報 (platform_packet_stats)
    • プラットフォーム CPU 使用率統計情報 (platform_cpu_usage_stats)
    • 高速パス Lcore 使用量統計情報 (fast_path_lcore_usage_stats)

    API URI で type クエリ パラメータを省略すると、API はデフォルトでパケット統計情報のみを返します。

    特定のタイプまたは複数のタイプの統計情報を一緒に表示するには、API URI で type クエリ パラメータを使用します。

    例 1：次の API は、単一タイプのホスト トランスポート ノード統計情報の特定の時点の値を返します。 
    GET https://<nsx-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/host-transport-nodes/<host-tn-id>/statistics/monitor?type=platform_cpu_usage_stats

    例 2：次の API は、複数タイプのホスト トランスポート ノード統計情報の特定の時点の値を一緒に返します。

    GET https://<nsx-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/host-transport-nodes/<host-tn-id>/statistics/monitor?type=platform_cpu_usage_stats,fast_path_sys_stats,platform_packet_stats

    タイプがカンマ区切りリストで指定されており、カンマの前後にスペースが含まれていないことを確認します。

  6. 次の API を実行して、特定ノードのトランスポート ノード健全性統計情報のリアルタイム値を表示します。 
    GET https://<nsx-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/host-transport-nodes/<host-tn-id>/statistics/debug

    手順 5 で前述したように、API URI で type クエリ パラメータを省略すると、API はデフォルトでパケット統計情報のみを返します。

    特定のタイプまたは複数のタイプの統計情報を一緒に表示するには、API URI で type クエリ パラメータを使用します。

    例 1：次の API は、単一タイプのホスト トランスポート ノード統計情報のリアルタイム値を返します。 
    GET https://<nsx-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/host-transport-nodes/<host-tn-id>/statistics/debug?type=platform_cpu_usage_stats
    例 2：次の API は、複数タイプのホスト トランスポート ノード統計情報のリアルタイム値を一緒に返します。 
    GET https://<nsx-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/host-transport-nodes/<host-tn-id>/statistics/debug?type=platform_cpu_usage_stats,fast_path_sys_stats,platform_packet_stats