Dimensions et métriques Amazon API Gateway - Amazon API Gateway

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.

Dimensions et métriques Amazon API Gateway

Les métriques et dimensions envoyées par API Gateway à Amazon CloudWatch sont répertoriées ci-dessous. Pour de plus amples informations, veuillez consulter Surveillance de l’exécution d’une API REST à l’aide des métriques Amazon CloudWatch.

Métriques API Gateway

Amazon API Gateway envoie les données des métriques à CloudWatch toutes les minutes.

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 de statut modifiés des réponses de passerelle 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 dimension ApiName avant d’envoyer les 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'envoie pas ces métriques à moins que vous n'ayez explicitement activé les métriques CloudWatch 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. Sinon, vous pouvez appeler la commande update-stage de l’AWS CLI pour mettre à jour la propriété metricsEnabled sur true.

L’activation de ces métriques implique des frais supplémentaires pour votre compte. Pour de plus amples informations, veuillez consulter Tarification Amazon CloudWatch.

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.