Surveillance des outils dans AWS pour API Gateway
AWS fournit différents outils que vous pouvez utiliser pour surveiller API Gateway. Vous pouvez configurer certains de ces outils pour qu’ils effectuent la surveillance automatiquement, tandis que d’autres nécessitent une intervention manuelle. Nous vous recommandons d’automatiser le plus possible les tâches de supervision.
Outils de surveillance automatisés dans AWS
Vous pouvez utiliser les outils de surveillance automatique pour surveiller API Gateway et signaler un problème éventuel :
Amazon CloudWatch Alarms : surveillez une seule métrique sur une période définie et exécutez une ou plusieurs actions en fonction de la valeur de la métrique par rapport à un seuil donné sur un certain nombre de périodes. L’action est une notification envoyée à une rubrique Amazon Simple Notification Service (Amazon SNS) ou une politique Amazon EC2 Auto Scaling. Les alarmes CloudWatch n’appellent pas d’actions simplement parce qu’elles sont dans un état particulier : l’état doit avoir changé et été maintenu pendant un certain nombre de périodes. Pour de plus amples informations, veuillez consulter Surveillance de l’exécution d’une API REST à l’aide des métriques Amazon CloudWatch.
Amazon CloudWatch Logs – Surveillez, stockez et accédez à vos fichiers journaux à partir de AWS CloudTrail ou d’autres sources. Pour plus d’informations, consultez What is CloudWatch Logs? dans le Guide de l’utilisateur Amazon CloudWatch.
Amazon EventBridge (anciennement CloudWatch Events) – Mettez en correspondance les événements et transmettez-les à un ou plusieurs flux ou fonctions cibles pour apporter des modifications, récupérer des informations d’état et prendre des mesures correctives. Pour plus d’informations, consultez What Is Amazon EventBridge? dans le Guide de l’utilisateur EventBridge.
Surveillance de journauxAWS CloudTrail – Partagez les fichiers journaux entre comptes, surveillez les fichiers journaux CloudTrail en temps réel en les envoyant à CloudWatch Logs, écrivez des applications de traitement de journaux en langage Java et assurez-vous que vos fichiers journaux n’ont pas changé après leur livraison par CloudTrail. Pour en savoir plus, consultez Utilisation des fichiers journaux CloudTrail dans le Guide de l’utilisateur AWS CloudTrail.
Outils de surveillance manuelle
La surveillance d’API Gateway implique également de surveiller manuellement les éléments que les alarmes CloudWatch ne couvrent pas. Les tableaux de bord de consoles API Gateway, CloudWatch et d’autres tableaux de bord de console AWS fournissent un aperçu de l’état de votre environnement AWS. Nous recommandons de consulter également les fichiers journaux sur l’exécution des API.
-
Le tableau de bord API Gateway présente les statistiques suivantes pour une étape d’API donnée sur une durée définie :
-
Appels d’API
-
Accès au cache, uniquement lorsque la mise en cache des API est activée.
-
Échec de cache, uniquement lorsque la mise en cache des API est activée.
-
Latence
-
Latence d’intégration
-
Erreur 4XX
-
Erreur 5XX
-
-
La page d’accueil de CloudWatch affiche :
-
Alarmes et statuts en cours
-
Graphiques des alarmes et des ressources
-
Statut d’intégrité du service
De plus, vous pouvez utiliser CloudWatch pour effectuer les tâches suivantes :
-
Créer des tableaux de bord personnalisés pour surveiller les services de votre choix
-
Représenter graphiquement les données de métriques pour résoudre les problèmes et découvrir les tendances
-
Rechercher et parcourir toutes vos métriques de ressources AWS
-
Créer et modifier des alarmes pour être informé des problèmes
-
Création d’alarmes CloudWatch pour la surveillance d’API Gateway
Vous pouvez créer une alarme CloudWatch qui envoie un message Amazon SNS lorsque l’alarme change d’état. Une alarme surveille une seule métrique pendant une durée que vous définissez et exécute une ou plusieurs actions en fonction de la valeur de la métrique par rapport à un seuil donné pendant un certain nombre de périodes. L’action est une notification envoyée à une rubrique Amazon SNS ou à une politique Auto Scaling. Les alarmes appellent les actions pour les changements d’état soutenus uniquement. Les alarmes CloudWatch n’appellent pas d’actions simplement parce qu’elles sont dans un état particulier : l’état doit avoir changé et été maintenu pendant un certain nombre de périodes.
