Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
# Surveillez l'exécution de l'API REST avec CloudWatch les métriques Amazon
Vous pouvez surveiller l'exécution des API en utilisant CloudWatch, qui collecte et traite les données brutes d'API Gateway en near-real-time métriques lisibles. Ces statistiques sont enregistrées pour une durée de 15 mois et, par conséquent, vous pouvez accéder aux informations historiques et acquérir un meilleur point de vue de la façon dont votre service ou application web s’exécute. Par défaut, les données métriques d'API Gateway sont automatiquement envoyées par CloudWatch intervalles d'une minute. Pour plus d'informations, consultez [Qu'est-ce qu'Amazon CloudWatch ?](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html) dans le *guide de CloudWatch l'utilisateur Amazon*.
Les métriques présentées par API Gateway fournissent des informations permettant différents types d’analyse. La liste suivante présente certaines utilisations courantes des métriques qui sont des suggestions pour vous aider à démarrer :
+ Surveillez les métriques **IntegrationLatency** pour mesurer la réactivité du serveur principal.
+ Surveillez les métriques **Latency** pour mesurer la réactivité globale de vos appels d’API.
+ Surveillez les métriques **CacheHitCount** et **CacheMissCount** pour optimiser les capacités de cache afin d'atteindre les performances souhaitées.
**Topics**
+ [Dimensions et métriques Amazon API Gateway](api-gateway-metrics-and-dimensions.md)
+ [Afficher les métriques CloudWatch avec le tableau de bord API dans API Gateway](how-to-api-dashboard.md)
+ [Afficher les métriques d'API Gateway dans la CloudWatch console](metrics_dimensions_view_in_cloud_watch.md)
+ [Afficher les événements du journal d'API Gateway dans la CloudWatch console](view-cloudwatch-log-events-in-cloudwatch-console.md)
+ [Outils de surveillance intégrés AWS à API Gateway](monitoring_automated_manual.md)
# Dimensions et métriques Amazon API Gateway
Les métriques et les dimensions qu'API Gateway envoie à Amazon CloudWatch sont répertoriées ci-dessous. Pour de plus amples informations, veuillez consulter [Surveillez l'exécution de l'API REST avec CloudWatch les métriques Amazon](monitoring-cloudwatch.md).
## Métriques API Gateway
Amazon API Gateway envoie des données métriques à CloudWatch chaque minute.
L’espace de noms `AWS/ApiGateway` inclut les métriques suivantes.
| Métrique | Description |
| --- | --- |
| 4XXError | Nombre d’erreurs côté client capturées dans une période donnée. API Gateway compte les codes d'état de réponse de la passerelle modifiés comme 4 XXError erreurs. La statistique `Sum` représente cette métrique, à savoir le nombre total d'erreurs 4XXError sur la période nommée. La statistique `Average` représente le taux d'erreurs 4XXError, à savoir le nombre total d'erreurs 4XXError divisé par le nombre total de demandes pendant la période. Le dénominateur correspond à la métrique Count (ci-dessous). Unit: Count |
| 5XXError | Nombre d’erreurs côté serveur capturées dans une période donnée. La statistique `Sum` représente cette métrique, à savoir le nombre total d'erreurs 5XXError sur la période nommée. La statistique `Average` représente le taux d'erreurs 5XXError, à savoir le nombre total d'erreurs 5XXError divisé par le nombre total de demandes pendant la période. Le dénominateur correspond à la métrique Count (ci-dessous). Unit: Count |
| CacheHitCount | Le nombre de demandes servies depuis le cache de l’API sur une période donnée. La statistique `Sum` représente cette métrique, à savoir le nombre total d’accès au cache sur la période donnée. La statistique `Average` représente le taux d’accès au cache, à savoir le nombre total d’accès au cache divisé par le nombre total de demandes pendant la période. Le dénominateur correspond à la métrique Count (ci-dessous). Unit: Count |
| CacheMissCount | Nombre de demandes traitées à partir du backend sur une période donnée lorsque la mise en cache des API est activée. La statistique `Sum` représente cette métrique, à savoir le nombre total d’échecs d’accès au cache sur la période nommée. La statistique `Average` représente le taux d’échecs d’accès au cache, à savoir le nombre total d’accès au cache divisé par le nombre total de demandes pendant la période. Le dénominateur correspond à la métrique Count (ci-dessous). Unit: Count |
| Count | Nombre total de demandes d’API sur une période donnée. La statistique `SampleCount` représente cette métrique. Unit: Count |
| IntegrationLatency | Délai entre le moment de la transmission de la demande au backend par API Gateway et celui de la réception de la réponse du backend. Unit: Millisecond |
| Latency | Délai entre le moment de la réception par API Gateway d’une demande d’un client et celui du renvoi de la réponse au client. La latence prend en compte la latence d’intégration et autres surcharges d’API Gateway. Unit: Millisecond |
## Dimensions pour les métriques
Vous pouvez utiliser les dimensions du tableau suivant pour filtrer les métriques API Gateway.
**Note**
API Gateway supprime les caractères non ASCII de la ApiName dimension avant d'envoyer des métriques à. CloudWatch Si l’APIName ne contient aucun caractère ASCII, l’API ID est utilisé comme ApiName.
| Dimension | Description |
| --- | --- |
| ApiName | Filtre les métriques API Gateway à la recherche de l’API REST avec le nom d’API spécifié. |
| ApiName, Method, Resource, Stage | Filtre les métriques API Gateway à la recherche de la méthode d’API avec le nom d’API, l’étape, la ressource et la méthode spécifiés. API Gateway n'enverra pas ces métriques à moins que vous n'ayez explicitement activé CloudWatch les métriques détaillées. Dans la console, choisissez une étape, puis pour **Journaux et suivi**, sélectionnez **Modifier**. Sélectionnez **Métriques détaillées**, puis cliquez sur **Enregistrer les modifications**. Vous pouvez également appeler la AWS CLI commande [update-stage](https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-stage.html) pour mettre à jour la `metricsEnabled` propriété en. `true` L’activation de ces métriques implique des frais supplémentaires pour votre compte. Pour plus d'informations sur les tarifs, consultez [Amazon CloudWatch Pricing](https://aws.amazon.com/cloudwatch/pricing/). |
| ApiName, Stage | Filtre les métriques API Gateway pour trouver la ressource d’étape d’API avec le nom d’API et l’étape spécifiés. |
# Afficher les métriques CloudWatch avec le tableau de bord API dans API Gateway
Vous pouvez utiliser le tableau de bord API de la console API Gateway pour afficher les métriques CloudWatch de votre API déployée dans API Gateway. Celles-ci sont présentées sous forme de récapitulatif de l'activité de l'API au fil du temps.
**Topics**
+ [Prérequis](#how-to-api-dashboard-prerequisites)
+ [Examen des activités de l'API dans le tableau de bord](#how-to-api-dashboard-console)
## Prérequis
1. Vous devez avoir créé une API dans API Gateway. Suivez les instructions de la section [Développez REST APIs dans API Gateway](rest-api-develop.md).
1. Vous devez avoir déployé l'API au moins une fois. Suivez les instructions de la section [Déploiement d’une API REST dans API Gateway](how-to-deploy-api.md).
## Examen des activités de l'API dans le tableau de bord
1. Connectez-vous à la console API Gateway à l'adresse [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).
1. Choisissez une API.
1. Dans le panneau de navigation principal, choisissez **Tableau de bord**.
1. Pour **Étape**, choisissez l'étape souhaitée.
1. Choisissez **Plage de dates** pour spécifier une plage de dates.
1. Actualisez la page, si nécessaire, et affichez les diverses métriques présentées dans des graphiques distincts intitulés **Appels d'API**, **Latence**, **Latence d'intégration**, **Latence**, **Erreur 4xx** et **Erreur 5xx**.
**Astuce**
Pour examiner les métriques CloudWatch au niveau de la méthode, assurez-vous d'avoir activé CloudWatch Logs à ce niveau-là. Pour de plus amples informations sur la configuration de la journalisation au niveau de la méthode, veuillez consulter [Remplacement des paramètres au niveau de l’étape](set-up-stages.md#how-to-method-override).
# Afficher les métriques d'API Gateway dans la CloudWatch console
Les métriques sont d’abord regroupées par espace de noms de service, puis par les différentes combinaisons de dimension au sein de chaque espace de noms. Pour afficher les métriques au niveau de la méthode pour votre API, activez les métriques détaillées. Pour de plus amples informations, veuillez consulter [Modification des paramètres d’étape](set-up-stages.md#how-to-stage-settings).
**Pour afficher les métriques d'API Gateway à l'aide de la CloudWatch console**
1. Ouvrez la CloudWatch console à l'adresse [https://console.aws.amazon.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/).
1. Si nécessaire, changez la Région AWS. Dans la barre de navigation, sélectionnez la région dans laquelle se trouvent vos AWS ressources.
1. Dans le panneau de navigation, sélectionnez **Métriques**.
1. Sous l’onglet **Toutes les métriques**, choisissez **API Gateway**.
1. Pour voir les métriques par étape, choisissez le volet **By Stage**. Sélectionnez ensuite votre nom APIs et le nom de la métrique.
1. Pour voir les métriques par API spécifique, choisissez le volet **By Api Name**. Sélectionnez ensuite votre nom APIs et le nom de la métrique.
**Pour afficher les métriques à l'aide de la AWS CLI**
1. Utilisez la commande [list-metrics](https://docs.aws.amazon.com/cli/latest/reference/cloudwatch/list-metrics.html) suivante pour répertorier les métriques :
```
aws cloudwatch list-metrics --namespace "AWS/ApiGateway"
```
Après avoir créé une métrique, attendez jusqu’à 15 minutes pour qu’elle apparaisse. Pour consulter les statistiques métriques plus rapidement, utilisez [get-metric-data](https://docs.aws.amazon.com/cli/latest/reference/cloudwatch/update-domain-name.html)ou [get-metric-statistics](https://docs.aws.amazon.com/cli/latest/reference/cloudwatch/update-domain-name.html).
1. Utilisez la [get-metrics-statistics](https://docs.aws.amazon.com/cli/latest/reference/cloudwatch/get-metric-statistics.html)commande suivante pour afficher la moyenne sur une période en utilisant des intervalles de 5 minutes :
```
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
```
# Afficher les événements du journal d'API Gateway dans la CloudWatch console
La section suivante explique les prérequis nécessaires et explique comment afficher les événements du journal d'API Gateway dans la CloudWatch console.
## Conditions préalables
1. Vous devez avoir créé une API dans API Gateway. Suivez les instructions de la section [Développez REST APIs dans API Gateway](rest-api-develop.md).
1. Vous devez avoir déployé et invoqué l’API au moins une fois. Suivez les instructions de [Déploiement d’une API REST dans API Gateway](how-to-deploy-api.md) et [Invocation d’une API REST dans API Gateway](how-to-call-api.md).
1. Les CloudWatch journaux doivent être activés pour une étape. Suivez les instructions de la section [Configuration de la CloudWatch journalisation pour REST APIs dans API Gateway](set-up-logging.md).
## Pour afficher les demandes et réponses d'API enregistrées à l'aide de la CloudWatch console
1. Ouvrez la CloudWatch console à l'adresse [https://console.aws.amazon.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/).
1. Si nécessaire, changez la Région AWS. Dans la barre de navigation, sélectionnez la région dans laquelle se trouvent vos AWS ressources. Pour plus d’informations, consultez [Régions et points de terminaison](https://docs.aws.amazon.com/general/latest/gr/rande.html).
1. Dans le panneau de navigation de gauche, choisissez **Logs** (Journaux), **Log groups** (Groupes de journaux).
1. Dans le tableau **Log Groups**, choisissez un groupe de journaux portant le nom **API-Gateway-Execution-Logs\$1** \$1\$1/\$1stage-name\$1. rest-api-id
1. Sous la table **Flux de journaux**, choisissez un flux de journaux. Vous pouvez utiliser l’horodatage pour aider à localiser le flux de journal qui vous intéresse.
1. Choisissez **Texte** pour afficher du texte brut ou choisissez **Row** pour afficher l’événement ligne par ligne.
**Important**
CloudWatch vous permet de supprimer des groupes de journaux ou des flux. Ne supprimez pas manuellement les groupes ou flux de journaux API Gateway ; laissez API Gateway gérer ces ressources. La suppression manuelle de groupes ou de flux de journaux peut entraîner la non journalisation des demandes et réponses d’API. Si tel est le cas, vous pouvez supprimer l’intégralité du groupe de journaux pour l’API et redéployer l’API. La raison en est que l’API Gateway crée des groupes ou flux de journaux pour une étape d’API au moment de son déploiement.
# Outils de surveillance intégrés AWS à 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 que vous spécifiez et effectuez 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. CloudWatch les alarmes n'appellent pas d'actions simplement parce qu'elles sont dans un état particulier ; l'état doit avoir changé et être maintenu pendant un certain nombre de périodes. Pour de plus amples informations, veuillez consulter [Surveillez l'exécution de l'API REST avec CloudWatch les métriques Amazon](monitoring-cloudwatch.md).
+ **Amazon CloudWatch Logs** — Surveillez, stockez et accédez à vos fichiers journaux depuis AWS CloudTrail ou d'autres sources. Pour plus d'informations, voir [Qu'est-ce que CloudWatch les journaux ?](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html) dans le *guide de CloudWatch l'utilisateur Amazon*.
+ **Amazon EventBridge (anciennement CloudWatch Events) : associez** les événements et acheminez-les vers une ou plusieurs fonctions ou flux cibles afin d'apporter des modifications, de capturer des informations d'état et de prendre des mesures correctives. Pour plus d'informations, consultez [Qu'est-ce qu'Amazon EventBridge ?](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-what-is.html) dans le *guide de EventBridge l'utilisateur*.
+ **AWS CloudTrail Surveillance des journaux** : partagez les fichiers journaux entre les comptes, surveillez les fichiers CloudTrail CloudWatch journaux en temps réel en les envoyant à Logs, écrivez des applications de traitement des journaux en Java et vérifiez que vos fichiers journaux n'ont pas changé après leur livraison par CloudTrail. Pour plus d'informations, consultez la section [Utilisation des fichiers CloudTrail journaux](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-working-with-log-files.html) dans le *guide de AWS CloudTrail l'utilisateur*.
## Outils de surveillance manuelle
Un autre élément important de la surveillance d'API Gateway consiste à surveiller manuellement les éléments non couverts par les CloudWatch alarmes. L'API Gateway et CloudWatch les autres tableaux de bord de AWS console fournissent une at-a-glance vue de l'état de votre AWS environnement. 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' CloudWatch accueil indique :
+ Alarmes et statuts en cours
+ Graphiques des alarmes et des ressources
+ Statut d’intégrité du service
En outre, vous pouvez CloudWatch effectuer les opérations suivantes :
+ Créer des [tableaux de bord personnalisés](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Dashboards.html) 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
+ Recherchez et parcourez tous les indicateurs de vos AWS ressources
+ Créer et modifier des alarmes pour être informé des problèmes
## Création d' CloudWatch alarmes pour surveiller API Gateway
Vous pouvez créer une CloudWatch alarme 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 déclenchent des actions uniquement pour les changements d'état prolongés. CloudWatch les alarmes n'appellent pas d'actions simplement parce qu'elles sont dans un état particulier ; l'état doit avoir changé et être maintenu pendant un certain nombre de périodes.