API-Gateway-Metriken

Informieren Sie sich über die Metriken, die von API Gateway ausgegeben werden.

Mit Metriken , Alarmen undBenachrichtigungen können Sie den Zustand, die Kapazität und die Performance von API-Gateways und API-Deployments, die vom API-Gateway-Service verwaltet werden, überwachen.

In diesem Thema werden die Metriken beschrieben, die vom API-Gateway-Service im Metrik-Namespace oci_apigateway ausgegeben werden.

Ressourcen: Gateways

Überblick über die Metriken des API-Gateway-Service

Mit den Metriken des API-Gateway-Service können Sie die Verbindungen zu API-Gateways sowie die Menge der Daten, die von API-Gateways empfangen und gesendet wurden, ermitteln. Mit Metrikdaten können Sie API-Gateway- und API-Deployment-Probleme diagnostizieren und beheben.

Während die Häufigkeit je nach Metrik variiert, weisen Standardservicemetriken im Allgemeinen eine Häufigkeit von 60 Sekunden auf (d.h. pro Minute wird mindestens ein Datenpunkt gebucht).

Um ein Standardset von Metrikdiagrammen in der Konsole anzuzeigen, navigieren Sie zu dem API-Gateway, an dem Sie interessiert sind, und wählen Sie Metriken aus. Mit dem Monitoring-Service können Sie auch benutzerdefinierte Abfragen erstellen. Siehe Metrikabfragen erstellen.

Voraussetzungen

IAM-Policys: Um Ressourcen zu überwachen, benötigen Sie den erforderlichen Zugriffstyp in einer von einem Administrator geschriebenen Policy . Dabei gilt es unabhängig davon, ob Sie die Konsole oder die REST-API mit einem SDK, einer CLI oder einer anderen Toolanwendung verwenden. Die Policy muss Ihnen Zugriff auf die Monitoringservices und die überwachten Ressourcen erteilen. Wenn Sie versuchen, eine Aktion auszuführen, und eine Meldung erhalten, dass Sie keine Berechtigung haben oder nicht autorisiert sind, fragen Sie bitte den Administrator, welche Art von Zugriff Ihnen erteilt wurden und in welchem Compartment Sie arbeiten müssen. Weitere Informationen zu Benutzerautorisierungen für Monitoring finden Sie unter IAM-Policys.

Verfügbare Metriken: oci_apigateway

Die in den folgenden Tabellen aufgeführten Metriken sind automatisch für alle von Ihnen erstellten API-Gateways verfügbar. Sie müssen Monitoring für die Ressource nicht aktivieren, um diese Metriken abzurufen.

API-Gateway-Metriken umfassen die folgenden Dimensionen:

RESOURCEID: OCID der Ressource, für die die Metriken gelten.
RESOURCENAME: Der Name der Ressource, auf die sich die Metriken beziehen.
DEPLOYMENTID: Die OCID des API-Deployments.
DEPLOYMENT-NAME: Der Name des API-Deployment.
ROUTE: Der Routenpfad für API-Aufrufe an den Backend-Service.
HTTPMETHODTYPE: Die HTTP-Methoden von eingehenden Verbindungen, die vom Backend-Service akzeptiert wurden (z.B. GET, HEAD, POST, PUT, DELETE).
HTTPSTATUSCODE: Der HTTP-Antwortstatuscode, der vom API-Gateway empfangen wurde (z.B. 200, 201, 502, 504).
HTTPSTATUSCATEGORY: Die Kategorie des HTTP-Antwortstatuscodes, der vom API-Gateway empfangen wurde (z.B. 2xx, 3xx, 4xx, 5xx).
BACKEND-NAME: Der Name des Backends (abgeleitet vom Namen der Backend-Regel), an das ein API-Gateway Anforderungen weiterleitet.
BACKENDTYPE: Der Typ des Backends, an das ein API-Gateway Anforderungen an einen Backend-Service weiterleitet (z.B. HTTP_BACKEND, ORACLE_FUNCTIONS_BACKEND, STOCK_RESPONSE_BACKEND).
BACKENDHTTPSTATUSCODE: Der HTTP-Antwortstatuscode, der vom Backend empfangen wurde (z.B. 200, 201, 502, 504).
BACKENDHTTPSTATUSCATEGORY: Die Kategorie des HTTP-Antwortstatuscodes, der vom Backend empfangen wurde (z.B. 2xx, 3xx, 4xx, 5xx).
ANTWORTCACHERESULT: Die vom Antwortcache ausgeführte Aktion (eine der Optionen HIT, MISS, BYPASS).
ENTITLEMENTNAME: Der Name der Berechtigung.
ABONNENTEN-ID: Die OCID des Abonnenten.
ABONNENTENNAME: Der Name des Abonnenten.
CLIENTNAME: Der Name des Subscriber-Clients.
MASSNAHME: Die Aktion, die ausgeführt wird, wenn die maximale Anzahl von Anforderungen im Zeitraum der Quote des Anspruchs überschritten wurde.
NUTZUNGSPLAN-ID: Die OCID des Nutzungsplans.
VERWENDUNGSPLANNAME: Der Name des Nutzungsplans.


