Vous pouvez utiliser les API de mesures pour extraire les mesures de séries chronologiques.

Ces API peuvent prendre plusieurs chemins d'intention comme entrée pour un type de ressource spécifique, tel qu'Edge ou une passerelle, et renvoyer les mesures correspondantes. Pour obtenir des informations complètes sur l'appel des API de mesures de séries chronologiques, reportez-vous au Guide d'API NSX Intelligence &NSX Application Platform.

La liste suivante contient les termes et leurs descriptions liés aux API de mesures.

Terme Description
Type de ressource Toute entité, telle qu'un nœud Edge ou une passerelle, pour laquelle des mesures sont disponibles.
ID de ressource Chemin d'intention ou identifiant d'un type de ressource.
Objet Sous-entité d'un type de ressource particulier. Par exemple, une règle de pare-feu dans un ensemble de règles.
Clé de mesure Clé unique attribuée à une mesure de n'importe quelle ressource.

Les clés de mesure suivantes sont des exemples de clés disponibles pour les nœuds Edge et NSX Manager :

  • disk.avg_used_percent : pourcentage de blocs en cours d'utilisation par rapport au total.
  • system.avg_load : charge du système moyenne au cours de la dernière minute.
  • system.avg_mem_available_percent : pourcentage de mémoire disponible par rapport à la mémoire totale.
Les clés de mesure suivantes sont des exemples de clés disponibles pour les pare-feu de passerelles :
  • edge_fw.avg_drop_reason_alg : taux moyen d'abandon de pare-feu en raison de la passerelle de couche d'application.
  • edge_fw.avg_drop_reason_connection_limit : taux moyen d'abandon par seconde en raison de la limite de connexion.

Vous pouvez utiliser l'API suivante pour extraire les clés de mesure de n'importe quelle ressource requise.

GET https://<manager>/napp/api/v1/metrics/key-info?resource_type=<resource_type>

Effectuez les étapes suivantes pour extraire les mesures d'une ressource requise. Notez que les clés de mesure utilisées dans des exemples servent uniquement à fournir un échantillon. Utilisez l'API appropriée pour extraire les clés et descriptions réelles.

Étape 1 : sélectionner le type de ressource pour lequel vous souhaitez extraire les mesures de séries chronologiques

Vous pouvez extraire les mesures de séries chronologiques pour les nœuds Edge et les passerelles. Sélectionnez le type de ressource dans la liste suivante.
  • PolicyEdgeNode
  • ClusterNode
  • Tier0Interface
  • Tier1Interface
  • Tier0
  • Tier1

    À partir de NSX 4.0.1.1, vous pouvez également afficher les mesures de séries chronologiques pour VPN à l'aide des types de ressources suivants.

  • PolicyBasedIPSecVpnSession
  • RouteBasedIPSecVpnSession

Étape 2 : obtenir les clés de mesure prises en charge et leurs informations pour un type de ressource

Utilisez l'API suivante pour obtenir des clés de mesure prises en charge pour un type de ressource. L'API prend resource_type comme paramètre de requête et répertorie toutes les mesures disponibles pour cette ressource. Cette API fournit également une description et des unités pour chaque mesure.

Chemin d'accès à l'URI :

GET https://<manager>/napp/api/v1/metrics/key-info?resource_type=<resource_type>

Exemple :

GET https://<manager>/napp/api/v1/metrics/key-info?resource_type=PolicyEdgeNode

Réponse :

{
  "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"
        }
  ]
}

}

Étape 3 : obtenir des informations sur l'objet d'une ressource et d'une clé de mesure

Utilisez l'API suivante pour obtenir les informations d'objet d'une clé de mesure pour un type de ressource requis.

Chemin d'accès à l'URI :

POST https://<manager>/napp/api/v1/metrics/object-info

Exemple de demande :

{
    "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
}

Exemple de réponse :

{
    "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)",
                    
                }
            ]
        }
    ]
}

Étape 4 : extraire les données de mesures

Utilisez l'API suivante pour extraire les données de mesures.

Chemin d'accès à l'URI :

POST https://<manager>/napp/api/v1/metrics/data

Exemple de demande :

{
    "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
}

Exemple de réponse :

{
    "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
                                }
                           }
                    ]
                }
            ]
        }