Surveiller les statistiques des nœuds de transport hôtes NSX à l'aide d'API

Avec l’APINSX, vous pouvez surveiller les valeurs à des moments précis et les valeurs en temps réel des statistiques du nœud de transport hôte.

Le système utilise le esx-obsrv-stats-monitor pour surveiller la santé des nœuds de transport hôtes ESXi.

Les statistiques sont collectées par nœud de transport hôte. Les valeurs des statistiques ne sont pas agrégées au niveau de chaque cluster d'hôtes.

Les valeurs ponctuelles des statistiques du nœud de transport hôte sont collectées périodiquement à partir de chaque nœud de transport hôte (la valeur par défaut est toutes les 300 secondes) et mises en cache par le système. Les dernières valeurs mises en cache mises à jour sont extraites de l'hôte et renvoyées par l'API.

À des fins de débogage, les utilisateurs NSX peuvent surveiller les valeurs en temps réel des statistiques du nœud de transport hôte. Le système extrait les statistiques en temps réel à partir des modules de noyau de chemin de données qui s'exécutent sur les nœuds de transport hôtes.

Avec l’API NSX, vous pouvez afficher les types de statistiques suivants pour les nœuds de transport hôtes :

Statistiques de paquets (packet_stats)
Statistiques du système de chemin d'accès rapide (fast_path_sys_stats)
Statistiques des paquets de plate-forme (platform_packet_stats)
Statistiques d'utilisation du CPU de la plate-forme (platform_cpu_usage_stats)
Statistiques d'utilisation de lcore du chemin d'accès rapide (fast_path_lcore_usage_stats)

Dans la réponse de l'API, les statistiques sont organisées en fonction des modules de chemin de données qui collectent les statistiques à partir des nœuds de transport hôtes. Pour une description des statistiques, reportez-vous à Statistiques du nœud de transport hôte NSX.

La procédure décrite dans cette documentation explique le workflow d'API de surveillance des valeurs à un moment précis et des valeurs en temps réel des statistiques du nœud de transport hôte. Les étapes de la procédure mentionnent uniquement les URI d'API. Pour obtenir des informations détaillées sur le schéma de l'API, les paramètres et l'exemple de charge utile de réponse ou de demande d'API, reportez-vous au Guide de NSX API.

Pour en savoir plus sur l'utilisation de NSX Central CLI ou de l'interface de ligne de commande de l'hôte ESXi pour afficher les statistiques du nœud de transport, reportez-vous aux Guide de référence de l'interface de ligne de commandes de NSX.

Procédure

