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.

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 considère les codes d'état de réponse de la passerelle modifiés comme des erreurs 4XXError. 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 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.
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.