Metrik	Metrikanzeigename	Einheit	Beschreibung	Dimensionen
`BytesReceived`	Empfangene Byte	Byte	Anzahl der Byte, die das API-Gateway von API-Clients empfangen hat.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType`
`BytesSent`	Gesendete Byte	Byte	Anzahl der Byte, die das API-Gateway an API-Clients gesendet hat.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType`
`HttpRequests`	API-Anforderungen	Anzahl	Anzahl der beim API-Gateway eingehenden API-Clientanforderungen.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `backendType` `backendName`
`HttpResponses`	API-Antworten	Anzahl	Anzahl der HTTP-Antworten, die vom API-Gateway zurückgesendet wurden.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType` `backendName`
`BackendHttpResponses`	Backend-Antworten	Anzahl	Anzahl der HTTP-Antworten, die von den Backend-Services zurückgesendet wurden.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType` `backendName` `backendHttpStatusCode` `backendHttpStatusCategory`
`Latency`	Gatewaylatenz	Sekunden	Zeit, die benötigt wird, um eine Anforderung zu verarbeiten und ihre Antwort zu senden. Es wird die Zeitspanne zwischen dem Zeitpunkt, zu dem das API-Gateway das erste Byte einer HTTP-Anforderung empfängt, und dem Zeitpunkt, zu dem der Antwortsendevorgang abgeschlossen ist, berechnet. Latenz ist die Summe aus Integrationslatenz und interner Latenz.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType`
`IntegrationLatency`	Integrationslatenz	Sekunden	Zeit, die das API-Gateway aufruft, um externe Integrationen aufzurufen (wie HTTP-Backends, OCI Functions, DNS und Authentifizierungsserver).	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType`
`InternalLatency`	Interne Latenz	Sekunden	Zeit, die intern im API-Gateway für die Verarbeitung der Anforderung aufgewendet wurde.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory`
`ResponseCacheAction`	Antwortcacheaktionen	Anzahl	Die vom Antwortcache ausgeführte Aktion.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `responseCacheResult`
`ResponseCacheAvailability`	Verfügbarkeit des Antwortcaches	Anzahl	Verfügbarkeit des Antwortcaches, wie vom API-Gateway gesehen.	`resourceId` `resourceName`
`ResponseCacheLatency`	Antwortcachelatenz	Millisekunden	Gesamtzeit für Verbindungs-, Lese- und Speichervorgänge im Antwortcache.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route`
`UsagePlanRequests`	Nutzungsplananforderungen	Sum	Anzahl der Anforderungen für einen bestimmten Anspruch. Wird pro Anforderung ausgegeben.	`resourceId` `resourceName` `entitlementName` `subscriberId` `subscriberName` `clientName` `action`
`SubscriberRequests`	Abonnentenanforderungen	Sum	Anzahl der Anforderungen eines Abonnenten. Wird pro Anforderung ausgegeben.	`resourceId` `resourceName` `clientName` `usagePlanId` `usagePlanName` `entitlementName` `action`
`SubscriberQuotaProportionUsed`	Verbrauchter Anteil Abonnenten-Quota	Durchschnitt	Anteil der Quota einer Berechtigung, der von einem Subscriber belegt wurde. Wird pro Anforderung ausgegeben. Berechnet als: `<current number of requests this period> / <quota for entitlement this period>`	`resourceId` `resourceName` `clientName` `usagePlanId` `usagePlanName` `entitlementName`
`SubscriberRateLimitProportionUsed`	Verbrauchter Anteil Abonnentenratenbegrenzung	Durchschnitt	Anteil der von einem Abonnenten verbrauchten Ratenbegrenzung einer Berechtigung. Wird pro Anforderung ausgegeben. Berechnet als: `<current number of requests this period> / <rate limit for entitlement this period>`	`resourceId` `resourceName` `clientName` `usagePlanId` `usagePlanName` `entitlementName`

