È possibile utilizzare le API delle metriche per recuperare le metriche delle serie temporali.

Queste API possono utilizzare più percorsi di intenti come input per un tipo di risorsa specifico, ad esempio Edge o gateway, e restituiscono le metriche corrispondenti. Per informazioni complete su come richiamare le API delle metriche delle serie temporali, vedere Guida alle API di NSX Intelligence e NSX Application Platform.

L'elenco seguente contiene i termini relativi alle API delle metriche e le rispettive descrizioni.

Termine Descrizione
Tipo di risorsa Qualsiasi entità, ad esempio il nodo Edge o il gateway, per cui sono disponibili le metriche.
ID risorsa Percorso dell'intento o identificatore per un tipo di risorsa.
Oggetto Entità secondaria di un particolare tipo di risorsa. Ad esempio, una regola del firewall all'interno di un set di regole.
Chiave della metrica Chiave univoca assegnata alla metrica di qualsiasi risorsa.

Le chiavi delle metriche seguenti sono esempi di chiavi disponibili per i nodi Edge e NSX Manager:

  • disk.avg_used_percent: percentuale di blocchi in uso sul totale.
  • system.avg_load: carico di sistema medio nell'ultimo minuto.
  • system.avg_mem_available_percent: percentuale di memoria disponibile rispetto alla memoria totale.
Le chiavi delle metriche seguenti sono esempi di chiavi disponibili per i firewall del gateway:
  • edge_fw.avg_drop_reason_alg: frequenza media di rilascio del firewall a causa del gateway a livello di applicazione.
  • edge_fw.avg_drop_reason_connection_limit: velocità media di rilascio al secondo a causa dei limiti della connessione.

È possibile utilizzare l'API seguente per recuperare le chiavi delle metriche di qualsiasi risorsa necessaria.

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

Eseguire i passaggi seguenti per recuperare le metriche per una risorsa necessaria. Si tenga presente che le chiavi delle metriche utilizzate negli esempi sono a solo scopo esemplificativo. Utilizzare l'API appropriata per recuperare le chiavi e le descrizioni effettive.

Passaggio 1: selezionare il tipo di risorsa per cui si desidera recuperare le metriche delle serie temporali

È possibile recuperare le metriche delle serie temporali per i nodi Edge e i gateway. Selezionare il tipo di risorsa nell'elenco seguente.
  • PolicyEdgeNode
  • ClusterNode
  • Tier0Interface
  • Tier1Interface
  • Tier0
  • Tier1

Passaggio 2: recuperare le chiavi delle metriche supportate e le relative informazioni per un tipo di risorsa

Utilizzare l'API seguente per recuperare le chiavi delle metriche supportate per un tipo di risorsa. L'API accetta resource_type come parametro di query ed elenca tutte le metriche disponibili per tale risorsa. Questa API fornisce anche la descrizione e le unità per ogni metrica.

Percorso URI:

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

Esempio:

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

Risposta:

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

}

Passaggio 3: recuperare le informazioni sull'oggetto per una risorsa e la chiave di una metrica

Utilizzare l'API seguente per recuperare le informazioni sull'oggetto della chiave di una metrica per un tipo di risorsa obbligatorio.

Percorso URI:

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

Richiesta di esempio:

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

Risposta di esempio:

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

Passaggio 4: recuperare i dati delle metriche

Utilizzare l'API seguente per recuperare i dati delle metriche.

Percorso URI:

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

Richiesta di esempio:

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

Risposta di esempio:

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