使用 API 監控 NSX 主機傳輸節點的統計資料

透過 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)，而將預設設定檔套用於系統中所有剩餘的主機。在這種情況下，必須建立一個包含這兩個主機傳輸節點 (A 和 B) 的自訂群組。可以使用 NSX API 建立僅包含主機傳輸節點成員的群組。UI 不支援此功能。建立所需的群組後，請在使用者定義的設定檔的 applied_to_group_paths 內容中使用此群組。

   使用前面提到的相同 PATCH API 建立使用者定義的設定檔。

   例如，以下 API 會建立識別碼為「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