Konsole verwenden

So zeigen Sie Standardmetrikdiagramme für ein einzelnes API-Gateway an

Wählen Sie auf der Listenseite Gateways das API-Gateway aus, für das Sie Metriken anzeigen möchten. Wenn Sie Hilfe beim Suchen der Listenseite oder des API-Gateways benötigen, finden Sie weitere Informationen unter API-Gateways auflisten.
Wählen Sie unter Ressourcen die Option Metriken aus.

Auf der Seite "Metriken" wird ein Diagramm für jede Metrik angezeigt, die vom Metrik-Namespace für API-Gateway ausgegeben wird. Weitere Informationen zu den ausgegebenen Metriken finden Sie unter Verfügbare Metriken: oci_apigateway.

Weitere Informationen zu Monitoringmetriken und zur Verwendung von Alarmen finden Sie in Überblick über Monitoring. Informationen zu Benachrichtigungen für Alarme finden Sie unter Überblick über Benachrichtigungen.

Die erwarteten API-Gateway-Metrikdaten werden nicht angezeigt?

Wenn die erwarteten Metrikdaten für ein API-Gateway nicht angezeigt werden, sollten Sie sich die folgenden möglichen Ursachen und Lösungen ansehen.


Problem	Mögliche Ursache	Prüfung	Lösung
Ich habe eine in einem API-Gateway bereitgestellte API aufgerufen, aber das Diagramm HTTP-Anforderungen zeigt den API-Aufruf nicht an.	Möglicherweise haben Sie die API außerhalb des Zeitraums aufgerufen, der von dem Diagramm HTTP-Anforderungen abgedeckt wird.	Bestätigen Sie, dass die Startzeit und die Endzeit den Zeitraum abdecken, in dem Sie die API aufgerufen haben.	Passen Sie die Startzeit und die Endzeit nach Bedarf an.
Ich habe eine in einem API-Gateway bereitgestellte API aufgerufen, aber das Diagramm HTTP-Anforderungen zeigt den API-Aufruf nicht an, obwohl ich die API zwischen der Startzeit und der Endzeit aufgerufen habe.	Auch wenn Sie die API zwischen der Startzeit und der Endzeit aufgerufen haben, kann es sein, dass die X-Achse (Datenanzeigefenster) den API-Aufruf ausschließt.	Bestätigen Sie, dass die X-Achse (Datenanzeigefenster) den Zeitraum abdeckt, in dem die API aufgerufen wurde.	Passen Sie die X-Achse (Datenanzeigefenster) nach Bedarf an.
Ich möchte Daten in den Diagrammen als fortlaufende Zeitstrahllinie anzeigen, diese weist jedoch Lücken auf.	Dies ist ein erwartetes Verhalten. Wenn es für das ausgewählte Intervall keine Metrikdaten gibt, wird keine fortlaufende Datenlinie angezeigt.	Erhöhen Sie das Intervall (z.B. von 1 Minute auf 5 Minuten oder von 1 Minute auf 1 Stunde).	Passen Sie das Intervall nach Bedarf an.

So zeigen Sie Standardmetrikdiagramme für alle API-Gateways in einem Compartment an

Öffnen Sie das Navigationsmenü , und wählen Sie Observability and Management aus. Wählen Sie unter Monitoring die Option Servicemetriken aus.
Wählen Sie die Region aus, die Sie mit API-Gateway verwenden.
Wählen Sie das Compartment aus, das die API-Gateways enthält, für die Sie Metriken anzeigen möchten.
Wählen Sie unter Metrik-Namespace die Option oci_apigateway aus.

Die Seite Servicemetriken wird dynamisch aktualisiert und zeigt Diagramme für jede vom ausgewählten Metrik-Namespace ausgegebene Metrik an. Weitere Informationen zu den ausgegebenen Metriken finden Sie unter Verfügbare Metriken: oci_apigateway.

Weitere Informationen zu Monitoringmetriken und zur Verwendung von Alarmen finden Sie in Überblick über Monitoring. Informationen zu Benachrichtigungen für Alarme finden Sie unter Überblick über Benachrichtigungen.

API verwenden

Informationen zur Verwendung der API und zu Signieranforderungen finden Sie unter REST-API-Dokumentation und Sicherheitszugangsdaten. Informationen zu SDKs finden Sie unter SDKs und die CLI.

Verwenden Sie die folgenden APIs für das Monitoring:

Monitoring-API für Metriken und Alarme
Notifications-API für Benachrichtigungen (umfasst Alarme)