Exécutez l'API suivante pour afficher les descriptions de toutes les statistiques du esx-obsrv-stats-monitor :
```
GET https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-stats-monitor
```
Exécutez l'API suivante pour récupérer la liste des profils du esx-obsrv-stats-monitor :
```
GET https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-stats-monitor/profiles
```
La réponse de l'API affiche le profil par défaut et un profil défini par l'utilisateur (s'il est créé) pour ce moniteur. Le profil par défaut est créé par le système et il est appliqué au groupe par défaut créé par le système. Le groupe par défaut contient tous les nœuds de transport hôtes ESXi dans le système. Le profil par défaut est activé par défaut sur tous les nœuds de transport hôtes.

Pour afficher la configuration du profil par défaut, exécutez l'API suivante :
```
GET https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-stats-monitor/profiles/default-profile
```
(Facultatif) Exécutez l'API suivante pour modifier la configuration du profil par défaut :
```
PATCH https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-stats-monitor/profiles/default-profile
```
Copiez la réponse de l'API GET et du profil par défaut et collez-la dans un éditeur de texte. Modifiez les valeurs de configuration du profil. Enfin, envoyez la configuration modifiée dans le corps de la demande de cette API PATCH.
Exemple de scénario :
Supposons que vous souhaitez appliquer un profil défini par l'utilisateur à un ensemble spécifique d'hôtes (par exemple, A et B), mais que vous appliquez le profil par défaut à tous les hôtes restants dans le système. Dans ce cas, vous devez créer un groupe personnalisé qui contient ces deux nœuds de transport hôtes (A et B). Les groupes comportant uniquement des membres du nœud de transport hôte peuvent être créés à l'aide de l’API NSX. L'interface utilisateur ne prend pas en charge cette fonctionnalité. Une fois que vous avez créé le groupe souhaité, utilisez ce groupe dans la propriété applied_to_group_paths du profil défini par l'utilisateur.

Utilisez la même API PATCH, comme mentionné précédemment, pour créer le profil défini par l'utilisateur.

Par exemple, l'API suivante crée un profil défini par l'utilisateur avec l'ID « profile-1 » :
```
PATCH https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-stats-monitor/profiles/profile-1
```
Lorsque cette API réussit, le profil défini par l'utilisateur (profil-1) remplace le profil par défaut sur les nœuds de transport A et B de l'hôte. Pour tous les nœuds de transport hôtes restants dans le système, le profil par défaut est appliqué.

(Facultatif) Exécutez l'API suivante pour lire l'état du moniteur sur un nœud de transport hôte spécifique :

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

Pour obtenir l’node_id des nœuds de transport hôtes, exécutez l'API suivante :

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

Exécutez l'API suivante pour afficher les valeurs à un moment spécifique des statistiques du nœud de transport hôte pour un nœud spécifique :
```
GET https://<nsx-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/host-transport-nodes/<host-tn-id>/statistics/monitor
```
Pour obtenir les node_id du nœud de transport hôte, utilisez la même API, comme indiqué à l'étape précédente.

Cette API renvoie les dernières valeurs mises à jour en cache des statistiques de surveillance de la santé pour le nœud de transport hôte spécifié. Par défaut, seules les statistiques de paquets sont renvoyées pour le nœud de transport hôte.
Comme mentionné précédemment dans cette section, l'API peut renvoyer les types de statistiques de surveillance de santé suivants pour un nœud de transport hôte :
- Statistiques de paquets (packet_stats). Il s'agit du type par défaut.
- Statistiques du système de chemin d'accès rapide (fast_path_sys_stats)
- Statistiques des paquets de plate-forme (platform_packet_stats)
- Statistiques d'utilisation du CPU de la plate-forme (platform_cpu_usage_stats)
- Statistiques d'utilisation de lcore du chemin d'accès rapide (fast_path_lcore_usage_stats)
Lorsque le paramètre de requête type est omis dans l'URI de l'API, l'API renvoie uniquement les statistiques de paquets par défaut.

Pour afficher les statistiques d'un type spécifique ou de plusieurs types ensemble, utilisez le paramètre de requête type dans l'URI de l'API.
Exemple 1 : l'API suivante renvoie les valeurs à un moment précis des statistiques du nœud de transport hôte pour un type unique :
```
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
```
Exemple 2 : l'API suivante renvoie les valeurs à un moment précis des statistiques du nœud de transport hôte pour plusieurs types ensemble :
```
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
```
Assurez-vous que les types sont spécifiés dans une liste séparée par des virgules et sans espace avant et après les virgules.
Exécutez l'API suivante pour afficher les valeurs en temps réel des statistiques de santé du nœud de transport pour un nœud spécifique :
```
GET https://<nsx-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/host-transport-nodes/<host-tn-id>/statistics/debug
```
Comme mentionné précédemment à l'étape 5, lorsque le paramètre de requête type est omis dans l'URI de l'API, l'API renvoie uniquement les statistiques de paquets par défaut.

Pour afficher les statistiques d'un type spécifique ou de plusieurs types ensemble, utilisez le paramètre de requête type dans l'URI de l'API.
Exemple 1 : l'API suivante renvoie les valeurs en temps réel des statistiques du nœud de transport hôte pour un type unique :
```
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
```
Exemple 2 : l'API suivante renvoie les valeurs en temps réel des statistiques du nœud de transport hôte pour plusieurs types ensemble :
```
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
```