Überwachen von Statistiken von NSX Host-Transportknoten mithilfe von APIs

Mit NSX-APIs können Sie sowohl Point-in-Time-Werte als auch Echtzeitwerte der Host-Transportknotenstatistiken überwachen.

Das System verwendet esx-obsrv-stats-monitor, um die Integrität des ESXi-Host-Transportknoten zu überwachen.

Statistiken werden pro Host-Transportknoten erfasst. Die Werte der Statistiken werden nicht auf der Ebene des jeweiligen Hostclusters aggregiert.

Point-in-Time-Werte der Host-Transportknotenstatistiken werden regelmäßig von jedem Host-Transportknoten erfasst (Standard ist alle 300 Sekunden) und vom System zwischengespeichert. Die zuletzt aktualisierten zwischengespeicherten Werte werden vom Host abgerufen und von der API zurückgegeben.

Zu Debugging-Zwecken können NSX-Benutzer die Echtzeitwerte der Host-Transportknotenstatistiken überwachen. Das System ruft die Statistiken in Echtzeit von den Datenpfad-Kernelmodulen ab, die auf den Host-Transportknoten ausgeführt werden.

Mit NSX-APIs können Sie die folgenden Arten von Statistiken für Host-Transportknoten anzeigen:

Paketstatistik (packet_stats)
FastPath-Systemstatistik (fast_path_sys_stats)
Plattformpaketstatistik (platform_packet_stats)
Plattform-CPU-Nutzungsstatistik (platform_cpu_usage_stats)
FastPath-lcore-Nutzungsstatistik (fast_path_lcore_usage_stats)

In der API-Antwort werden die Statistiken auf Basis der Datenpfadmodule organisiert, welche die Statistiken von den Host-Transportknoten erfassen. Eine Beschreibung der einzelnen Statistiken finden Sie unter NSX-Host-Transportknoten-Statistik.

Das Verfahren in dieser Dokumentation erläutert den API-Workflow für die Überwachung der Point-in-Time-Werte und Echtzeitwerte der Host-Transportknotenstatistiken. Bei den Schritten in diesem Verfahren werden nur die API-URIs erwähnt. Detaillierte Informationen zum API-Schema, zu Parametern und Beispielnutzlasten für die API-Antwort oder -Anforderung finden Sie im Handbuch zu NSX-API.

Weitere Informationen zur Verwendung der zentralen NSX-CLI oder der ESXi-Host-CLI zum Anzeigen der Transportknotenstatistiken finden Sie in der Befehlszeilenschnittstellen-Referenz zu NSX.

Prozedur

Führen Sie die folgende API aus, um die Beschreibungen aller Statistiken in esx-obsrv-stats-monitor anzuzeigen:
```
GET https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-stats-monitor
```
Führen Sie die folgende API aus, um die Liste der Profile von esx-obsrv-stats-monitor abzurufen:
```
GET https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-stats-monitor/profiles
```
Die API-Antwort zeigt das Standardprofil und ein benutzerdefiniertes Profil (falls erstellt) für diese Überwachung an. Das Standardprofil wird vom System erstellt und auf die vom System erstellte Standardgruppe angewendet. Die Standardgruppe enthält alle ESXi-Host-Transportknoten im System. Das Standardprofil ist standardmäßig auf allen Host-Transportknoten aktiviert.

Führen Sie die folgende API aus, um die Konfiguration des Standardprofils anzuzeigen:
```
GET https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-stats-monitor/profiles/default-profile
```
(Optional) Führen Sie die folgende API aus, um die Konfiguration des Standardprofils zu bearbeiten:
```
PATCH https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-stats-monitor/profiles/default-profile
```
Kopieren Sie die Antwort der GET-API des Standardprofils und fügen Sie sie in einen Texteditor ein. Bearbeiten Sie die Konfigurationswerte des Profils. Übermitteln Sie schließlich die bearbeitete Konfiguration im Anforderungstext dieser PATCH-API.
Beispielszenario:
Angenommen, Sie möchten ein benutzerdefiniertes Profil auf eine bestimmte Gruppe von Hosts (z. B. A und B) anwenden, jedoch das Standardprofil auf alle verbleibenden Hosts im System anwenden. In diesem Fall müssen Sie eine benutzerdefinierte Gruppe erstellen, die diese beiden Host-Transportknoten (A und B) enthält. Gruppen, die nur Host-Transportknotenmitglieder enthalten, können mithilfe von NSX-APIs erstellt werden. Die Benutzeroberfläche unterstützt diese Funktion nicht. Nachdem Sie die gewünschte Gruppe erstellt haben, verwenden Sie diese Gruppe in der Eigenschaft applied_to_group_paths des benutzerdefinierten Profils.

