Puede utilizar las API de métricas para recuperar las métricas de serie temporal.
Estas API pueden tomar varias rutas de intención como entrada para un tipo de recurso específico, como Edge o puerta de enlace, y devolver las métricas correspondientes. Para obtener información completa sobre cómo invocar las API de métricas de serie temporal, consulte la Guía de API de NSX Intelligence y NSX Application Platform.
La siguiente lista contiene términos y sus descripciones relacionados con las API de métricas.
| Término | Descripción |
|---|---|
| Tipo de recurso | Cualquier entidad, como el nodo de Edge o la puerta de enlace, para la que hay métricas disponibles. |
| Identificador de recurso | Ruta de intención o un identificador para un tipo de recurso. |
| Objeto | Subentidad de un tipo de recurso en particular. Por ejemplo, una regla de firewall dentro de un conjunto de reglas. |
| Clave métrica | Clave única asignada a una métrica de cualquier recurso. Las siguientes claves de métricas son ejemplos de claves disponibles para los nodos de Edge y NSX Manager:
Las siguientes claves de métricas son ejemplos de claves disponibles para los firewalls de puerta de enlace:
Puede utilizar la siguiente API para recuperar claves de métricas de cualquier recurso requerido.
|
Realice los siguientes pasos para recuperar métricas para un recurso requerido. Tenga en cuenta que las claves de métricas utilizadas en los ejemplos son solo para fines de muestra. Utilice la API adecuada para recuperar las claves y las descripciones reales.
Paso 1: Seleccione el tipo de recurso para el que desea obtener las métricas de serie temporal
- PolicyEdgeNode
- ClusterNode
- Tier0Interface
- Tier1Interface
- Tier0
- Tier1
Paso 2: Obtener claves de métricas compatibles y su información para un tipo de recurso
Utilice la siguiente API para obtener claves de métricas compatibles para un tipo de recurso. La API toma resource_type como parámetro de consulta y enumera todas las métricas que están disponibles para ese recurso. Esta API también proporciona una descripción y unidades para cada métrica.
Ruta de URI:
GET https://<manager>/napp/api/v1/metrics/key-info?resource_type=<resource_type>
Ejemplo:
GET https://<manager>/napp/api/v1/metrics/key-info?resource_type=PolicyEdgeNode
Respuesta:
{
"results":[
{
"metric_key ":"edge.cpu_usage",
"metric_unit":"PERCENT",
"description":"Edge Cpu usage percentage"
},
{
"metric_key":"edge.pnic_avg_rx_packets",
"metric_unit":"PER_SECOND"
"description":"Average Rx packets per second"
}
]
}
}
Paso 3: Obtener información de objeto para un recurso y una clave de métrica
Utilice la siguiente API para obtener la información del objeto de una clave de métrica para un tipo de recurso requerido.
Ruta de URI:
POST https://<manager>/napp/api/v1/metrics/object-info
Ejemplo de solicitud:
{
"resource_type":"PolicyEdgeNode",
"resource_ids": [
"/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/2ed9af04-21c9-11e9-be65-000c2902dff7",
"/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/1349af04-21c9-11e9-be65-000c2902d0000"
],
"keys": [ "edge_cores.cpu_usage", "edge.pnic_avg_rx_packets"],
"start_time":1603971420
"end_time": 1603973420
"granularity": "5M",
"max_num_data_points": 10
}
Ejemplo de respuesta:
{
"start_time": 1603971420,
"end_time": 1603973420,
"resource_type": "PolicyEdgeNode",
"results": [
{
"resource_id": "/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/2ed9af04-21c9-11e9-be65-000c2902dff7",
"key_results": [
{
"key": "edge.pnic_avg_rx_packets",
"unit": "PER_SECOND",
},
{
"key": "edge_core.cpu_usage",
"results": [
{
"object_id": "core1",
"node_id": "2ed9af04-21c9-11e9-be65-000c2902dff7",
"node_path": "/infra/default/edge/1",
node_name": "Edge1",
},
{
"object_id": "core2",
"node_id": "2ed9af04-21c9-11e9-be65-000c2902dff7",
"node_path": "/infra/default/edge/1",
"node_name": "Edge1",
}
]
}
]
},
{
"resource_id": "/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/1349af04-21c9-11e9-be65-000c2902d0000",
"key_results": [
{
"key": "edge.pnic_avg_rx_packets",
"unit": "PER_SECOND",
"description": "Average packet per second (PPS) network utilization on ingress on the the management interface(s)",
}
]
}
]
}
Paso 4: Obtener datos de métricas
Utilice la siguiente API para recuperar datos de métricas.
Ruta de URI:
POST https://<manager>/napp/api/v1/metrics/data
Ejemplo de solicitud:
{
"resource_type":"PolicyEdgeNode",
"resource_ids": [
"/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/2ed9af04-21c9-11e9-be65-000c2902dff7",
"/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/1349af04-21c9-11e9-be65-000c2902d0000"
],
"object_ids": ["core1" ,"core2"],
"node_ids": [],
"keys": [ "edge_cores.cpu_usage", "edge.pnic_avg_rx_packets"],
"start_time":1603971420
"end_time": 1603973420
"granularity": "5M",
"max_num_data_points": 10
}
Ejemplo de respuesta:
{
"start_time": 1603971420, --> output start_time and end_time maybe different from input start_time and end_time
"end_time": 1603973420,
"resource_type": "PolicyEdgeNode",
"results": [
{
"path": "/infra/sites/default/enforcement-points/default/edge-clusters/57d2c653-4d63-48d8-b188-40b4e45a9bc8/edge-nodes/2ed9af04-21c9-11e9-be65-000c2902dff7",
"key_results": [
{
{
"key": "edge_core.cpu_usage",
"results": [
{
"object_id": "core1",
"node_id": "2ed9af04-21c9-11e9-be65-000c2902dff7",
"data": [
{
"time": 1603444589,
"value": 29
},
{
"time": 1603444489,
"value": 30
},
{
"time": 1603444389,
"value": 35
}
},
{
"object_id": "core2",
"object_description": "Some description",
"node_id": "2ed9af04-21c9-11e9-be65-000c2902dff7",
"node_name": "Edge1",
"node_path":"/infra/default/edge/1"
"data": [
{
"time": 1603444589,
"value": 29
},
{
"time": 1603444489,
"value": 30
},
{
"time": 1603444389,
"value": 35
}
}
]
}
]
}
