Zum Abrufen der Zeitreihenmetriken können Sie die Metrik-APIs verwenden. Ab NSX 4.1.1 können Sie auch die Metrik-API verwenden, um den Status verschiedener Entitäten wie Edge- und Transportknoten abzurufen.

Diese APIs können mehrere Absichtspfade als Eingabe für einen bestimmten Ressourcentyp verwenden, z. B. Edge oder Gateway, und geben die entsprechenden Metriken zurück. Vollständige Informationen zum Aufrufen der Zeitreihenmetrik-APIs finden Sie im Handbuch für die NSX Intelligence- und NSX Application Platform-API.

Die folgende Liste enthält Begriffe und deren Beschreibungen im Zusammenhang mit Metrik-APIs.

Begriff Beschreibung
Ressourcentyp Jede Entität, z. B. Edge-Knoten oder Gateway, für die Metriken verfügbar sind.
Ressourcen-ID Absichtspfad oder ein Bezeichner für einen Ressourcentyp.
Objekt Unterentität eines bestimmten Ressourcentyps. Beispiel: Firewallregel innerhalb eines Regelsatzes.
Schlüssel

Eindeutiger Schlüssel, der einer Metrik einer beliebigen Ressource zugewiesen ist.

Die folgenden Schlüssel sind Beispiele für Metrikschlüssel, die für Edge-Knoten und NSX Manager verfügbar sind:

  • disk.avg_used_percent: Prozentsatz der verwendeten Blöcke im Verhältnis zur Gesamtanzahl.
  • system.avg_load: Die durchschnittliche Systemlast in der letzten 1 Minute.
  • system.avg_mem_available_percent: Prozentsatz des verfügbaren Arbeitsspeichers im Verhältnis zum Gesamtarbeitsspeicher.
Die folgenden Schlüssel sind Beispiele für Metrikschlüssel, die für Gateway-Firewalls verfügbar sind:
  • edge_fw.avg_drop_reason_alg: Durchschnittliche Firewallverlustrate aufgrund des Anwendungs-Layer-Gateways.
  • edge_fw.avg_drop_reason_connection_limit: Durchschnittliche Verlustrate pro Sekunde aufgrund des Verbindungsgrenzwerts.
Die folgenden Schlüssel sind als Statusschlüssel verfügbar:

  • cluster.overall_status

  • cluster.group_status (pro Gruppenstatus für Knoten)

  • cluster.group_member_status (Status pro Knoten für eine Gruppe)

  • tn.admin_status

  • tn.link_status
  • tn.ccp_connection_status_from_tn

Sie können die folgende API verwenden, um Schlüssel einer beliebigen erforderlichen Ressource abzurufen.

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

Führen Sie die folgenden Schritte aus, um Metriken für eine erforderliche Ressource abzurufen. Beachten Sie, dass die in Beispielen verwendeten Metrikschlüssel nur der Veranschaulichung dienen. Verwenden Sie die entsprechende API, um tatsächliche Schlüssel und Beschreibungen abzurufen.

Schritt 1: Ressourcentyp auswählen, für den Sie die Zeitreihenmetriken abrufen möchten

Sie können Zeitreihenmetriken für Edge-Knoten und Gateways abrufen. Wählen Sie den Ressourcentyp aus der folgenden Liste aus:
  • PolicyEdgeNode
  • ClusterNode
  • Tier0Interface
  • Tier1Interface
  • Tier0
  • Tier1
  • PolicyBasedIPSecVpnSession
  • RouteBasedIPSecVpnSession

Schritt 2: Abrufen unterstützter Schlüssel und deren Informationen für einen Ressourcentyp

Verwenden Sie die folgende API, um unterstützte Schlüssel für einen Ressourcentyp abzurufen. Die API verwendet resource_type als Abfrageparameter und listet alle Schlüssel auf, die für diese Ressource verfügbar sind. Das Feld value_type in der Antwort gibt an, ob es sich bei dem Schlüssel um einen Metrikschlüssel oder einen Statusschlüssel handelt. Wenn der Wert in diesem Feld „Double“ lautet, ist der Schlüssel ein Metrikschlüssel, wenn der Wert „string“ lautet, ist der Schlüssel ein Statusschlüssel. Für einen Metrikschlüssel stellt diese API auch Beschreibungen und Einheiten für jede Metrik bereit.

URI-Pfad:

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

Beispiel:

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

Antwort:

{
  "results":[
        {
            "aggregate_by_resource_ids" : false,
            "key ":"edge.cpu_usage",
            "metric_unit":"PERCENT",
            "description":"Edge Cpu usage percentage"
            "value_type": "DOUBLE"
        },
     {
            "aggregate_by_resource_ids" : false,
            "key":"edge.pnic_avg_rx_packets",
            "metric_unit":"PER_SECOND"
            "description":"Average Rx packets per second"
            "value_type": "DOUBLE"
        }
  ]
}

}

Schritt 3: Objektinformationen für eine Ressource und einen Schlüssel abrufen

Verwenden Sie die folgende API, um die Objektinformationen eines Schlüssels für einen erforderlichen Ressourcentyp abzurufen.

URI-Pfad:

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

Beispielanforderung:

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

Beispielantwort:

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

Schritt 4: Daten abrufen

Verwenden Sie die folgende API, um die Daten abzurufen.

URI-Pfad:

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

Beispielanforderung:

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

Beispielantwort:

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