Supervisar estadísticas de nodos de transporte del hosts NSX mediante API

Con las API de NSX, puede supervisar los valores de un momento específico y los valores en tiempo real de las estadísticas de los nodos de transporte del host.

El sistema utiliza esx-obsrv-stats-monitor para supervisar el estado de los nodos de transporte del hosts ESXi.

Las estadísticas se recopilan por nodo de transporte del host. Los valores de las estadísticas no se agregan en el nivel de cada clúster de hosts.

Los valores de un momento específico de las estadísticas del nodo de transporte del host se recopilan de cada nodo de transporte del host periódicamente (el valor predeterminado es cada 300 segundos) y el sistema los almacena en caché. Los últimos valores en caché actualizados se recuperan del host y los devuelve la API.

Por motivos de depuración, los usuarios de NSX pueden supervisar los valores en tiempo real de las estadísticas del nodo de transporte del host. El sistema recupera las estadísticas en tiempo real de los módulos de kernel de ruta de datos que se ejecutan en los nodos de transporte del host.

Con las API de NSX, puede ver los siguientes tipos de estadísticas para los nodos de transporte del host:

Estadísticas de paquetes (packet_stats)
Estadísticas del sistema de rutas rápidas (fast_path_sys_stats)
Estadísticas de paquetes de plataforma (platform_packet_stats)
Estadísticas de uso de CPU de la plataforma (platform_cpu_usage_stats)
Estadísticas de uso de lcore de fastpath (fast_path_lcore_usage_stats)

En la respuesta de la API, las estadísticas se organizan en función de los módulos de ruta de datos que recopilan las estadísticas de los nodos de transporte del host. Para ver una descripción de las estadísticas, consulte Estadísticas del nodo de transporte del host de NSX.

El procedimiento de esta documentación explica el flujo de trabajo de la API para supervisar los valores de un momento específico y los valores en tiempo real de las estadísticas del nodo de transporte del host. Los pasos del procedimiento solo mencionan los URI de la API. Para obtener información detallada sobre el esquema de la API, los parámetros y la carga útil de solicitud o respuesta de API de ejemplo, consulte la Guía de NSX API.

Para obtener información sobre el uso de la CLI central de NSX o la CLI del host ESXi para ver las estadísticas del nodo de transporte, consulte la Referencia de interfaz de línea de comandos de NSX.

Procedimiento

Ejecute la siguiente API para ver las descripciones de todas las estadísticas en esx-obsrv-stats-monitor:
```
GET https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-stats-monitor
```
Ejecute la siguiente API para recuperar la lista de perfiles de esx-obsrv-stats-monitor:
```
GET https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-stats-monitor/profiles
```
La respuesta de la API muestra el perfil predeterminado y un perfil definido por el usuario (si se ha creado) para este monitor. El sistema crea el perfil predeterminado, y este se aplica al grupo predeterminado creado por el sistema. El grupo predeterminado contiene todos los nodos de transporte del host ESXi del sistema. El perfil predeterminado se activa de forma predeterminada en todos los nodos de transporte del host.

Para ver la configuración del perfil predeterminado, ejecute la siguiente API:
```
GET https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-stats-monitor/profiles/default-profile
```
(opcional) Ejecute la siguiente API para editar la configuración del perfil predeterminado:
```
PATCH https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-stats-monitor/profiles/default-profile
```
Copie la respuesta de la API GET del perfil predeterminado y péguela en un editor de texto. Edite los valores de configuración del perfil. Por último, envíe la configuración editada en el cuerpo de la solicitud de esta API PATCH.
Escenario de ejemplo:
Supongamos que desea aplicar un perfil definido por el usuario a un conjunto específico de hosts (por ejemplo, A y B), pero quiere aplicar el perfil predeterminado a todos los hosts restantes del sistema. En este caso, debe crear un grupo personalizado que contenga estos dos nodos de transporte del host (A y B). Los grupos con solo miembros del nodo de transporte del host se pueden crear mediante la API de NSX. La interfaz de usuario no admite esta funcionalidad. Una vez creado el grupo, utilícelo en la propiedad applied_to_group_paths del perfil definido por el usuario.

Use la misma API PATCH, como se indicó anteriormente, para crear el perfil definido por el usuario.

Por ejemplo, la siguiente API crea un perfil definido por el usuario con el ID "profile-1":
```
PATCH https://<nsx-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-stats-monitor/profiles/profile-1
```
Cuando esta API se realiza correctamente, el perfil definido por el usuario (profile-1) reemplaza el perfil predeterminado en los nodos de transporte A y B del host. Para el resto de los nodos de transporte del host en el sistema, se aplica el perfil predeterminado.

(opcional) Ejecute la siguiente API para leer el estado de supervisión en un nodo de transporte específico del host:

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

Para obtener el node_id de los nodos de transporte del host, ejecute la siguiente API:

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

Ejecute la siguiente API para ver los valores de un momento específicos de las estadísticas de un nodo de transporte específico del host:
```
GET https://<nsx-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/host-transport-nodes/<host-tn-id>/statistics/monitor
```
Para obtener el node_id del nodo de transporte del host, utilice la misma API, como se indicó en el paso anterior.

Esta API devuelve los valores actualizados en caché de las estadísticas de supervisión de estado para el nodo de transporte del host especificado. De forma predeterminada, solo se devuelven las estadísticas de paquetes para el nodo de transporte del host.
Como se mencionó anteriormente en esta sección, la API puede devolver los siguientes tipos de estadísticas de supervisión de estado para un nodo de transporte del host:
- Estadísticas de paquete (packet_stats). Este es el tipo predeterminado.
- Estadísticas del sistema de rutas rápidas (fast_path_sys_stats)
- Estadísticas de paquetes de plataforma (platform_packet_stats)
- Estadísticas de uso de CPU de la plataforma (platform_cpu_usage_stats)
- Estadísticas de uso de lcore de fastpath (fast_path_lcore_usage_stats)
Cuando se omite el parámetro de consulta type en el URI de la API, la API devuelve solo las estadísticas de paquetes de forma predeterminada.

Para ver las estadísticas de un tipo específico o de varios tipos juntos, utilice el parámetro de consulta type en el URI de la API.
Ejemplo 1: La siguiente API devuelve los valores de un momento específico de las estadísticas del nodo de transporte del host para un solo tipo:
```
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
```
Ejemplo 2: La siguiente API devuelve los valores de un momento específico de las estadísticas del nodo de transporte del host para varios tipos juntos:
```
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
```
Asegúrese de que los tipos se especifiquen en una lista separada por comas y sin espacios antes ni después de las comas.
Ejecute la siguiente API para ver los valores en tiempo real de las estadísticas de estado de un nodo de transporte específico:
```
GET https://<nsx-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/host-transport-nodes/<host-tn-id>/statistics/debug
```
Como se mencionó anteriormente en el paso 5, cuando se omite el parámetro de consulta type en el URI de la API, la API devuelve solo las estadísticas de paquetes de forma predeterminada.

Para ver las estadísticas de un tipo específico o de varios tipos juntos, utilice el parámetro de consulta type en el URI de la API.
Ejemplo 1: La siguiente API devuelve los valores en tiempo real de las estadísticas del nodo de transporte del host para un solo tipo:
```
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
```
Ejemplo 2: La siguiente API devuelve los valores en tiempo real de las estadísticas del nodo de transporte del host para varios tipos juntos:
```
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
```