Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
# Überwachen Sie die REST-API-Ausführung mit CloudWatch Amazon-Metriken
Sie können die API-Ausführung überwachen CloudWatch, indem Sie die Rohdaten von API Gateway sammeln und in lesbare near-real-time Metriken umwandeln. Diese Statistiken werden für einen Zeitraum von 15 Monaten aufgezeichnet, damit Sie auf Verlaufsinformationen zugreifen können und einen besseren Überblick darüber erhalten, wie Ihre Webanwendung oder der Service ausgeführt wird. Standardmäßig werden API-Gateway-Metrikdaten automatisch innerhalb von CloudWatch einer Minute gesendet. Weitere Informationen finden Sie unter [Was ist Amazon CloudWatch?](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html) im * CloudWatch Amazon-Benutzerhandbuch*.
Die von API Gateway gemeldeten Metriken bieten Informationen, die Sie auf unterschiedliche Weise analysieren können. Die folgende Liste zeigt einige häufige Verwendungszwecke für die Metriken, die Vorschläge für den Einstieg sind:
+ Überwachen Sie die **IntegrationLatency**-Metriken, um die Reaktionsfähigkeit des Backends zu messen.
+ Überwachen Sie die **Latency**-Metriken, um die allgemeine Reaktionsfähigkeit Ihrer API-Aufrufe zu messen.
+ Überwachen Sie die **CacheHitCount**- und **CacheMissCount**-Metriken, um die Cache-Kapazitäten zu optimieren und die gewünschte Leistung zu erreichen.
**Topics**
+ [Amazon API Gateway-Dimensionen und -Metriken](api-gateway-metrics-and-dimensions.md)
+ [Anzeigen von CloudWatch-Metriken mit dem API-Dashboard in API Gateway](how-to-api-dashboard.md)
+ [API Gateway Gateway-Metriken in der CloudWatch Konsole anzeigen](metrics_dimensions_view_in_cloud_watch.md)
+ [API Gateway Gateway-Protokollereignisse in der CloudWatch Konsole anzeigen](view-cloudwatch-log-events-in-cloudwatch-console.md)
+ [Überwachungstools AWS für API Gateway](monitoring_automated_manual.md)
# Amazon API Gateway-Dimensionen und -Metriken
Die Metriken und Dimensionen, die API Gateway an Amazon sendet, CloudWatch sind unten aufgeführt. Weitere Informationen finden Sie unter [Überwachen Sie die REST-API-Ausführung mit CloudWatch Amazon-Metriken](monitoring-cloudwatch.md).
## API Gateway-Metriken
Amazon API Gateway sendet Metrikdaten an CloudWatch jede Minute.
Der `AWS/ApiGateway`-Namespace enthält die folgenden Metriken.
| Metrik | Beschreibung |
| --- | --- |
| 4XXError | Die Anzahl der erfassten clientseitigen Fehler innerhalb eines bestimmten Zeitraums. API Gateway zählt modifizierte Gateway-Antwortstatuscodes als 4 XXError Fehler. 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 gesendet werden. CloudWatch 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, wenn Sie detaillierte CloudWatch Metriken explizit aktiviert haben. Wählen Sie in der Konsole eine Stufe aus, und klicken Sie dann unter **Ptotokolle und Nachverfolgung** auf **Bearbeiten**. Wählen Sie **Detaillierte Metriken** aus und klicken Sie dann auf **Änderungen speichern**. Alternativ können Sie den AWS CLI Befehl [update-stage](https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-stage.html) aufrufen, um die `metricsEnabled` Eigenschaft zu aktualisieren. `true` Durch die Aktivierung dieser Metriken wird Ihr Konto mit zusätzlichen Gebühren belastet. Preisinformationen finden Sie unter [ CloudWatchAmazon-Preise](https://aws.amazon.com/cloudwatch/pricing/). |
| ApiName, Stage | Filtert API Gateway-Metriken für die API-Stufenressource mit dem angegebenen API-Namen und der Stufe. |
# Anzeigen von CloudWatch-Metriken mit dem API-Dashboard in API Gateway
Sie können das API-Dashboard in der API Gateway-Konsole verwenden, um die CloudWatch-Metriken Ihrer bereitgestellten API in API Gateway anzuzeigen. Diese werden als eine Zusammenfassung der API-Aktivität im Zeitverlauf angezeigt.
**Topics**
+ [Voraussetzungen](#how-to-api-dashboard-prerequisites)
+ [Untersuchen von API-Aktivitäten im Dashboard](#how-to-api-dashboard-console)
## Voraussetzungen
1. Sie müssen über eine in API Gateway erstellte API verfügen. Folgen Sie den Anweisungen in [Entwickeln Sie REST APIs in API Gateway](rest-api-develop.md).
1. Sie müssen die API mindestens einmal bereitgestellt haben. Folgen Sie den Anweisungen in [REST-APIs in API Gateway bereitstellen](how-to-deploy-api.md).
## Untersuchen von API-Aktivitäten im Dashboard
1. Melden Sie sich bei der API Gateway-Konsole unter [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway) an.
1. Wählen Sie eine API aus.
1. Wählen Sie im Haupt-Navigationsbereich **Dashboard** aus.
1. Wählen Sie für **Stufe** die gewünschte Stufe aus.
1. Wählen Sie **Datumsbereich** aus, um einen Datumsbereich anzugeben.
1. Aktualisieren Sie bei Bedarf einzelne Metriken in separaten Grafiken mit den Titeln **API-Aufrufe**, **Latenz**, **Integrationslatenz**, **Latenz**, **4xx-Fehler** und **5xx-Fehler**.
**Tipp**
Um die CloudWatch-Metriken auf Methodenebene zu untersuchen, stellen Sie sicher, dass Sie CloudWatch Logs auf einer Methodenebene aktiviert haben. Weitere Informationen zum Einrichten der Protokollierung auf Methodenebene finden Sie unter [Überschreiben der Einstellungen auf Stufenebene](set-up-stages.md#how-to-method-override).
# API Gateway Gateway-Metriken in der CloudWatch Konsole anzeigen
Metriken werden zunächst nach dem Service-Namespace und anschließend nach den verschiedenen Dimensionskombinationen in den einzelnen Namespaces gruppiert. Aktivieren Sie „Detaillierte Metriken“, um die Metriken auf Methodenebene für Ihre API anzuzeigen. Weitere Informationen finden Sie unter [Ändern der Stufeneinstellungen](set-up-stages.md#how-to-stage-settings).
**So zeigen Sie API Gateway Gateway-Metriken mit der CloudWatch Konsole an**
1. Öffnen Sie die CloudWatch Konsole unter [https://console.aws.amazon.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/).
1. Ändern Sie, falls erforderlich, die AWS-Region. Wählen Sie in der Navigationsleiste die Region aus, in der sich Ihre AWS Ressourcen befinden.
1. Wählen Sie im Navigationsbereich **Metrics** aus.
1. Klicken Sie auf der Registerkarte **All metrics** auf **API Gateway**.
1. Klicken Sie auf den Bereich **By Stage**, um Metriken nach Phase anzuzeigen. Wählen Sie dann Ihre Namen APIs und die Namen der Metriken aus.
1. Klicken Sie auf den Bereich **By Api Name**, um Metriken für eine bestimmte API anzuzeigen. Wählen Sie dann Ihre Namen APIs und die Namen der Metriken aus.
**So zeigen Sie Metriken mit der AWS CLI an**
1. Verwenden Sie den folgenden [list-metrics](https://docs.aws.amazon.com/cli/latest/reference/cloudwatch/list-metrics.html)-Befehl, um Metriken aufzuführen:
```
aws cloudwatch list-metrics --namespace "AWS/ApiGateway"
```
Nachdem Sie eine Metrik erstellt haben, kann es bis zu 15 Minuten dauern, bis die Metrik angezeigt wird. Verwenden Sie [get-metric-data](https://docs.aws.amazon.com/cli/latest/reference/cloudwatch/update-domain-name.html)oder, um Metrikstatistiken schneller zu sehen [get-metric-statistics](https://docs.aws.amazon.com/cli/latest/reference/cloudwatch/update-domain-name.html).
1. Verwenden Sie den folgenden [get-metrics-statistics](https://docs.aws.amazon.com/cli/latest/reference/cloudwatch/get-metric-statistics.html)Befehl, um den Durchschnitt über einen bestimmten Zeitraum in Intervallen von 5 Minuten anzuzeigen:
```
aws cloudwatch get-metric-statistics --namespace AWS/ApiGateway --metric-name Count --start-time 2011-10-03T23:00:00Z --end-time 2017-10-05T23:00:00Z --period 300 --statistics Average
```
# API Gateway Gateway-Protokollereignisse in der CloudWatch Konsole anzeigen
Im folgenden Abschnitt werden die erforderlichen Voraussetzungen und die Anzeige von API-Gateway-Protokollereignissen in der CloudWatch Konsole erläutert.
## Voraussetzungen
1. Sie müssen über eine in API Gateway erstellte API verfügen. Folgen Sie den Anweisungen in [Entwickeln Sie REST APIs in API Gateway](rest-api-develop.md).
1. Sie müssen die API mindestens einmal in der API bereitgestellt haben. Befolgen Sie die Anweisungen unter [REST-APIs in API Gateway bereitstellen](how-to-deploy-api.md) und [Aufrufen von REST-APIs in API Gateway](how-to-call-api.md).
1. Sie müssen CloudWatch Logs für eine Phase aktiviert haben. Folgen Sie den Anweisungen in [Richten Sie die CloudWatch Protokollierung für REST APIs in API Gateway ein](set-up-logging.md).
## Um protokollierte API-Anfragen und -Antworten mit der CloudWatch Konsole anzuzeigen
1. Öffnen Sie die CloudWatch Konsole unter [https://console.aws.amazon.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/).
1. Ändern Sie, falls erforderlich, die AWS-Region. Wählen Sie in der Navigationsleiste die Region aus, in der sich Ihre AWS Ressourcen befinden. Weitere Informationen finden Sie unter [-Regionen und Endpunkte](https://docs.aws.amazon.com/general/latest/gr/rande.html).
1. Wählen Sie im Navigationsbereich **Logs (Protokolle)**, **Log groups (Protokollgruppen)** aus.
1. Wählen Sie in der Tabelle **Protokollgruppen** eine Protokollgruppe mit dem Namen **API-Gateway-Execution-Logs\$1** \$1\$1/\$1stage-name\$1 aus. rest-api-id
1. Wählen Sie in der Tabelle **Log Streams** einen Protokoll-Stream aus. Sie können den gewünschten Protokoll-Stream anhand des Zeitstempels finden.
1. Klicken Sie auf **Text**, um den reinen Text anzuzeigen, oder klicken Sie auf **Row**, um das Ereignis zeilenweise anzuzeigen.
**Wichtig**
CloudWatch ermöglicht das Löschen von Protokollgruppen oder Streams. Löschen Sie API Gateway-API-Protokollgruppen oder -Streams nicht manuell. Lassen Sie API Gateway diese Ressourcen verwalten. Wenn Sie Protokollgruppen oder Streams manuell löschen, werden API-Anforderungen und -Antworten möglicherweise nicht protokolliert. In diesem Fall können Sie die gesamte Protokollgruppe für die API löschen und die API erneut bereitstellen. Dies liegt daran, dass API Gateway Protokollgruppen oder -Streams einer API-Stufe zum Zeitpunkt der Bereitstellung erstellt.
# Überwachungstools AWS für API Gateway
AWS bietet verschiedene Tools, mit denen Sie API Gateway überwachen können. Sie können einige dieser Tools für die automatische Überwachung konfigurieren, während andere manuellen Eingriff erfordern. Wir empfehlen, dass Sie die Überwachungsaufgaben möglichst automatisieren.
## Automatisierte Überwachungstools in AWS
Sie können die folgenden automatisierten Tools zur Überwachung von API Gateway verwenden und auftretende Probleme melden:
+ **Amazon CloudWatch Alarms** — Überwachen Sie eine einzelne Metrik über einen von Ihnen angegebenen Zeitraum und führen Sie eine oder mehrere Aktionen aus, die auf dem Wert der Metrik im Verhältnis zu einem bestimmten Schwellenwert über mehrere Zeiträume basieren. Die Aktion ist eine Benachrichtigung, die an ein Amazon Simple Notification Service (Amazon SNS) -Thema oder eine Amazon EC2 Auto Scaling Scaling-Richtlinie gesendet wird. CloudWatch Alarme lösen keine Aktionen aus, nur weil sie sich in einem bestimmten Status befinden. Der Status muss sich geändert haben und für eine bestimmte Anzahl von Zeiträumen beibehalten worden sein. Weitere Informationen finden Sie unter [Überwachen Sie die REST-API-Ausführung mit CloudWatch Amazon-Metriken](monitoring-cloudwatch.md).
+ **Amazon CloudWatch Logs** — Überwachen, speichern und greifen Sie auf Ihre Protokolldateien aus AWS CloudTrail oder anderen Quellen zu. Weitere Informationen finden Sie unter [Was ist CloudWatch Logs?](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html) im * CloudWatch Amazon-Benutzerhandbuch*.
+ **Amazon EventBridge (früher CloudWatch Events genannt)** — Ordnen Sie Ereignisse zu und leiten Sie sie an eine oder mehrere Zielfunktionen oder Streams weiter, um Änderungen vorzunehmen, Statusinformationen zu erfassen und Korrekturmaßnahmen zu ergreifen. Weitere Informationen finden Sie unter [Was ist Amazon EventBridge?](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-what-is.html) im *EventBridge Benutzerhandbuch*.
+ **AWS CloudTrail Protokollüberwachung** — Teilen Sie Protokolldateien zwischen Konten, überwachen CloudTrail Sie Protokolldateien in Echtzeit, indem Sie sie an CloudWatch Logs senden, schreiben Sie Anwendungen zur Protokollverarbeitung in Java und stellen Sie sicher, dass sich Ihre Protokolldateien nach der Lieferung von nicht geändert haben CloudTrail. Weitere Informationen finden Sie unter [Arbeiten mit CloudTrail Protokolldateien](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-working-with-log-files.html) im *AWS CloudTrail Benutzerhandbuch*.
## Manuelle Überwachungstools
Ein weiterer wichtiger Teil der Überwachung von API Gateway besteht darin, die Elemente, die von den CloudWatch Alarmen nicht abgedeckt werden, manuell zu überwachen. Das API Gateway und andere AWS Konsolen-Dashboards bieten einen at-a-glance Überblick über den Zustand Ihrer AWS Umgebung. CloudWatch Wir empfehlen, auch die Protokolldateien für die API-Ausführung zu überprüfen.
+ Das API Gateway-Dashboard zeigt die folgenden Statistiken für eine bestimmte API-Stufe in einem bestimmten Zeitraum:
+ **API Calls**
+ **Cache Hit**, nur wenn das API-Caching aktiviert ist.
+ **Cache Miss**, nur wenn das API-Caching aktiviert ist.
+ **Latency**
+ **Integration Latency**
+ **4XX Error**
+ **5XX Error**
+ Auf der CloudWatch Startseite wird Folgendes angezeigt:
+ Aktuelle Alarme und Status
+ Diagramme mit Alarmen und Ressourcen
+ Servicestatus
Darüber hinaus können CloudWatch Sie Folgendes verwenden:
+ Erstellen [angepasster Dashboards](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Dashboards.html) zur Überwachung der gewünschten Services.
+ Aufzeichnen von Metrikdaten, um Probleme zu beheben und Trends zu erkennen
+ Suchen und durchsuchen Sie alle Ihre AWS Ressourcenmetriken
+ Erstellen und Bearbeiten von Alarmen, um über Probleme benachrichtigt zu werden
## CloudWatch Alarme zur Überwachung des API Gateway erstellen
Sie können einen CloudWatch Alarm erstellen, der eine Amazon SNS SNS-Nachricht sendet, wenn sich der Status des Alarms ändert. Ein Alarm überwacht eine Metrik über einen bestimmten, von Ihnen definierten Zeitraum und führt eine oder mehrere Aktionen durch, die vom Wert der Metrik im Vergleich zu einem festgelegten Schwellenwert in einer Reihe von Zeiträumen abhängt. Die Aktion ist eine Benachrichtigung, die an ein Amazon SNS-Thema oder eine Auto Scaling-Richtlinie gesendet wird. Bei Alarmen werden nur Aktionen für anhaltende Statusänderungen ausgelöst. CloudWatch Alarme lösen keine Aktionen aus, nur weil sie sich in einem bestimmten Zustand befinden. Der Zustand muss sich geändert haben und für eine bestimmte Anzahl von Zeiträumen beibehalten worden sein.