Amazon API Gateway-Dimensionen und -Metriken - Amazon API Gateway

Amazon API Gateway-Dimensionen und -Metriken

Die Metriken und Dimensionen, die API Gateway an Amazon CloudWatch sendet, sind unten aufgeführt. Weitere Informationen finden Sie unter Überwachung von REST-API-Ausführung mit Amazon CloudWatch-Metriken.

API Gateway-Metriken

Amazon API Gateway sendet einmal pro Minute Metrikdaten an CloudWatch.

Der AWS/ApiGateway-Namespace enthält die folgenden Metriken.

Metrik Beschreibung

4XXError

Die Anzahl der erfassten clientseitigen Fehler innerhalb eines bestimmten Zeitraums.

Die Statistik Sum repräsentiert diese Metrik, also die Gesamtzahl der 4XXError-Fehler in dem angegebenen Zeitraum. Die Statistik Average repräsentiert die 4XXError-Fehlerrate, also die Gesamtzahl der 4XXError-Fehler geteilt durch die Gesamtzahl der Anforderungen innerhalb des Zeitraums. Der Nenner entspricht der Count-Metrik (unten).

Unit: Count

5XXError

Die Anzahl der erfassten serverseitigen Fehler innerhalb eines bestimmten Zeitraums

Die Statistik Sum repräsentiert diese Metrik, also die Gesamtzahl der 5XXError-Fehler in dem angegebenen Zeitraum. Die Statistik Average repräsentiert die 5XXError-Fehlerrate, also die Gesamtzahl der 5XXError-Fehler geteilt durch die Gesamtzahl der Anforderungen innerhalb des Zeitraums. Der Nenner entspricht der Count-Metrik (unten).

Unit: Count

CacheHitCount

Die Anzahl aller vom API-Cache innerhalb eines bestimmten Zeitraums bedienten Anforderungen

Die Statistik Sum repräsentiert diese Metrik, also die Gesamtzahl der Cache-Zugriffe innerhalb des angegebenen Zeitraums. Die Statistk Average stellt die Cache-Zugriffsrate, also die Gesamtzahl der Cache-Zugriffe geteilt durch die Gesamtzahl der Anforderungen innerhalb des Zeitraums, dar. Der Nenner entspricht der Count-Metrik (unten).

Unit: Count

CacheMissCount

Die Anzahl aller vom Backend innerhalb eines bestimmten Zeitraums bedienten Anforderungen, wenn das API-Caching aktiviert ist

Die Statistik Sum repräsentiert diese Metrik, also die Gesamtzahl der Cache-Fehler innerhalb des angegebenen Zeitraums. Die Statistik Average repräsentiert die Cache-Fehlerrate, also die Gesamtzahl der Cache-Fehler geteilt durch die Gesamtzahl der Anforderungen innerhalb des Zeitraums. Der Nenner entspricht der Count-Metrik (unten).

Unit: Count

Count

Die Gesamtzahl der API-Anforderungen innerhalb eines bestimmten Zeitraums

Die Statistik SampleCount stellt diese Metrik dar.

Unit: Count

IntegrationLatency

Die Zeit zwischen dem Zeitpunkt, zu dem API Gateway eine Anfrage an das Backend weiterleitet und zu dem Zeitpunkt, zu dem es eine Antwort vom Backend erhält.

Unit: Millisecond

Latency

Die Zeit zwischen dem Zeitpunkt, zu dem API Gateway eine Anfrage von einem Client empfängt, und dem Zeitpunkt, an dem es eine Antwort an den Client zurückgibt. Die Latenzzeit schließt die Integrationslatenzzeit und anderen API Gateway-Overhead ein.

Unit: Millisecond

Dimensionen für Metriken

Sie können die Dimensionen in der folgenden Tabelle verwenden, um API Gateway-Metriken zu filtern.

Anmerkung

API Gateway entfernt Nicht-ASCII-Zeichen aus der ApiName-Dimension, bevor Metriken an CloudWatch gesendet werden. Wenn der APIName keine ASCII-Zeichen enthält, wird die API ID als ApiName verwendet.

Dimension Beschreibung

ApiName

Filtert API Gateway-Metriken für die REST-API mit dem angegebenen API-Namen.

ApiName, Method, Resource, Stage

Filtert API Gateway-Metriken für die API-Methode mit dem angegebenen API-Namen, der Stufe, Ressource und Methode.

API Gateway sendet diese Metriken nur dann, wenn Sie detaillierte CloudWatch-Metriken explizit aktiviert haben. Dies ist in der Konsole möglich, indem Sie auf der Registerkarte Logs/Tracing (Protokolle/Nachverfolgung) einer Stufe Enable Detailed CloudWatch Metrics (Detaillierte CloudWatch-Metriken aktivieren) auswählen. Alternativ können Sie den AWS CLI-Befehl update-stage aufrufen, um die metricsEnabled-Eigenschaft zu true zu aktualisieren.

Durch die Aktivierung dieser Metriken wird Ihr Konto mit zusätzlichen Gebühren belastet. Preisinformationen finden Sie unter Amazon CloudWatch-Preisinformationen.

ApiName, Stage

Filtert API Gateway-Metriken für die API-Stufenressource mit dem angegebenen API-Namen und der Stufe.