Verwenden Sie dieselbe PATCH-API, wie bereits erwähnt, um das benutzerdefinierte Profil zu erstellen.

Die folgende API erstellt beispielsweise ein benutzerdefiniertes Profil mit der ID „profile-1“:
```
PATCH https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-stats-monitor/profiles/profile-1
```
Wenn diese API erfolgreich ist, überschreibt das benutzerdefinierte Profil (Profil-1) das Standardprofil auf den Host-Transportknoten A und B. Für alle verbleibenden Host-Transportknoten im System wird das Standardprofil angewendet.

(Optional) Führen Sie die folgende API aus, um den Überwachungsstatus auf einem bestimmten Hosttransportknoten zu lesen:

GET https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-stats-monitor/status?transport_node_id=<node-id>

Führen Sie die folgende API aus, um die node_id der Host-Transportknoten abzurufen:

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

Führen Sie die folgende API aus, um die Point-in-Time-Werte der Host-Transportknotenstatistiken für einen bestimmten Knoten anzuzeigen:
```
GET https://<nsx-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/host-transport-nodes/<host-tn-id>/statistics/monitor
```
Verwenden Sie dieselbe API wie im vorigen Schritt, um die node_id des Host-Transportknotens zu erhalten.

Diese API gibt die zuletzt aktualisierten zwischengespeicherten Werte der Statusüberwachungsstatistiken für den angegebenen Host-Transportknoten zurück. Standardmäßig werden nur die Paketstatistiken für den Host-Transportknoten zurückgegeben.
Wie bereits oben in diesem Abschnitt erwähnt, kann die API die folgenden Typen von Statusüberwachungsstatistiken für einen Host-Transportknoten zurückgeben:
- Paketstatistik (packet_stats). Dieser Typ ist die Standardoption.
- FastPath-Systemstatistik (fast_path_sys_stats)
- Plattformpaketstatistik (platform_packet_stats)
- Plattform-CPU-Nutzungsstatistik (platform_cpu_usage_stats)
- FastPath-lcore-Nutzungsstatistik (fast_path_lcore_usage_stats)
Wenn der Abfrageparameter type in der API-URI ausgelassen wird, gibt die API standardmäßig nur die Paketstatistik zurück.

Um die Statistiken für einen bestimmten Typ oder mehrere Typen zusammen anzuzeigen, verwenden Sie den Abfrageparameter type in der API-URI.
Beispiel 1: Die folgende API gibt die Point-in-Time-Werte der Host-Transportknotenstatistiken für einen einzelnen Typ zurück:
```
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
```
Beispiel 2: Die folgende API gibt die Point-in-Time-Werte der Host-Transportknotenstatistiken für mehrere Typen zusammen zurück:
```
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
```
Stellen Sie sicher, dass die Typen in einer kommagetrennten Liste ohne Leerzeichen vor und nach den Kommas angegeben werden.
Führen Sie die folgende API aus, um die Echtzeitwerte der Transportknoten-Statusstatistiken für einen bestimmten Knoten anzuzeigen:
```
GET https://<nsx-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/host-transport-nodes/<host-tn-id>/statistics/debug
```
Wie bereits in Schritt 5 erwähnt, gibt die API standardmäßig nur die Paketstatistik zurück, wenn der Abfrageparameter type in der API-URI ausgelassen wird.

Um die Statistiken für einen bestimmten Typ oder mehrere Typen zusammen anzuzeigen, verwenden Sie den Abfrageparameter type in der API-URI.
Beispiel 1: Die folgende API gibt die Echtzeitwerte der Host-Transportknotenstatistiken für einen einzelnen Typ zurück:
```
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
```
Beispiel 2: Die folgende API gibt die Echtzeitwerte der Host-Transportknotenstatistiken für mehrere Typen zusammen zurück:
```
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
```